v2.ads.get_recommended_keyword_list
GET/api/v2/ads/get_recommended_keyword_listGọi qua 360: GET https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_recommended_keyword_list
Mô tả API
Lấy danh sách từ khóa quảng cáo gợi ý, điểm chất lượng, lượng tìm kiếm và giá thầu.
- Gọi qua /v1/shopee_ads/api/v2/ads/get_recommended_keyword_list 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 chỉ đọc; error rỗng mới là thành công. HTTP 200 vẫn có thể chứa lỗi nghiệp vụ trong error/message.
Request
Địa chỉ
GET https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_recommended_keyword_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ả |
|---|---|---|---|---|---|
| item_id | query | int64 | Có | 100001 | Mã sản phẩm. |
| input_keyword | query | string | Không | áo | Từ khóa người bán nhập khi thêm từ khóa thủ công. |
Ví dụ request
curl -s "https://partner.quantri360.com/v1/shopee_ads/api/v2/ads/get_recommended_keyword_list?item_id=100001" \ -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_ads/api/v2/ads/get_recommended_keyword_list",
params={
"item_id": 100001
},
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_recommended_keyword_list');
for (const [k, v] of Object.entries({"item_id":100001})) 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_ads/api/v2/ads/get_recommended_keyword_list' . '?' . http_build_query(['item_id' => 100001]); $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 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.
| 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ụ. | |
| item_id | int64 | 100001 | Mã sản phẩm. |
| input_keyword | string | áo | Từ khóa người bán nhập khi thêm từ khóa thủ công. |
| suggested_keyword_list | object[] | Các từ khóa được gợi ý từ sản phẩm. | |
| keyword | string | áo cotton | Từ khóa đấu thầu; danh sách gợi ý chỉ trả từ khóa được khuyến nghị cao. |
| quality_score | int32 | 10 | Điểm hấp dẫn và liên quan của quảng cáo với từ khóa; điểm càng cao thì thứ hạng càng cao. Thứ hạng dựa trên điểm này và giá thầu. |
| search_volume | int32 | 10 | Số lần tìm từ khóa trên Shopee trong 30 ngày gần nhất; lượng tìm càng lớn thì quảng cáo nhận nhiều hiển thị hơn. |
| suggested_bid | float | 1.5 | Giá thầu từ khóa được gợi ý, theo tiền tệ địa phương. |
Mẫu phản hồi
{
"error": "",
"message": "",
"warning": "",
"request_id": "demo-request",
"response": {
"item_id": 100001,
"input_keyword": "áo",
"suggested_keyword_list": [
{
"keyword": "áo cotton",
"quality_score": 10,
"search_volume": 10,
"suggested_bid": 1.5
}
]
}
}
Mã lỗi của Shopee Ads (15)
Bấm để xem
| Mã | Ý nghĩa |
|---|---|
| error_not_found | Không tìm thấy đơn / gói / yêu cầu theo mã đã gửi. |
| 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.api.http_method_not_allowed | Phương thức HTTP không được hỗ trợ cho API này. |
| ads.keyword.item_not_match | Sản phẩm không thuộc gian hàng. |
| 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. |
| error_data | Dữ liệu không tồn tại hoặc không hợp lệ cho thao tác (vd mã không có, loại yêu cầu không cho phép). |
| error_shop | Gian hàng không hợp lệ — kiểm tra platform_shop_id. |
| 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