(已废弃)获取iOS 14专属推广系列配额
注意
若想查询配额信息,请使用/campaign/quota/info/接口。不推荐使用本接口,因为本接口返回的配额信息不准确。
您可以使用本接口查询iOS 14专属推广系列及广告组的配额状态。您可为每个 iOS 应用最多创建11个iOS 14专属推广系列,且每个iOS 14专属推广系列中允许存在最多2个广告组。
受苹果公司应用追踪透明度(App Tracking Transparency,ATT)框架推出的影响,您在单个 iOS 应用中仅可最多创建11个 iOS 14 专属推广系列。若您启用了iOS 14专属推广系列配额优化功能,您将可以在每个广告网络中为单个 iOS 应用分别创建11个 iOS 14 专属推广系列。请查看iOS 14 专属推广系列配额优化,了解在推广系列层级和广告组层级的具体变化。您也可以查看 iOS 14 专属推广系列 - iOS 14 专属推广系列配额 了解配额规则。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/campaign/quota/get/|/v1.3/campaign/quota/get/|
|请求参数类型|advertiser_id:number<br>campaign_ids: number<br>app_id: number|advertiser_id: string<br>campaign_ids: string<br>app_id: string|
|返回参数类型|campaign_id: number|campaign_id: string|
|新增返回参数|/|split_test_quota<br>max_test_number<br>available_test_group<br>used_test_group<br>releasing_test_group<br>used_quota<br>releasing_quota`|
## 请求
**地址**: <https://business-api.tiktok.com/open_api/v1.3/campaign/quota/get/>
**方法** GET
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。获取详细信息,请参考[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主 ID |
|app_id {必填} |string|推广的App的ID。您可通过[/app/list/](https://ads.tiktok.com/marketing_api/docs?id=1740859313270786)获取`app_id`。|
|campaign_id | string|推广系列ID|
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|message |string|返回信息,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|data |object|返回数据。 |
#|campaign_quota|object| iOS 14推广系列配额信息。|
##|used_quota |number| 已使用iOS 14配额。|
##|releasing_quota|number|待释放iOS 14配额。|
##|available_quota|number| 可用iOS 14配额。|
##|total_quota|number| iOS 14总配额。|
#|adgroup_quota|object| 推广系列下的广告组配额。|
##|campaign_id |string|推广系列ID。|
##|used_quota |number| 已使用的广告组配额。|
##|available_quota|number| 可用的广告组配额。 |
##|total_quota|number|广告组总配额。 |
#| split_test_quota | object | 拆分对比测试配额信息。|
##| max_test_number | integer | 单个拆分对比测试内最大测试组数。 目前仅有唯一值`2`。|
##| available_test_group | integer | 当前App中可用的iOS 14测试组数量。 |
##| used_test_group | integer | 已使用的iOS 14测试组数量。 |
##| releasing_test_group | integer | 待释放的iOS 14测试组数量。|
##| used_quota | integer | 已使用配额。|
##| releasing_quota | integer | 待释放配额。 |
|request_id |string|请求的日志ID,唯一标识一个请求。|
示例
(code Success http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
"campaign_quota": {
"used_quota": 5,
"releasing_quota": 0,
"available_quota": 6,
"total_quota": 11
}
},
"request_id": "2021012712121901023101600706029954"
}
(/code);