v2.ams.get_targeted_campaign_list
GET/api/v2/ams/get_targeted_campaign_listGọi qua 360: GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_targeted_campaign_list
Mô tả API
Danh sách chiến dịch riêng (Targeted Campaign) gian hàng đã tạo cho affiliate chọn lọc: tên, trạng thái, thời gian, số affiliate / sản phẩm, khoảng tỷ lệ hoa hồng. Dùng theo dõi các chiến dịch đặt riêng với KOC.
- page_size quá lớn (vd 200) →
error_param"invalid page_size". - Gồm cả chiến dịch đã kết thúc; lọc campaign_status=Ongoing để xem đang chạy (không có → campaign_list rỗng).
Request
Địa chỉ
GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_targeted_campaign_list
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ả |
|---|---|---|---|---|---|
| page_no | query | int | Có | 1 | Trang, từ 1. |
| page_size | query | int | Có | 50 | Số chiến dịch mỗi trang (đã chạy với 100; 200 bị từ chối). |
| campaign_status | query | string | Không | Ongoing | Upcoming · Ongoing · Ended · Cancelled · Draft · Terminating · Terminated · Paused. |
| campaign_id_list | query | string | Không | 10000000012,10000000057 | Mã chiến dịch cách nhau dấu phẩy, tối đa 50. |
| campaign_name | query | string | Không | 20.11 | Tìm theo tên. |
| period_start_time | query | timestamp | Không | 1763571600 | Lọc theo thời gian bắt đầu. |
| period_end_time | query | timestamp | Không | 32503651199 | Lọc theo thời gian kết thúc. |
| item_id | query | int | Không | 10000000058 | Chiến dịch có chứa sản phẩm này. |
| item_name | query | string | Không | Đầm | Chiến dịch có sản phẩm tên này. |
Phân trang
Tăng page_no tới khi đã đủ response.total_count (phản hồi không có has_more).
Ví dụ request
curl -s "https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_targeted_campaign_list?page_no=1&page_size=50" \ -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_list",
params={
"page_no": 1,
"page_size": 50
},
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_list');
for (const [k, v] of Object.entries({"page_no":1,"page_size":50})) 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_list' . '?' . http_build_query(['page_no' => 1, 'page_size' => 50]); $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 khớp. |
| campaign_list | object[] | ||
| campaign_id | int | 10000000012 | Mã chiến dịch. |
| campaign_name | string | Chiến dịch mẫu A | Tên. |
| campaign_status | string | Ended | Upcoming · Ongoing · Ended · Cancelled · Draft · Terminating · Terminated · Paused. |
| campaign_source | string | Seller | `Seller` (shop tạo) · `ShopeeManaged` (Shopee quản lý — không xem / sửa chi tiết được, báo invalid campaign_id) · `Unknown`. |
| period_start_time | timestamp | 1763571600 | Bắt đầu. |
| period_end_time | timestamp | 1764262799 | Kết thúc; 32503651199 = không thời hạn. |
| last_editor | string | tai-khoan-mau | Tài khoản sửa gần nhất. |
| last_edit_time | timestamp | 1763020754 | Lần sửa gần nhất. |
| affiliate_count | int | 1 | Số affiliate trong chiến dịch. |
| item_count | int | 8 | Số sản phẩm. |
| min_rate | float | 10 | Tỷ lệ hoa hồng thấp nhất (%). |
| max_rate | float | 10 | Tỷ lệ hoa hồng cao nhất (%). |
Mẫu phản hồi
{
"request_id": "e3e3e7f35ef6d3ae…",
"error": "",
"message": "",
"response": {
"total_count": 14,
"campaign_list": [
{
"campaign_id": 10000000012,
"campaign_name": "Chiến dịch mẫu A",
"period_start_time": 1763571600,
"period_end_time": 1764262799,
"campaign_status": "Ended",
"last_editor": "tai-khoan-mau",
"last_edit_time": 1763020754,
"affiliate_count": 1,
"item_count": 8,
"min_rate": 10,
"max_rate": 10,
"campaign_source": "Seller"
},
{
"campaign_id": 10000000057,
"campaign_name": "Chiến dịch mẫu B",
"period_start_time": 1763312400,
"period_end_time": 1763917259,
"campaign_status": "Ended",
"last_editor": "tai-khoan-mau",
"last_edit_time": 1763019731,
"affiliate_count": 1,
"item_count": 8,
"min_rate": 10,
"max_rate": 10,
"campaign_source": "Seller"
}
]
}
}
Mã lỗi của Shopee AMS (8)
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_business | Không thể thực hiện nghiệp vụ Affiliate; kiểm message để biết điều kiện hoặc cài đặt cần xử lý. |
| 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