获取内容定向标签详情
您可以使用本接口获取内容相关定向标签的详细信息。您需在请求中传入广告主ID和/tool/contextual_tag/get/返回的内容相关定向标签ID。
点击这里了解如何使用内容相关定向。
注意
内容相关定向目前为白名单功能。如需使用此功能,请联系您的TikTok销售代表。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/tool/contextual_tag/info/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主ID。 |
| contextual_tag_ids{必填} | string[] | 内容相关定向标签ID列表。 |
示例
(code curl http)
curl --location --get 'https://ads.tiktok.com/open_api/v1.3/tool/contextual_tag/info/?advertiser_id={{advertiser_id}}&contextual_tag_ids=[%2251%22]' \
--header 'Access-Token: {{access-token}}' \
--header 'Content-Type: application/json' \
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|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| 返回数据。 |
#| contextual_tag_list | object[] | 内容相关定向标签列表。 <br><p><span style="color:darkred"><b>注意</b></span>:内容相关定向目前为白名单功能。若您未申请进入白名单,返回值将为空列表(`[]`)。 |
##| contextual_tag_id | string | 内容相关定向标签ID。 <br><p><span style="color:darkred"><b>注意</b></span>:目前内容相关定向标签仅支持与定向以下国家或地区的受众定位同时使用:<ul><li>一般标签: `US` (美国), `CA` (美国),`GB` (英国), `DE` (德国), `FR` (法国), `IT` (意大利), `ES` (西班牙), `JP` (日本), `KR`(韩国),`AU` (澳大利亚),`BR` (巴西), `MX`(墨西哥)。</li><li>优选标签: `US` (美国), `CA` (美国),`GB` (英国), `DE` (德国), `FR` (法国), `IT` (意大利), `ES` (西班牙), `JP` (日本), `KR`(韩国),`AU` (澳大利亚),`BR` (巴西), `MX`(墨西哥)。</li></ul> |
##| name | string | 内容相关定向标签名称。 |
##| type | string | 内容相关定向标签类型。枚举值:`GENERAL` (一般标签), `PREMIUM`(优选标签)。 |
##| content_lineup_type | string | 内容相关定向标签类型。<br>枚举值:<ul><li>`MAX_PULSE`(Max Pulse:您的广告将在 TikTok 上任意主题的热门内容前后展示。)</li><li>`CUSTOM`(类别分组:您的广告将在所选类别或季节性活动的热门内容前后展示。) </li></ul><p><span style="color:darkred"><b>注意</b></span>:目前,您可以在`US`(美国)、`CA`(加拿大)、`BR`(巴西)使用Max Pulse,以及在`US`(美国)、`CA`(加拿大)、`BR`(巴西)、`AU`(澳大利亚)、`GB`(英国)、`FR`(法国)、`IT`(意大利)、`ES`(西班牙)、`DE`(德国)使用类别分组。Max Pulse和类别分组为白名单功能。如果您想在上述市场使用该两种功能,请联系您的TikTok销售代表。 |
##| status | string | 内容相关定向标签状态。枚举值: `ONLINE`, `OFFLINE`。仅上线状态( `status`=`ONLINE` )的标签可用于创建广告。 |
##| description | string | 内容相关定向标签描述。 |
##| objective_types | string[] | 内容相关定向标签支持的推广目标。 |
##| region_codes | string[] | 内容相关定向标签支持的国家或地区代码。 |
示例
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"contextual_tag_list": [
{
"content_lineup_type": "MAX_PULSE",
"description": "{{description}}",
"objective_types": [
"RF_REACH"
],
"name": "Max Pulse",
"contextual_tag_id": "51",
"type": "PREMIUM",
"region_codes": [
"US",
"CA",
"BR"
],
"status": "ONLINE"
}
]
}
}
(/code)