撤销覆盖和频次广告订单
您可以使用本接口撤单,从而停止您的覆盖和频次广告投放流程。
撤单成功后,对应广告组的状态会变为已关闭。已进入投放中状态的广告组不可撤单。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/adgroup/rf/order/cancel/|/v1.3/rf/order/cancel/|
|请求参数类型 |advertiser_id: number<br>adgroup_ids: number[]|advertiser_id: string<br>adgroup_ids: string[]|
|返回参数类型|fail_adgroup_ids: number[]|fail_adgroup_ids`: string[]|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/rf/order/cancel/
**方法** POST
**Header**
``` xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌,可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。 |
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主ID。 |
|adgroup_ids {必填}|string[]| 要撤单的广告组ID。需对应覆盖和频次广告组。 |
示例
(code curl http)
curl -H "Access-Token:xxx" -H "Content-Type:application/json" -X POST \
-d '{
"advertiser_id": "ADVERTISER_ID",
"adgroup_ids": [
"ADGROUP_IDS"
]
}' \
https://business-api.tiktok.com/open_api/v1.3/rf/order/cancel/
(/code)
返回
|字段|类型|描述|
|---|---|---|
|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|返回数据。 |
#|fail_adgroup_ids |string[]| 撤单失败的广告组ID。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
"fail_adgroup_ids": [222]
}
"request_id":"12345678"
}
(/code);