获取商品库分析数据的筛选条件

您可以使用本接口获取商品库分析数据的可用筛选条件，这些条件可筛选电商商品库中的商品，生成更具针对性的分析数据。

返回的筛选值可与 /catalog/insight/product/get/ 结合使用，以获取商品库中热门商品的分析数据。

注意

商品库分析数据在您向电商商品库上传至少 20 个商品的 24 小时后生成。
商品库分析数据在每日 UTC 时间上午约 4 点刷新。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/catalog/insight/filter/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` 值。 <br>若想验证商品库中包含的商品至少为 20 个，可使用 [/catalog/overview/](1740492470201345.html)，查看返回的字段 `approved`，`rejected` 和 `processing` 的值之和是否大于等于 20。 |
| filter_type {必填} | string | 筛选条件的类型。 <br><br>枚举值： <ul><li> `CATEGORY_ID`：商品类目 ID。</li><li> `BRAND`：商品品牌名称。</li><li>`AVAILABILITY`：商品库存状态。</li></ul>|
| page | integer | 当前页数。<br><br> 默认值: 1。取值范围: ≥ 1。 |
| page_size | integer | 分页大小。 <br><br> 默认值: 10。取值范围：1-200。 <br><br><p><span style="color:darkred"><b>注意</b></span>：您可根据自身需要决定是否使用 `page` 和 `page_size` 字段分批次获取分页结果。不过，需注意返回中不包含分页信息。 <br>若您不想获取分页结果，可将 `page_size` 设置为 50，从而在单个返回中获取完整结果。 |

示例

(code curl http)
curl --location  --request GET 'https://business-api.tiktok.com/open_api/v1.3/catalog/insight/filter/get/?bc_id={{bc_id}}&catalog_id={{catalog_id}}&filter_type=AVAILABILITY&page=1&page_size=200' \
--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| 返回数据。 |
#| brands | string[] | 仅当请求中的 `filter_type` 设置为 `BRAND` 时返回本字段。 <br><br> 可用于筛选该商品库中商品的品牌名称列表。 |
#| availabilities | string[] | 仅当请求中的 `filter_type` 设置为  `AVAILABILITY` 时返回本字段。<br><br>  可用于筛选该商品库中商品的库存状态列表。 |
#| categories | object[] | 仅当请求中的 `filter_type` 设置为 `CATEGORY_ID` 时返回本字段。<br><br> 可用于筛选该商品库中商品的商品类目有关信息。 |
##| 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_2 | string | TikTok 商品类目第二层级的名称。 |
###| level_id_3 | string | TikTok 商品类目第三层级的 ID。 |
###| level_name_3 | string | TikTok 商品类目第三层级的名称。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "availabilities": [
            "OUT_OF_STOCK",
            "IN_STOCK"
        ]
    }
}
(/code)