获取热门商品类目列表
您可以使用本接口获取您的电商商品库中与基于 TikTok 用户互动数据的前 50 个热门商品类目相匹配的商品数量,以及这些商品的可售库存百分比。
注意
- 商品库分析数据在您向电商商品库上传至少 20 个商品的 24 小时后生成。
- 商品库分析数据在每日 UTC 时间上午约 4 点刷新。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/catalog/insight/category/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| bc_id {必填} | string | 商务中心 ID。 <br><br>若想获取您有权访问的商务中心列表,可使用[/bc/get/](1737115687501826.html)。 |
| catalog_id {必填}| string | 商品库 ID。 <br> 需指定一个包含至少 20 个商品的电商商品库。 <br> <br>若想获取某个商务中心中的电商商品库列表,可使用 [/catalog/get/](1740315452868610.html),筛选对应的 `catalog_type` 为 `ECOM` 的 `catalog_id` 值。 若想验证商品库中包含的商品至少为 20 个,可使用 [/catalog/overview/](1740492470201345.html),查看返回的字段 `approved`,`rejected` 和 `processing` 的值之和是否大于等于 20。 |
| filtering | object | 筛选条件。 |
#| category_ids {+条件必填} | string[] | 若传入了 `filtering`,则本字段必填。<br> <br>TikTok 商品类目 ID 列表,可用于筛选分析数据。<br><br>最大数量:50。<br> <br> 若想获取经过筛选的洞察数据,可先调用一次 `/catalog/insight/filter/get/` 获取 TikTok 的前 50 个热门商品类目,随后在返回中筛选 `category_id` 字段值传入本字段。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/catalog/insight/category/get/?bc_id={{bc_id}}&catalog_id={{catalog_id}}' \
--header 'Access-Token: {{Access-Token}}' \
(/code)
返回
|字段{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| 返回数据。 |
#| category_insights | object[] | TikTok 的前 50 个热门商品类目,列表按热门程度倒序排列。<br><br>例如,列表中第一个商品类目排名第 1,即最热门的商品类目,第二个商品类目排名第 2,即第二热门的商品类目。 |
##| category_id | string | 商品的 TikTok 商品类目 ID,由三个类目层级及 # 号分隔符构成,格式为"第一层级的 ID#第二层级的 ID#第三层级的 ID"。 <br><br>示例:`601152#842248#601302`。 |
##| level_info | object | 类目所属层级的详情。 |
###| level_id_1 | string | TikTok 商品类目第一层级的 ID。 |
###| level_name_1 | string | TikTok 商品类目第一层级的名称。 |
###| level_id_2 | string | TikTok 商品类目第二层级的 ID。 |
###| level_name_3 | string | TikTok 商品类目第二层级的名称。 |
###| level_id_3 | string | TikTok 商品类目第三层级的 ID。 |
###| level_name_3 | string | TikTok 商品类目第三层级的名称。 |
##| total_product_count | integer | 商品库(`catalog_id`)中与该商品类目(`category_id`)匹配的商品数量。 |
##| product_availability_rate | float | 商品库中与该类目匹配的商品的可售库存百分比。 <br><br>若本字段值过低,您可使用 [/catalog/product/update/](1740562287852546.html) 将相关商品的 `availability` 更新为 `IN_STOCK`。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"category_insights": [
{
"category_id": "601352#900488#900872",
"level_info": {
"level_id_1": "601352",
"level_id_2": "900488",
"level_id_3": "900872",
"level_name_1": "Shoes",
"level_name_2": "Women's Shoes",
"level_name_3": "Trainers"
},
"product_availability_rate": 0.6666666666666667,
"total_product_count": 3
},
...
{
"category_id": "605248#905608#605268",
"level_info": {
"level_id_1": "605248",
"level_id_2": "905608",
"level_id_3": "605268",
"level_name_1": "Fashion Accessories",
"level_name_2": "Jewellery & Accessories",
"level_name_3": "Earrings"
},
"product_availability_rate": 0.375,
"total_product_count": 8
}
]
}
}
(/code)