获取可用内容定向标签
您可以使用本接口获取可用于定向的内容相关定向标签。您需要在请求中传入广告主ID,推广目标和地区代码。
点击这里了解如何使用内容相关定向。
注意
内容相关定向目前为白名单功能。如需使用此功能,请联系您的TikTok销售代表。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/tool/contextual_tag/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主ID。 |
| objective_type {必填} | string | 推广目标。仅支持`REACH`, `VIDEO_VIEWS`,`RF_REACH`。 |
| region_codes |string[] | 定向的国家或地区代码。 |
| brand_safety_type | string | 品牌安全类型。默认值:`STANDARD_INVENTORY`。枚举值: <ul><li>`EXPANDED_INVENTORY`:使用TikTok的品牌安全解决方案,即使用<b>扩展库存</b>。您的广告将不会出现在不当内容或包含成人主题的内容后面。在下个API版本中`EXPANDED_INVENTORY`将替代`NO_BRAND_SAFETY`,并成为默认的品牌安全选项。</li><li>`STANDARD_INVENTORY`:使用TikTok的品牌安全解决方案中的<strong>标准库存</strong>。您的广告将展示在适合大多数品牌的内容周围。 </li><li>`LIMITED_INVENTORY`:使用TikTok的品牌安全解决方案中的<strong>有限库存</strong>。您的广告将展示在不包含成人主题的内容周围。</li></ul>您可以使用[/tool/region/](https://ads.tiktok.com/marketing_api/docs?id=1737189539571713)接口查询品牌安全设置对应的广告可投放国家或地区。<br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>出价前第三方品牌安全解决方案和在使用`APP_PROMOTION`,`WEB_CONVERSIONS`,`TRAFFIC`和`LEAD_GENERATION`推广目标的竞价广告中应用出价前第一方品牌安全解决方案目前均为白名单功能。如需使用此功能,请联系您的TikTok销售代表。</li><li> 请查看[品牌安全](https://ads.tiktok.com/marketing_api/docs?id=1739381752981505),了解出价前品牌安全筛选的支持推广目标。</li></ul> |
| rf_campaign_type | string | <p><span style="color:darkred"><b>注意</b></span>:<ul><li>仅当推广目标(`objective_type`)设置为`RF_REACH`时,可用此字段将推广系列设置为TikTok Pulse推广系列,从而获取PREMIUM标签。</li><li>推广目标非`RF_REACH`时,本字段无需传入。</li></ul> 枚举值: `STANDARD `(普通覆盖和频次推广系列), `PULSE`(TikTok Pulse推广系列)。 |
### 示例 ```xcodeblock (code curl http) curl --location --get 'https://business-api.tiktok.com/open_api/v1.3/tool/contextual_tag/get/?advertiser_id={{advertiser_id}}&objective_type=RF_REACH®ion_codes=[%22US%22]&brand_safety_type=LIMITED_INVENTORY&rf_campaign_type=PULSE' \ --header 'Access-Token: {{Access-Token}}' \ --header 'Content-Type: application/json' \ (/code)
## 返回
``` xtable
|字段{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>:目前,您可以在 `AE`(阿联酋)、`AU`(澳大利亚)、`BR`(巴西)、`CA`(加拿大)、`DE`(德国)、`ES`(西班牙)、`FR`(法国)、`GB`(英国)、`IT`(意大利)、`MX`(墨西哥)、`SA`(沙特阿拉伯)、`TR`(土耳其) 和 `US`(美国)使用 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": [
{
"type": "PREMIUM",
"name": "{{name}}",
"status": "ONLINE",
"region_codes": [
"US",
"CA",
"GB",
"DE",
"FR",
"IT",
"ES",
"BR",
"AU",
"MX"
],
"description": "{{description}}",
"objective_types": [
"RF_REACH"
],
"content_lineup_type": "CUSTOM",
"contextual_tag_id": "7"
}
]
}
}
(/code)