更新广告组状态
您可以使用本接口更新广告组的状态:
- 开启广告组,在规定时间进行投放。
- 暂停广告组,停止广告投放。
- 删除广告组。
注意
- 您无法直接删除专属推广系列的广告组。若要删除此类广告组,您需要删除相应推广系列。
- 对于已删除的广告组,或已删除的推广系列中的广告组,其操作状态无法修改。您可以使用/campaign/get/或/adgroup/get/,并通过
operation_status字段获取推广系列或广告组的操作状态。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/adgroup/update/status/|/v1.3/adgroup/status/update/|
|请求参数类型|advertiser_id: number <br>adgroup_ids: number[]|advertiser_id: string <br>adgroup_ids: string[]|
|请求参数名称|opt_status|operation_status|
|新增请求参数| / |allow_partial_success|
|返回参数类型|adgroup_ids: number[] |adgroup_ids: string[] |
|新增返回参数| / |error_list`|
## 请求
**地址** <https://business-api.tiktok.com/open_api/v1.3/adgroup/status/update/>
**方法** POST
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。 |
|Content-Type {必填}|string|请求消息类型<br>允许值: `"application/json"`。 |
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string|广告主 ID。|
|adgroup_ids {必填}|string[]|待操作的广告组 ID 列表。<br><br>允许数量范围:1-20。 |
|operation_status{必填}|string|要进行的操作。<br><br>枚举值:`DISABLE`(暂停),`ENABLE`(启用),`DELETE`(删除)。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li> 您无法修改已删除的广告组,或已删除的推广系列中的广告组的状态。 </li><li>不支持对覆盖和频次广告组执行 `ENABLE`(启用)和`DISABLE`(暂停)操作。</li></ul>|
| allow_partial_success | boolean | 是否支持操作部分成功。<br><br>枚举值:`true`,`false`。 默认值:`false`。 <br><br> 若本字段设置为 `true` 且您指定了多个广告组,则支持仅对部分广告组操作成功,此时将筛除不支持修改状态的广告组。 |
示例
(code curl http)
curl -H "Access-Token:xxx" -H "Content-Type:application/json" -X POST \
-d '{
"advertiser_id": "ADVERTISER_ID",
"adgroup_ids": [
"ADGROUP_IDS"
],
"operation_status": "OPT_STATUS"
}' \
https://business-api.tiktok.com/open_api/v1.3/adgroup/update/status/
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|message |string|返回信息,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097) 。|
|data |object|返回数据 |
#|adgroup_ids|string[]|操作成功的广告组 ID 列表。|
#|status|string|操作成功的广告组当前的状态。<br><br>枚举值:`DISABLE`(已暂停),`ENABLE`(已启用),`DELETE`(已删除)。|
#| error_list | object[] | 仅当 `allow_partial_success` 设置为 `true` 时返回本字段。<br><br> 报错列表及对应的操作失败的广告组。 |
##| adgroup_id | string | 操作失败的广告组的 ID。 |
##| error_message | string | 与该操作失败的广告组关联的报错信息。 |
|request_id |string|请求的日志ID,唯一标识一个请求。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
"status": "DISABLE",
"adgroup_ids": [
111
]
},
"request_id": "2020031110223101018904922300361F64"
}
(/code);