事件终端

使用 /events 终端，在单个请求中为一个或多个应用创建或更新事件，以便保持多个应用中的事件定义一致。

创建或更新事件

为一个或多个应用创建新事件或更新现有事件。API 会按名称匹配事件。如果存在同名事件，则会进行更新。

API 协议

终端： https://automate.adjust.com/app-automation/events

方法： POST

请求正文： 事件请求负载

响应： 事件结果

参数

参数	数据类型	必要参数	描述
`app_tokens`	`Array[String]`	是	要为之创建/更新事件的应用识别码列表。
`events`	`Array[Object]`	是	事件定义列表。请参阅事件对象。

事件对象

参数	数据类型	必要参数	描述
`name`	`String`	是	事件名称。用作为唯一标识符。
`unique`	`Boolean`	否	是否将事件视为每用户唯一事件。默认为 `false`。

示例

为多个应用创建事件

curl --location 'https://automate.adjust.com/app-automation/events' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "app_tokens": ["abc123xyz", "def456uvw", "ghi789rst"],
    "events": [
        { "name": "purchase", "unique": false },
        { "name": "registration", "unique": true },
        { "name": "level_complete", "unique": false },
        { "name": "add_to_cart", "unique": false }
    ]
}'

{
   "successes": [
      {
         "app_token": "abc123xyz",
         "event": {
            "id": 12345,
            "name": "purchase",
            "token": "abc1de",
            "unique": false,
            "autogenerated": false,
            "archived": false
         }
      },
      {
         "app_token": "abc123xyz",
         "event": {
            "id": 12346,
            "name": "registration",
            "token": "fgh2ij",
            "unique": true,
            "autogenerated": false,
            "archived": false
         }
      },
      {
         "app_token": "def456uvw",
         "event": {
            "id": 12347,
            "name": "purchase",
            "token": "klm3no",
            "unique": false,
            "autogenerated": false,
            "archived": false
         }
      }
   ],
   "failures": [
      {
         "app_token": "ghi789rst",
         "name": "purchase",
         "details": "App not found"
      }
   ]
}

创建单个事件

curl --location 'https://automate.adjust.com/app-automation/events' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "app_tokens": ["abc123xyz"],
    "events": [
        { "name": "tutorial_complete", "unique": true }
    ]
}'

{
   "successes": [
      {
         "app_token": "abc123xyz",
         "event": {
            "id": 12348,
            "name": "tutorial_complete",
            "token": "pqr4st",
            "unique": true,
            "autogenerated": false,
            "archived": false
         }
      }
   ],
   "failures": []
}

理解事件识别码

创建事件时，Adjust 会生成一个唯一事件识别码。从 Adjust SDK 发送事件时会用到此识别码：

事件名称： 您定义的人类可读标识符 (例如 purchase)
事件识别码：由系统生成的标识符，用于 SDK 调用 (例如 abc1de)

唯一事件

如果每个事件仅针对每位用户记录一次，那么应当设置为 unique: true。该设置适合下列事件：

首次购买
注册
首次应用启动
开始订阅

对于每位用户可多次触发的事件 (如完成关卡或应用内购买)，请设置 unique: false。

错误处理

API 会独立处理每个应用的事件。即便某个应用的事件失败，其他应用也不会受到影响。请检查响应中的 successes 和 failures 数组。

常见失败原因：

原因	描述
App not found	应用识别码不存在，或您没有访问权限。
事件名称无效	事件名称包含无效字符或太长。
重复事件	同名事件已存在 (这并非错误—事件将被更新)。

数据模型

事件请求负载

参数	数据类型	描述
`app_tokens`*	`Array[String]`	要为之创建/更新事件的 Adjust 应用识别码列表。
`events`*	`Array[Object]`	事件定义列表。

事件定义

参数	数据类型	描述
`name`*	`String`	事件名称。
`unique`	`Boolean`	事件是否对于每个用户唯一。默认为 `false`。

事件结果

参数	数据类型	描述
`successes`	`Array[Object]`	已成功创建/更新的事件列表。
`failures`	`Array[Object]`	失败事件作业列表。

事件成功

参数	数据类型	描述
`app_token`*	`String`	事件所属的应用识别码。
`event`*	`Object`	已创建/更新的事件详情。

事件详情

参数	数据类型	描述
`id`*	`Integer`	内部事件 ID。
`name`*	`String`	事件名称。
`token`*	`String`	SDK 集成事件识别码。
`unique`*	`Boolean`	事件是否对于每个用户唯一。
`autogenerated`	`Boolean`	事件是否为自动生成。默认为 `false`。
`archived`	`Boolean`	链接是否已被归档。默认为 `false`。
`callback_url`	`String`	该事件的回传 URL。

事件失败

参数	数据类型	描述
`app_token`*	`String`	作业失败的应用识别码。
`name`*	`String`	失败的事件名称。
`details`*	`String`	错误原因描述。