更新广告状态
您可以使用本接口关停,开启或者删除广告。
注意
对于已删除的广告,或已删除的推广系列或广告组中的广告,其操作状态无法修改。您可以使用/campaign/get/,/adgroup/get/或/ad/get/,并通过operation_status字段获取推广系列、广告组或广告的操作状态。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/ad/update/status/|/v1.3/ad/status/update/|
|请求参数类型|advertiser_id:number<br>ad_ids: number[]<br>aco_ad_ids: number[]|advertiser_id:string<br>ad_ids: string[]<br>aco_ad_ids: string[]|
|请求参数名称|opt_status|operation_status|
|返回参数类型|ad_ids: number[]<br>aco_ad_ids: number[]|ad_ids: string[]<br>aco_ad_ids`: string[]|
## 请求
**地址** <https://business-api.tiktok.com/open_api/v1.3/ad/status/update/>
**方法** POST
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。 |
|Content-Type {必填}|string|请求消息类型<br>允许值: `"application/json"` 。 |
参数
|字段|类型|描述|
|---|---|---|
|ad_ids {+条件必填}| string[] | 广告 ID 列表。允许数量范围: `1-20`。您需传入`ad_ids` 或 `aco_ad_ids`。 |
|aco_ad_ids{+条件必填}| string[] | 程序化创意广告 ID 列表,此类型广告仅支持 `ENABLE` 和 `DISABLE`,允许数量范围: `1-20`。您需传入`ad_ids` 或 `aco_ad_ids`。 |
|advertiser_id {必填}|string| 广告主ID |
|operation_status {必填}|string| 要进行的操作。<br>枚举值:`DELETE`(删除),`DISABLE`(暂停),`ENABLE`(启用)。<br><p><span style="color:darkred"><b>注意</b></span>:您无法修改已删除的广告,或已删除的推广系列或广告组中的广告的状态。|
示例
(code curl http)
curl -H "Access-Token:xxx" -H "Content-Type:application/json" -X POST \
-d '{
"advertiser_id": "ADVERTISER_ID",
"operation_status": "OPT_STATUS",
"ad_ids": [
"AD_IDS"
]
}' \
https://business-api.tiktok.com/open_api/v1.3/ad/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|返回数据 |
#|ad_ids | string[]| 更新的广告 ID 列表 |
#|aco_ad_ids| string[] | 更新的程序化创意广告 ID 列表 |
#|status |string|执行状态,枚举值: `DELETE`(删除),`DISABLE`(关停),`ENABLE`(开启)。 |
|request_id |string|请求的日志ID,唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
"status": "ENABLE",
"ad_ids": [
11,
22
]
},
"request_id": "2019091810032301011023224213552"
}
(/code);