Get the dynamic quota on active ad groups
GET/adgroup/quota/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/adgroup/quota/
Description
Use this endpoint to get the dynamic quota on the number of active auction ad groups that an advertiser can have.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/adgroup/quota/
Authentication & shop
| Name | In | Type | Sample | Description |
|---|---|---|---|---|
| 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 | 7000000000000000001 | Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản. |
Request parameters
No specific parameters (besides the common ones).
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/adgroup/quota/" \ -H "Authorization: Bearer $KEY"
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.get(
"https://partner.quantri360.com/v1/tiktok_business/adgroup/quota/",
params={},
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/tiktok_business/adgroup/quota/');
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: '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/tiktok_business/adgroup/quota/' . '?' . http_build_query([]); $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
Response fields (as returned by TikTok Business)
| Name | Type | Sample | Description |
|---|---|---|---|
| code | number | Response code. For the complete list of response codes and descriptions, see Appendix-Return Code. | |
| message | string | Response message. For details, see Appendix - Return Codes. | |
| request_id | string | The log ID of a request, which uniquely identifies the request. | |
| data | object | Returned data. Note: - If the advertiser (`advertiser_id`) is subject to fixed active ad group quota, you will receive `total_adgroup_quota` = 5000 and `used_adgroup_quota` = 0 in the response. - If the advertiser (`advertiser_id`) is being punished, there will be no active ad groups allowed to create. The returned `total_adgroup_quota` and `used_adgroup_quota` will be set to 0. You can check whether an advertiser account is being punished through the `status` returned by /advertiser/info/. | |
| total_adgroup_quota | number | The maximum number of active ad groups that the advertiser (`advertiser_id`) can have. | |
| used_adgroup_quota | number | The number of active ad groups that the advertiser (`advertiser_id`) currently has. Note: When the advertiser has used up all your dynamic active ad group quota (`total_adgroup_quota` = `used_adgroup_quota`), the advertiser can still create additional ad groups, but the additional ad groups will be automatically deactivated after several seconds. Also, the advertiser cannot use /adgroup/status/update/ to reactivate the deactivated ad groups. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"total_adgroup_quota": 4980,
"used_adgroup_quota": 20
}
}
Get started
- Sign up for Partner
- Enable a data type of the Ads (Marketing API) group on the platform page
- Create an API key (tick the TikTok Business channel)
- Call it as in the examples above