获取一般兴趣分类列表
您可以使用本接口获取一般兴趣分类枚举值列表。
注意
推荐您使用兴趣和行为合并 API(/targeting/search/)搜索或列举和兴趣与行为相关的定向分类和话题标签。此接口可高效获取并整合必要的定向信息。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{22%}|v1.2{40%}|v1.3{38%}|
|---|---|---|
|接口路径|/v1.2/tools/interest_category/|/v1.3/tool/interest_category/|
|请求参数名称|<ul><li>placement</li><li>industry_types|<ul><li>placements</li><li>special_industries|
|请求参数类型 |advertiser_id: number|advertiser_id: string|
|返回参数名称|<ul><li>name( 在interest_categories对象中)</li><li>placement</li><li>industry_types|<ul><li>interest_category_name(在interest_categories对象中)</li><li>placements</li><li>special_industries|
|返回参数名称和类型|<ul><li>id(在interest_categories对象中): number </li><li>children( 在interest_categories对象中): number[]|<ul><li>interest_category_id:string</li><li>sub_category_ids`: string[] |
## 请求
**地址**
https://business-api.tiktok.com/open_api/v1.3/tool/interest_category/
**方法** GET
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌,可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。 |
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主 ID。 |
|version |number| 兴趣分类版本。<br><br>枚举值:`1`(对应 `interest_category`), `2` (对应 `interest_category_v2`)。默认值: `2`。|
|language |string| 兴趣分类语言。<br><br>默认值:`en`。 <br><br>>目前支持的语言有: `en`, ` zh`, ` ja`, ` de`, ` es`, ` fr`, ` id`, ` it`, ` ko`, ` ru`, ` th`, ` tr`, ` vi`, ` ar`, ` pt`, ` ms`。枚举值详见[枚举值-语言](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。<br>
|placements |string[]|投放版位。枚举值详见[附录-版位](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。<br>不同版位可选的兴趣分类可能不同,仅当 `version`为`2` 时有效。|
|special_industries|string[]| 特殊广告分类。 <br><br>枚举值:<ul><li>`HOUSING`:房地产,房屋保险,抵押贷款或相关的广告。</li><li>`EMPLOYMENT`:工作机会,实习机会,职业认证项目或相关的广告。</li><li>`CREDIT`:信用卡申请,汽车贷款,长期融资或相关的广告。</li></ul><br><p><span style="color:darkred"><b>注意</b></span>:本字段对于注册地为美国或加拿大的广告主已全量。若您是注册地非美国或加拿大的广告主且想在定向美国或加拿大的广告中使用特殊广告分类,您需申请额外的白名单。|
示例
(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "advertiser_id=ADVERTISER_ID" \
--data-urlencode "version=VERSION" \
https://business-api.tiktok.com/open_api/v1.3/tool/interest_category/
(/code)
返回
|字段{35%}|类型{10%}|描述{55%}|
|---|---|---|
|code |number|返回码。完整返回码列表及描述,可查看[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|message |string|返回信息。更多信息可查看[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|data |object|返回数据。 |
#|interest_categories|object[]| 兴趣分类列表。<br>若需确定游戏相关兴趣分类ID对应的兴趣分类名称,请查看[兴趣分类](1738865030529025.html)。 |
##|interest_category_id|string| 兴趣分类ID。 |
##|interest_category_name|string| 兴趣分类名称。 |
##|level|number| 层级。 |
##|sub_category_ids|string[]| 子级兴趣分类 ID 列表。 |
##|special_industries|string[]|特殊广告分类。 <br> <br>枚举值:<ul><li>`HOUSING`:房地产,房屋保险,抵押贷款或相关的广告。</li><li>`EMPLOYMENT`:工作机会,实习机会,职业认证项目或相关的广告。</li><li>`CREDIT`:信用卡申请,汽车贷款,长期融资或相关的广告。</li></ul><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>如果返回值为空(`[]`),则表示该分类没有支持的特殊广告分类。</li></ul>|
##|placements |string[]| 该兴趣分类可用版位。返回空列表代表无限制。枚举值详见[枚举值-版位](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)|
|request_id |string|请求的日志ID,唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "202206302233010102452460660B5E36E5",
"data": {
"interest_categories": [
{
"special_industries": [
"HOUSING",
"EMPLOYMENT",
"CREDIT"
],
"placements": [],
"interest_category_id": "10",
"level": 1,
"interest_category_name": "Education",
"sub_category_ids": [
"10100",
"10101",
"10102",
"10103",
"10104",
"10105",
"10106"
]
},
{
"special_industries": [
"HOUSING",
"EMPLOYMENT",
"CREDIT"
],
"placements": [],
"interest_category_id": "11",
"level": 1,
"interest_category_name": "Vehicles & Transportation",
"sub_category_ids": [
"11100",
"11101",
"11102",
"11103",
"11104",
"11105",
"11106",
"11107",
"11108",
"11109",
"11111",
"11112"
]
},
...
]
}
}
(/code);