获取商品库事件源诊断信息

您可以使用本接口获取与商品库绑定事件源的诊断信息。

使用前需知

确保您已通过/catalog/eventsource/bind/或在 TikTok 广告管理平台将事件源与商务中心中的商品库绑定。若想了解在 TikTok 广告管理平台将事件源与商品库绑定的步骤，请查看如何创建和管理目录 - 关联事件源。

若想确认商品库是否绑定了事件源，可使用 /catalog/eventsource_bind/get/。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/diagnostic/catalog/eventsource/issue/

方法 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/issue/?bc_id={{bc_id}}&catalog_id={{catalog_id}}&event_source_type=PIXEL&pixel_code={{pixel_code}}&event_type=VIEW_CONTENT&time_range=LAST_30_DAYS' \
--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[] | 诊断信息列表。 |
##| diagnostic_result | string | 诊断出的问题。<br><br>若未检测到问题，本字段的值将为`"No Issues Found"`。<br><br>示例：`"You have fewer View Content events than Add to Cart events." ` <br><br>若想了解可检测的问题，请查看<a href="#item-link-可检测的商品库事件源问题列表">可检测的商品库事件源问题列表</a>。 |
##| level | string | 问题级别。 <br><br>枚举值：<ul><li>`ERROR`：错误。此问题影响广告投放，请解决。</li><li> `WARNING`：提示。此问题可能会影响广告投放，请检查。</li><li>`INFO`：无问题。</li></ul>|
##| diagnostic_solution | string | 问题的推荐解决办法。<br><br>若未检测到问题，本字段将为空值。 |

可检测的商品库事件源问题列表

下表列出了可通过商品库事件源诊断功能诊断的问题。

| 问题<br>（<code>diagnostic_result</code>） {45%}| 级别<br>（<code>level</code>） {10%}  | 解决办法<br> （<code>diagnostic_solution</code>） {45%} |
|---|---|---|
| `No Issues Found. ` | `INFO` | |
| `Less than 80% of events received have content IDs that match the catalog's SKU IDs or item group ID. ` | `WARNING` | `Export content IDs that don't match the products in this catalog. ` |
| `You have fewer View Content events than Add to Cart events. ` | `WARNING` | `We expect the number of events received in the upper funnel to be higher than in the lower funnel. We suggest you double check your event source setup and make sure events are triggering correctly. ` |
| `You have fewer Add to Cart events than Purchase events. ` | `WARNING` | `We expect the number of events received in the upper funnel to be higher than in the lower funnel. We suggest you double check your event source setup and make sure events are triggering correctly. ` |
|`The total number of events received, with or without content ID matches, is less than 100k. ` | `ERROR` | `Make sure event sources are correctly installed and events can be triggered on your product page. ` |
| `Less than 90% of events received have content IDs. ` | `ERROR` | `Export events without a content ID. ` |
| `Less than 100k events were received with content IDs. ` | `ERROR` | `Export events without a content ID. ` |
| `Less than 100k events were received with content IDs that match the catalog's SKU IDs or item group IDs. `| `ERROR` | `Export content IDs that don't match the products in this catalog. `|

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "list": [
            {
                "diagnostic_result": "Less than 100k events were received with content IDs that match the catalog's SKU IDs or item group IDs.",
                "diagnostic_solution": "Export content IDs that don't match the products in this catalog.",
                "level": "ERROR"
            }
        ]
    }
}
(/code)