Get the quota for a SKAN Dedicated Campaign per ad network
GET/campaign/quota/info/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/campaign/quota/info/
Description
Use this endpoint to get the quota for SKAN Dedicated Campaigns per ad network, the ad group quota under a campaign, and the ad quota for an ad group within a SKAN 4.0 Dedicated Campaign.
An iOS app can have up to 15 or 25 (allowlist-only) active SKAN Dedicated Campaigns per ad network and up to five active ad groups within each SKAN Dedicated Campaign.
To learn more about the SKAN Dedicated Campaign quota rules and ad networks, see Dedicated Campaign quota limits.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/campaign/quota/info/
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
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| campaign_id | query | string | No | ID of a SKAN Dedicated Campaign.
Specify this field if you want to get ad group quota (adgroup_quota_info) for a certain campaign.
Note: If the ID is not the ID of a SKAN Dedicated Campaign, an error will occur. To determine whether a Dedicated Campaign is a SKAN Dedicated Campaign, use /campaign/get/ and check whether the returned disable_skan_campaign is false. | |
| adgroup_id | query | string | No | ID of an ad group within a SKAN 4.0 Dedicated Campaign. Specify this field if you want to get ad quota (ad_quota_info) for a certain group.
Note: If the ID is not the ID of an ad group within a SKAN 4.0 Dedicated Campaign, the value of the returned ad_quota_info will be null. | |
| has_advertiser_quota | query | boolean | No | Whether to return quota info via different advertiser IDs under the promoted app.
Set it to true if you want to get campaign quota via different advertiser IDs.
Default value: false. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/campaign/quota/info/" \ -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/campaign/quota/info/",
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/campaign/quota/info/');
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/campaign/quota/info/' . '?' . 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 | The response code. Response code. For the complete list of response codes and descriptions, see Appendix - Return Codes. | |
| message | string | Response message. For details, see Appendix - Return Codes. | |
| data | object | The returned data. | |
| split_test_quota | object | Split test quota information. | |
| max_test_number | number | Maximum test group number in one split-test. The value of this field will be `2`. | |
| available_test_group | number | The number of split-test groups that you can launch now in this app. | |
| used_test_group | number | The number of split-test groups that have been launched. | |
| releasing_test_group | number | The number of split-test groups that are to be released. | |
| used_quota | number | The number of quota that has been launched. | |
| releasing_quota | number | The number of quota that is to be released. | |
| campaign_quota_info | object | Campaign quota. | |
| tiktok_campaign_quota_info | object | Campaign quota under the TikTok network. The placements under TikTok network are `PLACEMENT_TIKTOK`and `PLACEMENT_GLOBAL_APP_BUNDLE`. | |
| total_campaign_quota_info | object | Campaign quota under an app ID. | |
| total_campaign_quota | number | The total quota of active Dedicated Campaigns. The value of this field will be `15` or `25`. Note: Expanding the quota of active Dedicated Campaigns to 25 per ad network for an iOS app is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative. | |
| used_campaign_quota | number | The number of Dedicated Campaigns that have been launched. | |
| releasing_campaign_quota | number | The number of Dedicated Campaigns that are to be released. | |
| available_campaign_quota | number | The number of Dedicated Campaigns that you can launch now. | |
| used_campaign_ids | string[] | The IDs of the Dedicated Campaigns that have been launched. | |
| releasing_campaign_ids | string[] | The IDs of the Dedicated Campaigns that are to be released. | |
| campaign_quota_by_adv | object[] | Campaign quota under each advertiser ID. | |
| used_campaign_quota | number | The number of Dedicated Campaigns that have been launched. | |
| releasing_campaign_quota | number | The number of Dedicated Campaigns that are to be released. | |
| advertiser_id | string | Advertiser ID. | |
| pangle_campaign_quota_info | object | Campaign quota under the Pangle network. The placement available for Pangle network is `PLACEMENT_PANGLE`. | |
| total_campaign_quota_info | object | Campaign quota under an app ID. | |
| total_campaign_quota | number | The total quota of active Dedicated Campaigns. The value of this field will be `15` or `25`. Note: Expanding the quota of active Dedicated Campaigns to 25 per ad network for an iOS app is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative. | |
| used_campaign_quota | number | The number of Dedicated Campaigns that have been launched. | |
| releasing_campaign_quota | number | The number of Dedicated Campaigns that are to be released. | |
| available_campaign_quota | number | The number of Dedicated Campaigns that you can launch now. | |
| used_campaign_ids | string[] | The IDs of the Dedicated Campaigns that have been launched. | |
| releasing_campaign_ids | string[] | The IDs of Dedicated Campaigns that are to be released. | |
| campaign_quota_by_adv | object[] | Campaign quota under each advertiser ID. | |
| used_campaign_quota | number | The number of Dedicated Campaigns that have been launched. | |
| releasing_campaign_quota | number | The number of Dedicated Campaigns that are to be released. | |
| advertiser_id | string | Advertiser ID. | |
| adgroup_quota_info | object | Ad group quota under a Dedicated Campaign. | |
| total_adgroup_quota | number | The quota of active ad groups. The value of this field will be `5`. | |
| used_adgroup_quota | number | The number of ad groups that have been launched. | |
| available_adgroup_quota | number | The number of ad groups that you can launch now. | |
| placements | string[] | The allowed placements for ad groups. You cannot create ad groups with placements that are not listed here. | |
| campaign_id | string | Campaign ID. | |
| ad_quota_info | object | Ad quota under an ad group within a SKAN 4.0 Dedicated Campaign. Note: - If the specified ad group (`adgroup_id`) is not within a SKAN 4.0 Dedicated Campaign, the value of this field will be null. - If you provide a SKAN 4.0 App ID (`app_id`) without specifying `campaign_id` and `adgroup_id` in the request, this field will represent the default ad quota for a regular SKAN 4.0 Dedicated Campaign (a SKAN 4.0 Dedicated Campaign where Smart+ Campaign, Automated Creative Optimization, and Smart Creative settings are not enabled). Example: `"ad_quota_info": {"available_ad_quota": 9, "total_ad_quota": 9,"adgroup_id": "0","used_ad_quota": 0}`. | |
| total_ad_quota | number | The quota of active ads. For ad groups within regular SKAN 4.0 Dedicated Campaigns (SKAN 4.0 Dedicated Campaigns where Smart+ Campaign, Automated Creative Optimization, and Smart Creative settings are not enabled), the value of this field will be `9`. | |
| used_ad_quota | number | The number of ads that have been launched. | |
| available_ad_quota | number | The number of ads that you can launch now. | |
| adgroup_id | string | Ad group ID. | |
| request_id | string | The log ID of a request, which uniquely identifies the request. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"ad_quota_info": {
"available_ad_quota": 9,
"total_ad_quota": 9,
"adgroup_id": "0",
"used_ad_quota": 0
},
"adgroup_quota_info": {
"campaign_id": "0",
"used_adgroup_quota": 0,
"placements": [
"PLACEMENT_PANGLE",
"PLACEMENT_GLOBAL_APP_BUNDLE",
"PLACEMENT_TIKTOK"
],
"total_adgroup_quota": 5,
"available_adgroup_quota": 5
},
"split_test_quota": {
"max_test_number": 2,
"used_test_group": 2,
"releasing_test_group": 0,
"used_quota": 4,
"releasing_quota": 0,
"available_test_group": 0
},
"campaign_quota_info": {
"tiktok_campaign_quota_info": {
"campaign_quota_by_adv": [],
"total_campaign_quota_info": {
"releasing_campaign_ids": [
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}"
],
"total_campaign_quota": 20,
"releasing_campaign_quota": 4,
"used_campaign_ids": [
"{{releasing_campaign_id}}"
],
"available_campaign_quota": 15,
"used_campaign_quota": 1
}
},
"pangle_campaign_quota_info": {
"campaign_quota_by_adv": [],
"total_campaign_quota_info": {
"releasing_campaign_ids": [
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}"
],
"total_campaign_quota": 20,
"releasing_campaign_quota": 3,
"used_campaign_ids": [
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}"
],
"available_campaign_quota": 12,
"used_campaign_quota": 5
}
}
}
}
}
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