Hiệu quả chiến dịch riêng (KOC chỉ định) — API Shopee AMS

v2.ams.get_targeted_campaign_performance

GET/api/v2/ams/get_targeted_campaign_performanceGọi qua 360: GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_targeted_campaign_performance

Mô tả API

Hiệu quả TỪNG Chiến dịch riêng (Targeted Campaign) theo kỳ: số affiliate ra đơn, doanh thu, số bán, hoa hồng ước tính. Dùng đánh giá các chiến dịch đặt riêng với KOC.

Trả MỌI chiến dịch riêng của shop (kể cả đã kết thúc) — chiến dịch không có đơn trong kỳ vẫn có dòng với số 0.
Chỉ xem được 3 tháng gần nhất nên chiến dịch cũ thường toàn số 0.

Request

Địa chỉ

GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_targeted_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ả
period_type	query	string	Có	Month	`Day` · `Week` · `Month` · `Last7d` · `Last30d` — quy tắc ngày như get_shop_performance.
start_date	query	string	Có	20260801	YYYYMMDD.
end_date	query	string	Có	20260831	YYYYMMDD.
page_no	query	int	Có	1	Trang, từ 1.
page_size	query	int	Có	20	Tối đa 20.
campaign_id	query	int	Không	139052	Chỉ xem một chiến dịch (mã từ get_targeted_campaign_list).

Phân trang

Tăng page_no khi response.has_more = true.

Ví dụ request

curl -s "https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_targeted_campaign_performance?period_type=Last30d&start_date=20260929&end_date=20261028&page_no=1&page_size=20" \
  -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_ams/api/v2/ams/get_targeted_campaign_performance",
    params={
        "period_type": "Last30d",
        "start_date": "20260929",
        "end_date": "20261028",
        "page_no": 1,
        "page_size": 20
    },
    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_ams/api/v2/ams/get_targeted_campaign_performance');
for (const [k, v] of Object.entries({"period_type":"Last30d","start_date":"20260929","end_date":"20261028","page_no":1,"page_size":20})) 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_ams/api/v2/ams/get_targeted_campaign_performance' . '?' . http_build_query(['period_type' => 'Last30d', 'start_date' => '20260929', 'end_date' => '20261028', 'page_no' => 1, 'page_size' => 20]);
$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 AMS)

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.
response	object
total_count	int	14	Tổng chiến dịch.
has_more	bool	true	Còn trang sau.
list	object[]
campaign_id	int	10000000012	Mã chiến dịch.
campaign_name	string	Chiến dịch mẫu A	Tên.
affiliates	int	0	Số affiliate có đơn trong kỳ.
sales	string	0	Doanh thu (VND, chuỗi).
item_sold	int	0	Số bán.
est_commission	string	0	Hoa hồng ước tính (VND, chuỗi).
fetched_date_range	string	20260801-20260831	Khoảng ngày thực tính.

Mẫu phản hồi

{
  "error": "",
  "message": "",
  "request_id": "e3e3e7f35ef7a4a8…",
  "response": {
    "has_more": true,
    "list": [
      {
        "campaign_id": 10000000012,
        "campaign_name": "Chiến dịch mẫu A",
        "affiliates": 0,
        "sales": "0",
        "item_sold": 0,
        "est_commission": "0"
      },
      {
        "campaign_id": 139052,
        "campaign_name": "Xuanhe2023",
        "affiliates": 0,
        "sales": "0",
        "item_sold": 0,
        "est_commission": "0"
      }
    ],
    "fetched_date_range": "20260801-20260831",
    "total_count": 14
  }
}

Mã lỗi của Shopee AMS (7)

Bấm để xem

Mã	Ý nghĩa
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_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 Affiliate ở trang nền tảng
Tạo API key (tick kênh Shopee AMS)
Gọi theo ví dụ ở trên