v2.ads.edit_gms_product_campaign
POST/api/v2/ads/edit_gms_product_campaignGọi qua 360: POST https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/edit_gms_product_campaign
Endpoint ghi — thay đổi dữ liệu trên Shopee Ads. Key phải được tạo với tick "Cho phép gọi API ghi", nếu không sẽ nhận 403 write_not_allowed. Mỗi lần gọi được ghi nhật ký.
Mô tả API
Chỉnh sửa ngân sách, thời gian, trạng thái hoặc ROAS mục tiêu của chiến dịch GMS.
- Gọi qua /v1/shopee_ads/api/v2/ads/edit_gms_product_campaign 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 GHI: thay đổi dữ liệu thật trên Shopee; cần key có quyền ghi (can_write) và gói mở module Quảng cáo. Có thể chi tiền quảng cáo và thay đổi ngân sách, thời gian hoặc trạng thái chiến dịch.
- HTTP 200 vẫn có thể có lỗi nghiệp vụ; kiểm error trước khi dùng kết quả.
Request
Địa chỉ
POST https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/edit_gms_product_campaign
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ả |
|---|---|---|---|---|---|
| campaign_id | body | int64 | Không | 200001 | Mã chiến dịch. Gửi nếu đã có mã chiến dịch GMS. |
| edit_action | body | string | Có | pause | Thao tác: change_budget (cần daily_budget), change_duration (cần start_date), end_date, pause, resume, start, change_roas_target (cần roas_target). |
| daily_budget | body | float | Không | 100 | Ngân sách mỗi ngày của chiến dịch. Bắt buộc với change_budget. |
| start_date | body | string | Không | 01-10-2026 | Ngày bắt đầu, dạng DD-MM-YYYY. Không được trước ngày hiện tại; bắt buộc với change_duration. |
| end_date | body | string | Không | 07-10-2026 | Ngày kết thúc, dạng DD-MM-YYYY; bỏ trống nếu chiến dịch không giới hạn thời gian. |
| roas_target | body | float | Không | 1.5 | ROAS mục tiêu khi đấu thầu tự động. Bỏ trống hoặc 0: GMV Max Auto Bidding (Shop); lớn hơn 0: GMV Max Custom ROAS (Shop); cắt xuống một chữ số thập phân, ví dụ 10,199999 thành 10,1. Bắt buộc với change_roas_target. |
| reference_id | body | string | Không | 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. |
Ví dụ request
curl -s -X POST "https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/edit_gms_product_campaign" \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{"edit_action":"pause"}'
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/edit_gms_product_campaign",
params={},
json={
"edit_action": "pause"
},
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/edit_gms_product_campaign');
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({"edit_action":"pause"}),
});
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/edit_gms_product_campaign' . '?' . 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, '{"edit_action":"pause"}');
$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. Danh sách edit_action trình bày end_date thành mục riêng; giữ tên này và dùng các trường ngày tương ứng, không ghép tên trường vào tên thao tác.
| 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ụ. | |
| campaign_id | int64 | 200001 | Mã chiến dịch. |
Mẫu phản hồi
{
"error": "",
"message": "",
"warning": "",
"request_id": "demo-request",
"response": {
"campaign_id": 200001
}
}
Mã lỗi của Shopee Ads (17)
Bấm để xem
| Mã | Ý nghĩa |
|---|---|
| ads.campaign.error_daily_budget_range | Ngân sách được thiết lập không hợp lệ. |
| 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. |
| 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.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.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