使用应用事件的有效负载助手

本文将指导您使用应用事件的有效负载助手，从而构建通过事件 API 2.0 报告应用事件的有效负载。

简介

应用事件的有效负载助手是由 TikTok API for Business 提供的用户界面，旨在简化事件 API 2.0 报告应用事件的有效负载构建过程。此工具确保事件数据在发送给 TikTok 之前，已包含所有必需的字段，还支持生成 cURL、Python 和 Node.js 格式的代码示例。

前提条件

在使用应用事件的有效负载助手之前，请先阅读应用事件设置指南，了解使用事件 API 2.0 回传应用事件的可用参数。

步骤

访问有效负载助手

直接导航至有效负载助手。该工具需要几秒钟时间加载，无需登录。

使用有效负载助手

1. 将事件类型设置为应用

若想使用应用事件相关字段，将事件类型设置（event_source）为 app。默认情况下，event_source 设置为 web，其他字段留空。您需要填写其他必填字段，以创建完整有效的负载。

2. 输入事件数据

输入以下三个必填的事件数据字段： - event_source_id：输入 TikTok 应用 ID。 - 若要获取 TikTok 应用 ID，请参阅生成您的 TikTok 应用 ID。 - event：从下拉菜单中选择一个标准事件名称，或通过输入自定义名称指定一个自定义事件。 - event_time：输入事件的 UTC+0 时间，格式为以秒为单位的 Unix 时间戳。例如：1723455457。

3. 添加应用数据

您的应用 ID 需采用 App Store 或 Play Store URL 中常用的反向 DNS 格式（Android）或短数字字符串（iOS）格式。

4. 添加用户数据

至少输入以下字段之一：idfa 和 gaid。

您还可输入其他可选字段，包括 email、 phone 和 external_id。

点击 UI 中的散列按钮，对数据进行 SHA-256 散列处理，保护用户隐私。例如，您可以将邮箱地址 example_user@example.com 散列处理为 c6239ca1f8fe9b3d73e1352629e55c3ff0c587c8897903463247fe6ce6ef747d。

您还可根据需要添加其他用户参数：ip、user_agent 和 att_status。

5. （可选）添加属性数据

从下拉菜单中选择 currency 和 content_type 值。

您还可根据需要添加其他属性参数：contents、value、query 和 description。

需注意，若您指定了 content_type，推荐您同时在 contents 中按以下规则指定 content_id： - 若 content_type 设置为 product，将 content_id 指定为您的商品库中的一个商品 SKU ID（sku_id）。 - 若 content_type 设置为 product_group，将 content_id 指定为您的商品库中的一个商品 SPU ID（item_group_id）

6. 生成代码示例

填写所有必要信息后，您可以看到自动生成的 JSON 对象。通过点击生成代码，您可以生成 cURL、Python 或 Node.js 格式的代码示例。

在代码示例中将占位符值 <<ACCESS TOKEN>> 替换为您的实际访问令牌以进行测试。