获取行为分类
您可以使用本接口获取行为分类的枚举值。
通过行为分类,广告主可以根据用户最近的应用内行为向用户推送相关联的广告内容。用户的应用内行为可分为两类,视频相关行为(例如浏览、评论或分享),以及创作者相关行为(关注或浏览创作者主页)。相应地,开发者调用/adgroup/create/时能够使用的action_scene为CREATOR_RELATED或VIDEO_RELATED(只能选一个)。
注意
推荐您使用兴趣和行为合并 API(/targeting/search/)搜索或列举和兴趣与行为相关的定向分类和话题标签。此接口可高效获取并整合必要的定向信息。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{17%}|v1.2{43%}|v1.3{40%}|
|---|---|---|
|接口路径|/v1.2/tools/action_category/|/v1.3/tool/action_category/|
|请求参数名称|industry_types|special_industries|
|请求参数类型 |advertiser_id: number|advertiser_id: string|
|返回参数名称|industry_types|special_industries|
|返回参数名称和类型|<ul><li>id(在action_categories对象中): number</li><li>children(在action_categories对象中): number[]|<ul><li>action_category_id: string</li><li>sub_category_ids: string[]|
|新增请求参数|/|language`|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/tool/action_category/
**方法** GET
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌,可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。 |
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主 ID。 |
|special_industries|string[]| 特殊广告分类。 <br><br> 枚举值:<ul><li>`HOUSING`:房地产,房屋保险,抵押贷款或相关的广告。</li><li>`EMPLOYMENT`:工作机会,实习机会,职业认证项目或相关的广告。</li><li>`CREDIT`:信用卡申请,汽车贷款,长期融资或相关的广告。</li></ul><p><span style="color:darkred"><b>注意</b></span>:<ul><li>本字段对于注册地为美国或加拿大的广告主已全量。若您是注册地非美国或加拿大的广告主且想在定向美国或加拿大的广告中使用特殊广告分类,您需申请额外的白名单。</li></ul> |
|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>
示例
(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "advertiser_id=ADVERTISER_ID" \
https://business-api.tiktok.com/open_api/v1.3/tool/action_category/
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码。完整返回码列表及描述,可查看[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097) 。 |
|message |string|返回信息。更多信息可见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|data |object|返回数据。 |
#|action_categories|object[]| 行为分类列表。 |
##|description|string| 行为描述。 |
##|action_category_id|string| 行为 ID。 |
##|level|number| 层级。 |
##|sub_category_ids|string[]| 子级行为ID分类。 |
##|name|string| 行为名称。 |
##|special_industries|string[]|特殊广告分类。<br><br>枚举值:<ul><li>`HOUSING`:房地产,房屋保险,抵押贷款或相关的广告。</li><li>`EMPLOYMENT`:工作机会,实习机会,职业认证项目或相关的广告。</li><li>`CREDIT`:信用卡申请,汽车贷款,长期融资或相关的广告。</li></ul><p><span style="color:darkred"><b>注意</b></span>:<ul><li>如果返回值为空(`[]`),则表示该分类没有支持的特殊广告分类。</li></ul> |
##|action_scene|string| 行为场景。<br><br>枚举值:`CREATOR_RELATED`, `VIDEO_RELATED`。|
|request_id |string|请求的日志id,唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "20220630215533010245242106175C5C29",
"data": {
"action_categories": [
{
"description": "TikTok users who have followed comedy creators.",
"sub_category_ids": [
"1001"
],
"special_industries": [
"HOUSING",
"EMPLOYMENT",
"CREDIT"
],
"action_scene": "CREATOR_RELATED",
"level": 1,
"name": "Comedy",
"action_category_id": "1"
},
{
"description": "TikTok users who have followed creators that post original performance or original narration content.",
"sub_category_ids": [
"2001"
],
"special_industries": [
"HOUSING",
"EMPLOYMENT",
"CREDIT"
],
"action_scene": "CREATOR_RELATED",
"level": 1,
"name": "Drama",
"action_category_id": "2"
},
...
]
}
}
(/code);