获取 SKAN 专属推广系列在广告网络中的配额
您可以使用本接口获取 SKAN 专属推广系列在每个广告网络中的配额,SKAN 专属推广系列下广告组的配额,以及 SKAN 4.0 专属推广系列下某一广告组的广告配额。
每个 iOS 应用在每个广告网络中最多创建 15 个或 25 个(此为白名单功能)启用状态的 SKAN 专属推广系列,每个 SKAN 专属推广系列中最多创建 5 个启用状态的广告组。
若想了解 SKAN 专属推广系列配额规则和广告网络,请查看专属推广系列配额限制。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/campaign/quota/info/
方法 GET
Header
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。获取详细信息,请参考[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主 ID。 |
|app_id {必填} |string|推广的应用的 ID。<br><br>您可通过[/app/list/](https://ads.tiktok.com/marketing_api/docs?id=1740859313270786)获取`app_id`。|
|campaign_id | string|SKAN 专属推广系列的 ID。<br>若您想获取某一推广系列中广告组的配额(`adgroup_quota_info`),请传入本字段。<br><br><p><span style="color:darkred"><b>注意</b></span>:若您传入的 ID 不是 SKAN 专属推广系列的 ID,将会报错。若想确认某个专属推广系列是否为 SKAN 专属推广系列,可使用[/campaign/get/](1739315828649986.html)并检查返回的 `disable_skan_campaign` 是否为 `false`。|
| adgroup_id | string | SKAN 4.0 专属推广系列中的广告组的 ID。若您想获取某一广告组中广告的配额(`ad_quota_info`),请传入本字段。 <br><br><p><span style="color:darkred"><b>注意</b></span>:若您传入的 ID 不是 SKAN 4.0 专属推广系列中的的广告组的 ID,返回的 `ad_quota_info` 值将为 null。 |
|has_advertiser_quota |boolean| 是否返回推广的应用下不同广告主 ID 对应的配额。<br><br>若您想获取不同广告主 ID 对应的推广系列配额,请将本字段设置为`true`。默认值:`false`。 |
示例
查询某 iOS 应用的专属推广系列配额
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign/quota/info/?advertiser_id={{advertiser_id}&app_id={{app_id}}'\
--header 'Access-Token: {{Access-Token}}' \
(/code)
查询使用某 iOS 应用的专属推广系列的广告组配额
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign/quota/info/?advertiser_id={{advertiser_id}&app_id={{app_id}}&campaign_id={{campaign_id}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)
查询使用某 iOS 应用的 SKAN 4.0 专属推广系列中广告组的广告配额
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign/quota/info/?advertiser_id={{advertiser_id}&app_id={{app_id}}&adgroup_id={{adgroup_id}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
| 字段 {40%}|类型{12%}| 描述{48%} |
|---|---|---|
| code | number | 返回码。完整返回码列表及描述,可查看[附录-返回码]( https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
| message | string | 返回信息。更多信息可查看[附录-返回码]( https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
| data | object | 返回数据。 |
#| split_test_quota | object | 拆分对比测试的配额信息。 |
##| max_test_number | number | 单个拆分对比测试内最大测试组数。<br>本字段的值将为`2`。 |
##| available_test_group | number | 当前 App 中可用的测试组数量。 |
##| used_test_group | number | 已使用的测试组数量。 |
##| releasing_test_group | number | 待释放的测试组数量。 |
##| used_quota | number | 已使用配额。 |
##| releasing_quota | number | 待释放配额。 |
#| campaign_quota_info | object | 推广系列配额信息。 |
##| tiktok_campaign_quota_info | object | 广告网络 TikTok 下的推广系列配额。广告网络 TikTok 下支持的版位包括`PLACEMENT_TIKTOK`和`PLACEMENT_GLOBAL_APP_BUNDLE`。 |
###| total_campaign_quota_info | object | 应用 ID对应的推广系列配额。 |
####| total_campaign_quota | number | 启用状态的专属推广系列总配额。<br>本字段的值将为 `15` 或 `25`。<br><br><p><span style="color:darkred"><b>注意</b></span>:将单个 iOS 应用的启用状态专属推广系列配额扩展到每个广告网络 25 个目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。 |
####| used_campaign_quota | number | 已使用的专属推广系列配额。 |
####| releasing_campaign_quota | number | 待释放的专属推广系列配额。 |
####| available_campaign_quota | number | 可用的专属推广系列配额。 |
####| used_campaign_ids | string[] | 已创建的专属推广系列的 ID 列表。 |
####| releasing_campaign_ids | string[] | 待释放的专属推广系列的 ID 列表。 |
###| campaign_quota_by_adv | object[] | 广告主ID对应的推广系列配额。 |
####| used_campaign_quota | number | 已使用的专属推广系列配额。 |
####| releasing_campaign_quota | number | 待释放的专属推广系列配额。 |
####| advertiser_id | string | 广告主 ID。 |
##| pangle_campaign_quota_info | object | 广告网络 Pangle 下的推广系列配额。广告网络 Pangle 下仅支持 `PLACEMENT_PANGLE`版位。 |
###| total_campaign_quota_info | object | 应用 ID 对应的推广系列配额。 |
####| total_campaign_quota | number | 启用状态的专属推广系列总配额。<br>本字段的值将为 `15` 或 `25`。<br><br><p><span style="color:darkred"><b>注意</b></span>:将单个 iOS 应用的启用状态专属推广系列配额扩展到每个广告网络 25 个目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。 |
####| used_campaign_quota | number | 已使用的专属推广系列配额。 |
####| releasing_campaign_quota | number | 待释放的专属推广系列配额。 |
####| available_campaign_quota | number | 可用的专属推广系列配额。 |
####| used_campaign_ids | string[] | 已创建的专属推广系列的 ID 列表。 |
####| releasing_campaign_ids | string[] | 待释放的专属推广系列的 ID 列表。 |
###| campaign_quota_by_adv | object[] | 广告主ID对应的推广系列配额。 |
####| used_campaign_quota | number | 已使用的专属推广系列配额。 |
####| releasing_campaign_quota | number | 待释放的专属推广系列配额。 |
####| advertiser_id | string | 广告主 ID。 |
#| adgroup_quota_info | object | 专属推广系列下的广告组配额信息。 |
##| total_adgroup_quota | number | 启用状态的广告组总配额。<br>本字段的值将为 `5`。 |
##| used_adgroup_quota | number | 已使用的广告组配额。 |
##| available_adgroup_quota | number | 可用的广告组配额。 |
##| placements | string[] | 广告组可用的版位。新建的广告组仅可使用本字段列出的版位。 |
##| campaign_id | string | 推广系列 ID。 |
#| ad_quota_info | object | SKAN 4.0 专属推广系列下某一广告组的广告配额信息。 <br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>若指定的广告组(`adgroup_id`)不属于 SKAN 4.0 专属推广系列,本字段的值将为 null。</li><li>若您在请求中指定了 SKAN 4.0 App 的 ID(`app_id`)且未指定 `campaign_id` 和 `adgroup_id` ,本字段将代表普通 SKAN 4.0 专属推广系列(即未启用 Smart+ 推广系列、程序化创意和智能创意设置的 SKAN 4.0 专属推广系列)的默认广告配额。示例:`"ad_quota_info": {"available_ad_quota": 9, "total_ad_quota": 9,"adgroup_id": "0","used_ad_quota": 0}`。</li></ul> |
##| total_ad_quota | number | 启用状态的广告总配额。 <br><br>对于普通 SKAN 4.0 专属推广系列(即未启用 Smart+ 推广系列、程序化创意和智能创意设置的 SKAN 4.0 专属推广系列)下的广告组,本字段的值将为`9`。 |
##| used_ad_quota | number | 已使用的广告配额。 |
##| available_ad_quota | number | 可用的广告配额。 |
##| adgroup_id | string | 广告组 ID。 |
| request_id | string | 请求的日志 ID,唯一标识一个请求。 |
示例
查询某 iOS 应用的专属推广系列配额
(code Success-Response http)
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
}
}
}
}
}
(/code)
查询使用某 iOS 应用的专属推广系列的广告组配额
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"ad_quota_info": null,
"adgroup_quota_info": {
"available_adgroup_quota": 5,
"campaign_id": "{{campaign_id}}",
"placements": [
"PLACEMENT_GLOBAL_APP_BUNDLE",
"PLACEMENT_TIKTOK",
"PLACEMENT_PANGLE"
],
"total_adgroup_quota": 5,
"used_adgroup_quota": 0
},
"split_test_quota": {
"releasing_test_group": 0,
"releasing_quota": 0,
"max_test_number": 2,
"used_test_group": 2,
"used_quota": 4,
"available_test_group": 0
},
"campaign_quota_info": {
"tiktok_campaign_quota_info": {
"total_campaign_quota_info": {
"releasing_campaign_quota": 4,
"total_campaign_quota": 20,
"used_campaign_ids": [
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}"
],
"releasing_campaign_ids": [
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}"
],
"used_campaign_quota": 5,
"available_campaign_quota": 11
},
"campaign_quota_by_adv": []
},
"pangle_campaign_quota_info": {
"total_campaign_quota_info": {
"releasing_campaign_quota": 3,
"total_campaign_quota": 20,
"used_campaign_ids": [
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}"
],
"releasing_campaign_ids": [
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}"
],
"used_campaign_quota": 5,
"available_campaign_quota": 12
},
"campaign_quota_by_adv": []
}
}
}
}
(/code)
查询使用某 iOS 应用的 SKAN 4.0 专属推广系列中广告组的广告配额
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"ad_quota_info": {
"available_ad_quota": 7,
"adgroup_id": "{{adgroup_id}}",
"total_ad_quota": 9,
"used_ad_quota": 2
},
"adgroup_quota_info": {
"available_adgroup_quota": 5,
"campaign_id": "0",
"placements": [
"PLACEMENT_PANGLE",
"PLACEMENT_GLOBAL_APP_BUNDLE",
"PLACEMENT_TIKTOK"
],
"total_adgroup_quota": 5,
"used_adgroup_quota": 0
},
"split_test_quota": {
"releasing_test_group": 0,
"releasing_quota": 0,
"max_test_number": 2,
"used_test_group": 2,
"used_quota": 4,
"available_test_group": 0
},
"campaign_quota_info": {
"tiktok_campaign_quota_info": {
"total_campaign_quota_info": {
"releasing_campaign_quota": 4,
"total_campaign_quota": 20,
"used_campaign_ids": [
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}"
],
"releasing_campaign_ids": [
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}"
],
"used_campaign_quota": 5,
"available_campaign_quota": 11
},
"campaign_quota_by_adv": []
},
"pangle_campaign_quota_info": {
"total_campaign_quota_info": {
"releasing_campaign_quota": 3,
"total_campaign_quota": 20,
"used_campaign_ids": [
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}",
"{{used_campaign_id}}"
],
"releasing_campaign_ids": [
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}",
"{{releasing_campaign_id}}"
],
"used_campaign_quota": 5,
"available_campaign_quota": 12
},
"campaign_quota_by_adv": []
}
}
}
}
(/code)