ステータスエンドポイント

/statusエンドポイントを使用してバックグラウンドジョブの進行状況をトラッキングします。アプリを作成またはアップデートすると、設定の移行がバックグラウンドジョブとして実行されます。APIが返すticket_tokenは、ジョブのステータスを確認するために使用できます。

チケットのステータスを取得する

チケットトークンを使用して、バックグラウンドジョブの現在のステータスを取得します。

APIプロトコル

エンドポイント： https://automate.adjust.com/app-automation/status/{ticket_token}

メソッド： GET

レスポンス ：チケットステータスのレスポンス

パラメーター

パラメーター	データタイプ	入力する値	必須	説明
`ticket_token`	`String`	パス	はい	以前のAPIによる処理（アプリの作成やアップデートなど）によって返されたチケットトークン。

例

curl --location 'https://automate.adjust.com/app-automation/status/e5b07bb3-b5f3-40a8-8a2d-197d30b6beff' \
--header 'Authorization: Bearer {your-adjust-api-token}'

{
   "status": "completed",
   "kind": "migration",
   "result": {
      "events": {
         "successes": ["purchase", "registration", "level_complete"],
         "failures": []
      },
      "partners": {
         "successes": ["facebook", "google", "applovin"],
         "failures": []
      },
      "trackers": {
         "successes": ["facebook_installs", "google_installs"],
         "failures": []
      }
   }
}

{
   "status": "opened",
   "kind": "migration",
   "result": {
      "events": {
         "successes": ["purchase"],
         "failures": []
      }
   }
}

{
   "status": "failed",
   "kind": "migration",
   "result": {
      "events": {
         "successes": ["purchase"],
         "failures": []
      },
      "partners": {
         "section": "partners",
         "detail": "Could not be started because events section has failed"
      }
   }
}

ステータスの値

ステータス	説明
`new`	ジョブが作成されましたが、まだ処理が開始されていません。
`opened`	ジョブは現在処理中です。
`completed`	ジョブが正常に完了しました。詳細については、`result`フィールドを確認してください。
`failed`	ジョブが失敗しました。`result`フィールドでエラーの詳細を確認してください。

ジョブのタイプ

kindフィールドでは、チケットがトラッキングしている処理のタイプを確認できます。

タイプ	説明
`migration`	テンプレートアプリの移行（テンプレートからターゲットアプリへ設定をコピー）
`update_app`	アプリ設定の更新（アプリ名、ストアID、バンドルIDの変更）
`create_signature`	SDKシグネチャーの生成
`event_partial_update`	イベントの作成または更新
`partner_partial_update`	パートナー設定の更新
`tracker_partial_update`	トラッカー設定の更新
`callback_partial_update`	コールバックURLの更新

結果を確認する

resultオブジェクトには、ジョブの中で成功した処理と失敗した処理に関する情報が含まれています。形式はジョブのタイプにより異なります。

移行結果

migrationのジョブの結果には、処理された各アプリセクションのステータスが含まれます。

{
   "result": {
      "events": {
         "successes": ["event_name_1", "event_name_2"],
         "failures": []
      },
      "partners": {
         "successes": ["facebook", "google"],
         "failures": ["snapchat"]
      },
      "trackers": {
         "successes": [],
         "failures": [],
         "skipped": "Partner facebook not configured in target app"
      }
   }
}

部分更新の結果

一部が更新されたジョブの場合、結果には、正常に更新された処理と失敗した処理が表示されます。

{
   "result": {
      "successes": [{ "app_token": "abc123", "name": "purchase" }],
      "failures": [
         {
            "app_token": "xyz789",
            "name": "invalid_event",
            "detail": "Event not found"
         }
      ]
   }
}

ステータスのポーリング

ジョブの完了を待つ間に、適切な間隔でステータスエンドポイントをポーリングすることをお勧めします。

チケットトークンを受け取った後、最初のステータスチェックを行う前に2～3秒待機します。
ステータスがcompletedまたはfailedになるまで、5～10秒ごとにポーリングを行います。
ポーリングを期間を無制限にすることを避けるため、最大タイムアウト（5分など）を設定します。

データモデル

チケットステータスのレスポンス

パラメーター	データタイプ	説明
`status`*	`String`	ジョブの現在のステータス。`new`、`opened`、`completed`、`failed` のいずれか。
`kind`*	`String`	ジョブのタイプ。`migration`、`update_app`、`create_signature`、`event_partial_update`、`partner_partial_update`、`tracker_partial_update`、`callback_partial_update`のいずれか。
`result`*	`Object`	処理したジョブの成功と失敗に関する情報。形式はジョブのタイプによって異なります。