创建/删除受众细分群
您可以使用本接口创建/删除受众细分群。
请查看流式API - 流式API相关提示,了解同一个企业号下有多个广告账号和在受众细分中混用IDFA/AAID加密类型的相关提示,以及身份标识符标准化指南,了解身份标识符标准化的相关步骤。
注意
要申请访问流式API,可以从下拉菜单中选择“流式API”,在开发者门户网站上使用白名单管理功能。我们会持续审核申请。注意
- 频控规则:每个广告账户的秒级调用限制(QPS)为1。
- 每个广告主账户最多可创建400个受众细分群。若达到此限制,则需先删除已有受众细分群才能创建新的受众细分群。本限制为广告主层级限制。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/segment/audience/| /v1.3/segment/audience/|
|请求参数类型|advertiser_id: number |advertiser_id: string|
|请求参数名称和类型|delete_id: number |delete_audience_id`: string|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/segment/audience/
**方法** 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。 |
|action {必填}|string|需要执行的行动。枚举值:<ul><li>`create`: 创建受众细分群,需在请求中同时传入`custom_audience_name `。 </li><li> `delete`: 删除受众细分群,需请求中同时传入`delete_audience_id`。<br>不传时默认创建受众细分群,默认值为`create`。|
| custom_audience_name {+条件必填} | string | 新建受众细分群的名称。请注意,如果名称超过70个字符,名称将会被缩减到67个字符并以“...”结束。当`action`值为 `create` 时必填。 |
| delete_audience_id {+条件必填}|string|需要删除的受众ID。当`action`值为 `delete` 时必填。 |
示例
(code curl http)
curl -verbose -i --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/segment/audience/' \
--header 'Access-Token: <put_your_access_token_here>' \
--header 'Content-Type: application/json' \
-d '{
"custom_audience_name": "mens shoes",
"advertiser_id": 1356789172,
"action": "create" // create/delete (optional, default is creation)
}'
(/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|返回数据。 |
#|audience_id |string|受众ID。您在受众目标映射的时候需要传入受众ID的值。|
|request_id |string|请求的日志ID,唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 200,
"message": "OK",
"request_id":"XXXXXXXXXXXXXX",
"data": {
"audience_id": 100008357
}
}
(/code);