v2.ads.get_gms_campaign_performance
POST/api/v2/ads/get_gms_campaign_performanceGọi qua 360: POST https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_gms_campaign_performance
Mô tả API
Hiệu quả TỔNG của chiến dịch GMS (quảng cáo tối ưu doanh thu toàn shop, tương tự GMV Max) trong một khoảng ngày: chi phí, doanh thu, đơn, ROAS, lượt hiển thị / nhấp, tỷ lệ chuyển đổi.
- Gọi bằng POST, body JSON. Ngày dạng DD-MM-YYYY (không phải Unix).
cpc/cpdclà chi phí mỗi ĐƠN (không phải mỗi nhấp) và bị nhân 100.000 — nên tự tính lạiexpense ÷ broad_orderthay vì dùng thẳng.- Shopee Ads giới hạn số lần gọi khá chặt (
ads_rate_limit_total_api) — giãn các lần gọi, không gọi dồn nhiều API Ads cùng lúc.
Request
Địa chỉ
POST https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_gms_campaign_performance
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ả |
|---|---|---|---|---|---|
| start_date | body | string | Có | 01-10-2026 | Từ ngày, dạng DD-MM-YYYY. Sớm nhất 6 tháng trước. |
| end_date | body | string | Có | 28-10-2026 | Đến ngày, DD-MM-YYYY — cách start_date tối đa 3 tháng. |
| campaign_id | body | int | Không | 10000000109 | Mã chiến dịch GMS; bỏ trống = chiến dịch GMS của shop. |
Ví dụ request
curl -s -X POST "https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_gms_campaign_performance" \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{"start_date":"01-10-2026","end_date":"28-10-2026"}'
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.post(
"https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_gms_campaign_performance",
params={},
json={
"start_date": "01-10-2026",
"end_date": "28-10-2026"
},
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_gms_campaign_performance');
for (const [k, v] of Object.entries({})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
method: 'POST',
headers: { Authorization: `Bearer ${KEY}`, 'Content-Type': 'application/json' },
body: JSON.stringify({"start_date":"01-10-2026","end_date":"28-10-2026"}),
});
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_gms_campaign_performance' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key, 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"start_date":"01-10-2026","end_date":"28-10-2026"}');
$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)
| 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; rỗng = không có. | |
| response | object | ||
| campaign_id | int | 10000000109 | Mã chiến dịch GMS. |
| report | object | Số liệu cả kỳ (VND). "Gián tiếp" = mọi sản phẩm của shop được mua trong 7 ngày sau khi nhấp quảng cáo; "trực tiếp" = đúng sản phẩm được quảng cáo. | |
| expense | float | 1500000 | Chi phí quảng cáo. |
| impression | int | 484418 | Lượt hiển thị. |
| clicks | int | 16558 | Lượt nhấp (đã lọc nhấp lặp). |
| broad_gmv | float | 1510000 | Doanh thu gián tiếp. |
| broad_order | int | 589 | Đơn gián tiếp. |
| broad_order_amount | int | 631 | Số sản phẩm bán (gián tiếp). |
| broad_roi | float | 6.86 | ROAS = broad_gmv ÷ expense. |
| broad_cir | float | 0.15 | ACOS = expense ÷ broad_gmv. |
| cr | float | 0.04 | Tỷ lệ chuyển đổi = broad_order ÷ clicks. |
| direct_order | int | 507 | Đơn trực tiếp. |
| direct_order_amount | int | 544 | |
| direct_roi | float | 5.99 | ROAS trực tiếp. |
| direct_cir | float | 0.17 | ACOS trực tiếp. |
| direct_cr | float | 0.03 | |
| cpc | float | 1520000.86 | Chi phí MỖI ĐƠN (gián tiếp) — Shopee trả NHÂN 100.000: chia 100.000 ra VND (31.646đ = 18.639.473 ÷ 589). |
| cpdc | float | 1530000.66 | Chi phí mỗi đơn trực tiếp — cũng nhân 100.000 (36.764đ). |
Mẫu phản hồi
{
"error": "",
"message": "",
"warning": "",
"request_id": "e3e3e7f35ef34fa8…",
"response": {
"campaign_id": 10000000109,
"report": {
"expense": 1500000,
"impression": 484418,
"clicks": 16558,
"broad_gmv": 1510000,
"broad_order": 589,
"broad_order_amount": 631,
"broad_roi": 6.86,
"broad_cir": 0.15,
"cr": 0.04,
"direct_order": 507,
"direct_order_amount": 544,
"direct_roi": 5.99,
"direct_cir": 0.17,
"direct_cr": 0.03,
"cpc": 1520000.86,
"cpdc": 1530000.66
}
}
}
Mã lỗi của Shopee Ads (23)
Bấm để xem
| Mã | Ý nghĩa |
|---|---|
| ads_error_not_whitelisted_for_product_gms | Gian hàng chưa được cho phép sử dụng GMS sản phẩm. |
| error_param | Tham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào. |
| ads_error_product_gms_campaign_not_found | Không tìm thấy chiến dịch GMS sản phẩm. |
| error_server | Lỗi hệ thống Shopee — thử lại sau ít phút. |
| ads.ads_account.invalid_status | Trạng thái tài khoản quảng cáo không hợp lệ. |
| ads_invalid_roas_target | ROAS mục tiêu phải lớn hơn hoặc bằng 0. |
| ads.campaign.invalid_start_date | Chiến dịch không có ngày kết thúc phải bắt đầu từ hôm nay. |
| ads.performance.error_date_in_future | Ngày phải là hôm nay hoặc trong 6 tháng trước, không được ở tương lai. |
| ads.performance.error_date_range_too_long | Khoảng ngày không được dài hơn 1 tháng. |
| ads.performance.error_date_too_old | Ngày không được trước quá 6 tháng. |
| ads.performance.error_same_start_end_dates | Ngày bắt đầu không được bằng ngày kết thúc; lấy một ngày bằng API hiệu quả theo giờ. |
| ads.performance.error_start_later_than_end | Ngày bắt đầu không được sau ngày kết thúc. |
| ads.rate_limit.campaign_level | Chiến dịch có quá nhiều yêu cầu; thử lại sau. |
| ads.rate_limit.exceed_partner_api | Quá nhiều yêu cầu; giảm tần suất rồi thử lại sau. |
| ads.rate_limit.exceed_shop_api | Gian hàng có quá nhiều yêu cầu; thử lại sau. |
| ads.rate_limit.exceed_api | Quá nhiều yêu cầu; thử lại sau. |
| ads.shop.in_holiday_mode | Gian hàng đang ở chế độ nghỉ. |
| ads.shop.status_not_normal | Trạng thái gian hàng không bình thường. |
| 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