获取投放中广告组的动态配额

您可以使用本接口获取广告主投放中竞价广告组的动态配额。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/adgroup/quota/

方法 GET

Header

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|

参数

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主ID。 |

示例

(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/adgroup/quota/?advertiser_id={{advertiser_id}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)

返回

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number| 返回码。完整返回码列表及描述，参见 [附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string| 返回信息。更多信息参见 [附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string| 请求的日志ID，唯一标识一个请求。 |
|data |object| 返回数据。<br><p><span style="color:darkred"><b>注意</b></span>：<ul><li>若广告主（`advertiser_id`）的投放中广告组配额固定，返回中将显示`total_adgroup_quota `为 5000，`used_adgroup_quota`为 0。</li><li>若广告主（`advertiser_id`）处在惩罚状态，则不允许创建投放中广告组，此时 `total_adgroup_quota`和`used_adgroup_quota`的返回值将为0。您可通过[/advertiser/info/](https://ads.tiktok.com/marketing_api/docs?id=1739593083610113)返回的`status`字段查看广告账户是否处在惩罚状态。</li></ul> |
#| total_adgroup_quota | number | 广告主（`advertiser_id`）可拥有的投放中广告组最大数。 |
#| used_adgroup_quota| number | 广告主（`advertiser_id`）目前拥有的投放中广告组数量。 <br><p><span style="color:darkred"><b>注意</b></span>：若所指定的广告主已用尽投放中广告组的动态配额（`total_adgroup_quota` = `used_adgroup_quota`），则该广告主可以继续创建额外广告组，但新建的额外广告组在数秒后将自动变为暂停状态。此外，广告主还将无法再使用 [/adgroup/status/update/](https://ads.tiktok.com/marketing_api/docs?id=1739591716326402)将处于暂停状态的广告组更新为投放中状态。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "total_adgroup_quota": 4980,
        "used_adgroup_quota": 20
    }
}
(/code)