快速入门

本指南介绍了设置线下事件API的详细流程。

1. OAuth授权和生成访问令牌

您可以通过以下两种方法获得访问令牌： - 使用OAuth 2.0 API - 使用TikTok事件管理平台（TTEM）用户界面手动生成令牌

使用OAuth2.0 API

在应用管理下为开发者应用开启“Offline Events Management”权限。
请按照获取访问令牌中的步骤，在开发者应用获得授权后使用API生成访问令牌。

使用事件管理平台

广告主登录TikTok广告管理平台，点击资产 > 事件 > 线下，创建一个线下事件组，并与合作伙伴分享线下事件组ID。

广告主在线下事件组 > 设置下生成访问令牌，并向合作伙伴/开发者提供线下事件发布的访问和权限。

2. 使用其他方法创建线下事件组

您可以使用/v1.3/offline/create/创建一个线下事件组。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/offline/create/

方法 POST

Request Header

|字段|类型|描述|
|---|---|---|
|Content-Type {必填}|string|请求信息类型。<br>允许格式：`application/json`。|
|Access-Token {必填}|string|授权访问令牌。了解如何获取访问令牌，请参考上方的“OAuth授权和生成访问令牌”小节。

参数

|字段|类型|描述|
|---|---|---|---|
|advertiser_id {必填}|string|广告主ID。|
|name{必填}|string|线下事件组名称。示例：in_store_purchases。
|description|string|线下事件组描述。示例：in_store_purchases_blackfriday。
|auto_tracking|boolean|是否开启自动监测。如果本字段设置为`true`，今后在本广告主账户下新建的所有推广系列都会将该事件组用于广告监测和归因。枚举值：`true`，`false`。

示例

注意
您需要将示例中的虚拟数据替换为自己的数据。

(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/offline/create/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "advertiser_id": "123456", 
  "name": "EVENT_SET_NAME", 
  "description": "In_store_purchases_blackfriday_2021",
  "auto_tracking": true
}
'
(/code)

|字段|类型|描述|
|---|---|---|---|
|event_set_id |string|您刚创建的事件组的ID。|

示例

(code)
HTTPS/1.1 200 OK
{
    "event_set_id": "{{event_set_id}}"
}
(/code)

3. 在线下事件组中上传线下事件

线下事件组创建完成后，您需在事件组中上传线下事件，即顾客在线下达成某一业务目标的行为。支持线下事件的单个上传及批量上传。

欲了解支持的线下事件和参数，请参见报告线下事件和参数。

请注意，您还可以在事件管理平台通过文件向线下事件事件组中上传线下事件。

4. 管理线下事件组（可选）

您可通过以下方式管理线下事件组： - 使用/offline/update/更新线下事件组的名称或自动监测设置。 - 使用/offline/delete/删除线下事件组。 - 使用/offline/get/获取广告账户下的线下事件组列表。

5. 在普通广告或程序化创意广告中追踪线下事件组

在广告中追踪线下事件组，需在调用/ad/create/或/ad/aco/create/时指定tracking_offline_event_set_ids参数。您需注意单个广告中最多传入50个线下事件组，其中最多包含10个开启自动监测的线下事件组。