通过 ID 获取定向话题标签
您可以使用本接口传入话题标签关键词ID,来获取相关的话题标签以及可用状态。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/tools/hashtag/get/|/v1.3/tool/hashtag/get/|
|请求参数类型 |advertiser_id: number|advertiser_id: string|
|请求参数名称类型|keyword_id: number|keyword_ids: string[]|
|废弃请求参数|/|keyword_query_pairs(替代参数为keyword_ids) |
|返回参数类型 |keyword_id: number|keyword_id`: string|
## 请求
**地址** <https://business-api.tiktok.com/open_api/v1.3/tool/hashtag/get/>
**方法** GET
**请求header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
请求参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主 ID。 |
|keyword_ids {必填}|string[]|话题标签ID列表。|
示例
(code curl http)
curl --location -g --request GET 'https://business-api.tiktok.com/open_api/v1.3/tool/hashtag/get/?keyword_ids=["3158447993006"]&advertiser_id=1234' \
--header 'Access-Token: 1234' \
(/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|返回数据。 |
#|keywords_status|object[]| 视频话题标签列表。|
##|keyword|string|话题标签。|
##|keyword_id|string| 话题标签ID。|
##|keyword_status|string|标签状态。枚举值: `ONLINE` (可用), `OFFLINE` (不可用)。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "1234",
"data": {
"keywords_status": [
{
"keyword": "#musicchallenge",
"keyword_id": 2911052068069,
"keyword_status": "ONLINE"
}
]
}
}
(/code);