将受众应用到多个广告组
您可以使用本接口将受众应用到多个广告组,或断开受众与广告组之间的关联。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/apply/
方法 POST
Header
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
|Content-Type {必填}|string|请求信息类型<br>允许格式:`application/json`。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string|广告主 ID。|
|custom_audience_id{必填} |string|自定义受众ID。您只能传入一个自定义受众ID。
|adgroup_ids{必填}|string[]|广告组ID列表。<br><p><span style="color:darkred"><b>注意</b></span>:<br><ul><li>`adgroup_ids` 和 `custom_audience_id` 必须属于同一个广告主账号。否则将会报错。<li>不能将相似受众用于覆盖和频次广告,否则会出错。详情见下。</li> <br>1. 如果`custom_audience_id`为相似受众,且`adgroup_ids`为覆盖和频次广告组,系统会报错。<p>2. 如果`custom_audience_id`为相似受众,且受众子类型为`REACH_FREQUENCY`,系统会报错。
|action_mode {必填}|string|要对受众进行的特定操作。枚举值:`Apply`(应用),`Disconnect`(解除应用)。
|usage_mode {+条件必填}|string|使用方式。选择将该受众在广告组中作为定向使用或作为排除使用。当`action_mode`为`Apply`时必填。枚举值: `Include`(作为定向使用), `Exclude`(作为排除使用)。
示例
1. 应用受众
(code)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/apply' \
--header 'Access-Token: 123' \
--header 'Content-Type: application/json' \
--data-raw '{
"advertiser_id":"123",
"custom_audience_id":"123",
"adgroup_ids":["123"],
"action_mode":"Apply",
"usage_mode":"Include"
}'
(/code)
2. 解除应用受众
(code)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/apply' \
--header 'Access-Token: 123' \
--header 'Content-Type: application/json' \
--data-raw '{
"advertiser_id":"123",
"custom_audience_id":"123",
"adgroup_ids":["123"],
"action_mode":"Disconnect"
}'
(/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|返回数据。|
|request_id |string|请求的日志id,唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "123",
"data": {}
}
(/code);