イベントエンドポイント

/eventsエンドポイントを使用して、単一のリクエストで1つまたは複数のアプリのイベントを作成または更新します。これは、複数のアプリで一貫したイベント定義を維持する場合に役立ちます。

イベントを作成または更新する

1つまたは複数のアプリの新しいイベントを作成するか、既存のイベントを更新します。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）

一意のイベント

ユーザーあたりの1回のみ発生するイベントの場合、unique: trueと設定します。これは、以下のようなイベントに役立ちます。

初回購入
登録
アプリの初回起動
サブスクリプション開始（Subscription start）

ユーザーごとに複数回発生する可能性のあるイベント（レベル完了やアプリ内購入など）については、unique: falseと設定します。

エラー処理

APIは各アプリのイベントを個別に処理します。1つのアプリで1つのイベントが失敗しても、他のアプリに影響はありません。レスポンス内で、successesとfailuresの両方の配列を確認してください。

一般的な失敗の原因：

理由	説明
アプリが見つからない（App not found）	アプリトークンが存在しないか、アクセス権限がありません。
イベント名が不正（Event name invalid）	イベント名に無効な文字が含まれているか、名前が長すぎます。
重複イベント（Duplicate event）	同じ名前のイベントがすでに存在します（これはエラーではなく、同名の既存イベントが更新されます）。

データモデル

イベントリクエストのペイロード

パラメーター	データタイプ	説明
`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`	失敗に関する説明。