VI | EN
Nhắn Messenger
Dành cho developer

Lấy hiệu quả chiến dịch GMS (GMV Max) của shop — API Shopee Ads

v2.ads.get_gms_campaign_performance · gọi qua Quantri360 bằng một API key cho chính tài khoản / tài sản bạn đã kết nối và ủy quyền — 360 lo việc ký request và làm mới phiên đăng nhập bạn đã cấp.

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 / cpdc là 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ại expense ÷ broad_order thay 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ênVị tríKiểuMẫuMô tả
AuthorizationheaderheaderBearer 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_idquerystring100001Gian 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ênVị tríKiểuBắt buộcMẫuMô tả
start_datebodystringCó01-10-2026Từ ngày, dạng DD-MM-YYYY. Sớm nhất 6 tháng trước.
end_datebodystringCó28-10-2026Đến ngày, DD-MM-YYYY — cách start_date tối đa 3 tháng.
campaign_idbodyintKhông10000000109Mã 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ênKiểuMẫuMô tả
request_idstringd52ca43b277a4f9292fb8be658bfd33dMã request của Shopee để tra lỗi.
errorstringMã lỗi Shopee; rỗng = thành công.
messagestringMô tả lỗi.
warningstringCảnh báo; rỗng = không có.
responseobject
campaign_idint10000000109Mã chiến dịch GMS.
reportobjectSố 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.
expensefloat1500000Chi phí quảng cáo.
impressionint484418Lượt hiển thị.
clicksint16558Lượt nhấp (đã lọc nhấp lặp).
broad_gmvfloat1510000Doanh thu gián tiếp.
broad_orderint589Đơn gián tiếp.
broad_order_amountint631Số sản phẩm bán (gián tiếp).
broad_roifloat6.86ROAS = broad_gmv ÷ expense.
broad_cirfloat0.15ACOS = expense ÷ broad_gmv.
crfloat0.04Tỷ lệ chuyển đổi = broad_order ÷ clicks.
direct_orderint507Đơn trực tiếp.
direct_order_amountint544
direct_roifloat5.99ROAS trực tiếp.
direct_cirfloat0.17ACOS trực tiếp.
direct_crfloat0.03
cpcfloat1520000.86Chi 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).
cpdcfloat1530000.66Chi 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_gmsGian hàng chưa được cho phép sử dụng GMS sản phẩm.
error_paramTham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào.
ads_error_product_gms_campaign_not_foundKhông tìm thấy chiến dịch GMS sản phẩm.
error_serverLỗi hệ thống Shopee — thử lại sau ít phút.
ads.ads_account.invalid_statusTrạng thái tài khoản quảng cáo không hợp lệ.
ads_invalid_roas_targetROAS mục tiêu phải lớn hơn hoặc bằng 0.
ads.campaign.invalid_start_dateChiế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_futureNgà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_longKhoảng ngày không được dài hơn 1 tháng.
ads.performance.error_date_too_oldNgày không được trước quá 6 tháng.
ads.performance.error_same_start_end_datesNgà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_endNgày bắt đầu không được sau ngày kết thúc.
ads.rate_limit.campaign_levelChiến dịch có quá nhiều yêu cầu; thử lại sau.
ads.rate_limit.exceed_partner_apiQuá nhiều yêu cầu; giảm tần suất rồi thử lại sau.
ads.rate_limit.exceed_shop_apiGian hàng có quá nhiều yêu cầu; thử lại sau.
ads.rate_limit.exceed_apiQuá nhiều yêu cầu; thử lại sau.
ads.shop.in_holiday_modeGian hàng đang ở chế độ nghỉ.
ads.shop.status_not_normalTrạ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_limitChạ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_limitGọ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_bannedGian hàng đang bị Shopee khóa — mọi API tạm ngưng tới khi gỡ khóa.
error_kyc_authGian 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

  1. Đăng ký tài khoản Partner
  2. Mở loại dữ liệu thuộc nhóm Quảng cáo (Ads) ở trang nền tảng
  3. Tạo API key (tick kênh Shopee Ads)
  4. Gọi theo ví dụ ở trên