搜索定向话题标签
您可以使用本接口基于种子关键词搜索定向话题标签。
返回的话题标签 ID (keyword_id)可传入 /adgroup/create/ 中的 action_category_ids 字段,用于定向观看过带有该话题标签的 TikTok 视频的受众。您需同时将 action_scene 设置为 HASHTAG_RELATED。
注意
推荐您使用兴趣和行为合并 API(/targeting/search/)搜索或列举和兴趣与行为相关的定向分类和话题标签。此接口可高效获取并整合必要的定向信息。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/tools/hashtag/recommend/|/v1.3/tool/hashtag/recommend/|
|请求参数类型 |advertiser_id: number|advertiser_id: string|
|新增请求参数| / |operator|
|返回参数类型|keyword_id: number|keyword_id: string|
|新增返回参数| / |input_keyword`|
## 请求
**地址** <https://business-api.tiktok.com/open_api/v1.3/tool/hashtag/recommend/>
**方法** GET
**请求header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
请求参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主 ID。 |
|keywords{必填}|string[]|关键词,用于生成一组相关的话题标签。<br><br>如果您传入了多个不相关的关键词且将 `operator` 设置为 `AND`,可能不会返回有效推荐。<br><br>最大数量:10。|
| operator | string | 关键词的运算符。<br><br>枚举值:<ul><li>`AND`:与。为 `keywords` 中指定的所有关键词整体生成推荐话题标签列表。</li><li>`OR`:或。为 `keywords` 中指定的每个关键词分别生成推荐话题标签列表。</li></ul><br>默认值:`AND`。 |
示例
(code curl http)
curl --location -g --request GET 'https://business-api.tiktok.com/open_api/v1.3/tool/hashtag/recommend/?keywords=[%22game%22]&advertiser_id=1234' \
--header 'Access-Token: xxxx' \
(/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|返回数据。 |
#|recommend_keywords|object[]|推荐话题标签列表。|
##| input_keyword | string | 仅当请求中`operator` 设置为 `OR` 且`keywords`指定了多个关键词时返回。<br><br>推荐的话题标签对应的关键词。 <br><br>例如,若关键词为"game",对应的推荐话题标签为 "#gametime",则返回的`input_keyword` 将为`"game"`,`keyword` 将为 `"#gametime"`。 |
##|keyword|string|推荐话题标签。|
##|keyword_id|string|话题标签 ID。<br><br>本 ID 可传入使用[/adgroup/create/](https://ads.tiktok.com/marketing_api/docs?id=1739499616346114)创建广告组时的`action_category_ids`字段。您需同时将`action_scene` 设置为 `HASHTAG_RELATED`,从而定向观看过带有该话题标签的 TikTok 视频的受众。|
##|keyword_status|string|标签状态。<br><br>枚举值: `ONLINE` (可用), `OFFLINE` (不可用)。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "1234",
"data": {
"recommend_keywords": [
{
"keyword": "#gameroom",
"keyword_id": "3568527772311",
"keyword_status": "ONLINE"
},
{
"keyword": "#gametime",
"keyword_id": "3391154394694",
"keyword_status": "ONLINE"
}
]
}
}
(/code);