v2.ads.get_product_recommended_roi_target
GET/api/v2/ads/get_product_recommended_roi_targetGọi qua 360: GET https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_product_recommended_roi_target
Mô tả API
Lấy các mức ROI mục tiêu gợi ý và mức cạnh tranh tương ứng cho sản phẩm.
- Gọi qua /v1/shopee_ads/api/v2/ads/get_product_recommended_roi_target với Authorization: Bearer <key>; dùng platform_shop_id khi có nhiều shop. 360 tự gắn partner_id, shop_id, sign và access_token.
- API chỉ đọc; error rỗng mới là thành công. HTTP 200 vẫn có thể chứa lỗi nghiệp vụ trong error/message.
Request
Địa chỉ
GET https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_product_recommended_roi_target
Xác thực & gian hàng
| Tên | Vị trí | Kiểu | Mẫu | Mô tả |
|---|---|---|---|---|
| Authorization | header | header | Bearer q360_live_ab12cd34_… | Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand. |
| platform_shop_id | query | string | 100001 | Gian hàng (lấy ở GET /v1/platforms → shops[].platform_shop_id). BẮT BUỘC khi brand có > 1 gian hàng trên nền tảng; 360 bỏ tham số này trước khi chuyển tiếp. |
Tham số request
| Tên | Vị trí | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|---|
| reference_id | query | string | Có | demo-unique-ad-001 | Chuỗi ngẫu nhiên để chống tạo trùng quảng cáo. Sau khi tạo thành công, gửi lại cùng chuỗi sẽ thất bại; tạo chuỗi mới cho lần tạo mới. Dùng cùng chuỗi khi lấy gợi ý trước bước tạo quảng cáo. |
| item_id | query | int64 | Có | 100001 | Mã sản phẩm. |
Ví dụ request
curl -s "https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_product_recommended_roi_target?reference_id=demo-unique-ad-001&item_id=100001" \ -H "Authorization: Bearer $KEY"
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.get(
"https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_product_recommended_roi_target",
params={
"reference_id": "demo-unique-ad-001",
"item_id": 100001
},
headers={"Authorization": f"Bearer {KEY}"},
timeout=60,
)
print(r.status_code)
print(r.json())Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_product_recommended_roi_target');
for (const [k, v] of Object.entries({"reference_id":"demo-unique-ad-001","item_id":100001})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
method: 'GET',
headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());PHP
<?php $key = 'q360_live_...'; // khóa API của brand $url = 'https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_product_recommended_roi_target' . '?' . http_build_query(['reference_id' => 'demo-unique-ad-001', 'item_id' => 100001]); $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]); $res = curl_exec($ch); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); echo $status, "\n", $res;
Response
Tham số phản hồi (nguyên của Shopee Ads)
Đọc error/message trước khi dùng response; responseSample là dữ liệu minh họa thành công và giữ cây trường phản hồi.
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| request_id | string | d52ca43b277a4f9292fb8be658bfd33d | Mã request của Shopee để tra lỗi. |
| error | string | Mã lỗi Shopee; rỗng = thành công. | |
| message | string | Mô tả lỗi. | |
| warning | string | Cảnh báo khi một phần dữ liệu không trả về bình thường. | |
| response | object | Kết quả nghiệp vụ. | |
| lower_bound | object | Gợi ý ROI thấp; value=3,5 và percentile=80 nghĩa là cạnh tranh hơn 80% quảng cáo tương tự. | |
| value | float | 1.5 | Giá trị ROI mục tiêu. |
| percentile | int32 | 10 | Mức cạnh tranh so với quảng cáo tương tự, tính theo phần trăm. |
| exact | object | Gợi ý ROI trung bình; value=5,9 và percentile=50 nghĩa là cạnh tranh hơn 50% quảng cáo tương tự. | |
| value | float | 1.5 | Giá trị ROI mục tiêu. |
| percentile | int32 | 10 | Mức cạnh tranh so với quảng cáo tương tự, tính theo phần trăm. |
| upper_bound | object | Gợi ý ROI cao; value=10,8 và percentile=20 nghĩa là cạnh tranh hơn 20% quảng cáo tương tự. | |
| value | float | 1.5 | Giá trị ROI mục tiêu. |
| percentile | int32 | 10 | Mức cạnh tranh so với quảng cáo tương tự, tính theo phần trăm. |
Mẫu phản hồi
{
"error": "",
"message": "",
"warning": "",
"request_id": "demo-request",
"response": {
"lower_bound": {
"value": 1.5,
"percentile": 10
},
"exact": {
"value": 1.5,
"percentile": 10
},
"upper_bound": {
"value": 1.5,
"percentile": 10
}
}
}
Mã lỗi của Shopee Ads (9)
Bấm để xem
| Mã | Ý nghĩa |
|---|---|
| error_data | Dữ liệu không tồn tại hoặc không hợp lệ cho thao tác (vd mã không có, loại yêu cầu không cho phép). |
| error_param | Tham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào. |
| error_server | Lỗi hệ thống Shopee — thử lại sau ít phút. |
| error_shop | Gian hàng không hợp lệ — kiểm tra platform_shop_id. |
| error_auth | Ủy quyền gian hàng cho 360 đã hết hạn hoặc bị thu hồi (360 đã tự làm mới token một lần) — chủ gian hàng kết nối lại Shopee trong Partner. |
| error_limit | Chạm hạn mức gọi Shopee trong ngày của kết nối — 360 trả kèm thời điểm thử lại; giảm tần suất gọi. |
| error_rate_limit | Gọi quá nhanh — chờ vài giây rồi gọi lại (360 cũng giới hạn theo key: 429 + Retry-After). |
| shop_banned | Gian hàng đang bị Shopee khóa — mọi API tạm ngưng tới khi gỡ khóa. |
| error_kyc_auth | Gian hàng chưa hoàn tất đăng ký người bán trên Kênh Người Bán. |
Bắt đầu dùng
- Đăng ký tài khoản Partner
- Mở loại dữ liệu thuộc nhóm Quảng cáo (Ads) ở trang nền tảng
- Tạo API key (tick kênh Shopee Ads)
- Gọi theo ví dụ ở trên