获取商品库事件趋势及匹配率
您可以使用本接口获取接收到的应用事件或 Pixel 事件的趋势，可应用于再营销的事件数量，以及商品库匹配率。
使用前需知
确保您已通过/catalog/eventsource/bind/或在 TikTok 广告管理平台将事件源与商务中心中的商品库绑定。若想了解在 TikTok 广告管理平台将事件源与商品库绑定的步骤，请查看如何创建和管理目录 - 关联事件源。
若想确认商品库是否绑定了事件源，可使用 /catalog/eventsource_bind/get/。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/diagnostic/catalog/eventsource/metric/
方法 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><br>若想获取商务中心下的商品库，可使用 [/catalog/get/](1740315452868610.html)。 |
| event_source_type {必填} | string | 事件源类型。<br><br>枚举值： <ul><li>`APP`: App。需同时传入参数 `app_id`。</li><li>`PIXEL`: Pixel。需同时传入参数 `pixel_code`。</li></ul> |
| app_id {+条件必填} | string | `event_source_type` 为 `APP` 时必填。<br><br>App ID。<br><br>若想获取与商品库（`catalog_id`）绑定的 App ID，可使用 [/catalog/eventsource_bind/get/](1740492531343362.html)。 |
| pixel_code {+条件必填} | string | `event_source_type` 为 `PIXEL` 时必填。<br><br> Pixel 代码。 <br><br>若想获取与商品库（`catalog_id`）绑定的 Pixel 代码，可使用 [/catalog/eventsource_bind/get/](1740492531343362.html)。 |
| event_type | string | 您想要获取对应数据的事件类型。<br><br>枚举值：<ul><li>`VIEW_CONTENT`：查看详情。</li><li>`ADD_TO_CART`：加入购物车。</li><li> `PURCHASE`：支付完成。</li></ul><br>默认值： `VIEW_CONTENT`。 |
| time_range | string | 您想要获取对应数据的时间范围。 <br><br>枚举值：<ul><li> `YESTERDAY`：近1天。</li><li> `LAST_7_DAYS`：近7天。</li><li> `LAST_30_DAYS`：近30天。</li></ul><br>默认值：`LAST_7_DAYS`。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/diagnostic/catalog/eventsource/metric/?bc_id={{bc_id}}&catalog_id={{catalog_id}}&event_source_type=PIXEL&pixel_code={{pixel_code}}&time_range=LAST_7_DAYS&event_type=PURCHASE' \
--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| 返回数据。 |
#| list | object[] | 接收到的事件的趋势及可用于在营销的事件数量。 |
##| available_type | string | 事件类别。<br><br>枚举值：<ul><li>`EVENT_RECEIVED`：所有事件。</li><li>`EVENT_WITH_CONTENT_ID`：带有内容 ID（content ID）的事件。</li><li> `EVENT_WITH_CONTENT_ID_MATCHING_INVENTORY`：内容 ID 能匹配库存的事件。</li></ul> |
##| event_details | object[] | 事件类别（`available_type`）的详情。 |
###| date | string | 日期，格式为`"YYYY-MM-DD"`。<br><br>示例： `"2023-12-30"`。 |
###| count | string | 在该日期接收到的属于此事件类别的事件数量。 <br><br>示例： `"245076"`。 <br><br>例如， `available_type` 为 `EVENT_WITH_CONTENT_ID_MATCHING_INVENTORY` 时，本字段的值为`"245076"`代表当日收到了 245,076 个内容 ID 与您的商品库中的商品（SKU ID）匹配的事件。 |
###| percentage | string | 当日收到的属于此事件类别的事件数量占当日收到的总事件数量的百分比。 <br><br> `available_type` 为 `EVENT_WITH_CONTENT_ID_MATCHING_INVENTORY` 时，本字段的值代表商品库匹配率。匹配率的计算方法是：与商品库中的商品匹配的信号事件数除以与 TikTok 共享的信号事件总数。<br>我们建议您将匹配率保持在 90% 以上，以确保视频购物广告获得理想的投放效果。<br><br>示例：`"100"`。 <br><br><p><span style="color:darkred"><b>注意</b></span>：`available_type` 为 `EVENT_RECEIVED` 时，本字段的值始终为`"100"`。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"list": [
{
"available_type": "EVENT_RECEIVED",
"event_details": [
{
"date": "2023-10-04",
"percentage": "100",
"count": "4086"
},
{
"date": "2023-10-05",
"percentage": "100",
"count": "4372"
},
{
"date": "2023-10-06",
"percentage": "100",
"count": "3939"
},
{
"date": "2023-10-07",
"percentage": "100",
"count": "3017"
},
{
"date": "2023-10-08",
"percentage": "100",
"count": "2853"
},
{
"date": "2023-10-09",
"percentage": "100",
"count": "5197"
},
{
"date": "2023-10-10",
"percentage": "100",
"count": "5050"
}
]
},
{
"available_type": "EVENT_WITH_CONTENT_ID",
"event_details": [
{
"date": "2023-10-04",
"percentage": "96",
"count": "3960"
},
{
"date": "2023-10-05",
"percentage": "97",
"count": "4259"
},
{
"date": "2023-10-06",
"percentage": "97",
"count": "3847"
},
{
"date": "2023-10-07",
"percentage": "96",
"count": "2899"
},
{
"date": "2023-10-08",
"percentage": "95",
"count": "2728"
},
{
"date": "2023-10-09",
"percentage": "96",
"count": "5035"
},
{
"date": "2023-10-10",
"percentage": "97",
"count": "4908"
}
]
},
{
"available_type": "EVENT_WITH_CONTENT_ID_MATCHING_INVENTORY",
"event_details": [
{
"date": "2023-10-04",
"percentage": "37",
"count": "1535"
},
{
"date": "2023-10-05",
"percentage": "35",
"count": "1572"
},
{
"date": "2023-10-06",
"percentage": "36",
"count": "1450"
},
{
"date": "2023-10-07",
"percentage": "33",
"count": "1019"
},
{
"date": "2023-10-08",
"percentage": "28",
"count": "819"
},
{
"date": "2023-10-09",
"percentage": "37",
"count": "1946"
},
{
"date": "2023-10-10",
"percentage": "36",
"count": "1867"
}
]
}
]
}
}
(/code)