アプリエンドポイント

/appエンドポイントを使用して、新しいアプリを作成し、既存のアプリを更新し、アプリ情報を取得します。これは、アプリ管理を大規模に自動化するための主要エンドポイントです。

取得操作（トークンによるアプリの取得、ストアIDによるアプリの取得、全てのアプリの一覧表示）は、 このAPIで作成または更新されたアプリ のみを返します。アカウント内のすべてのアプリ（ダッシュボードで作成されたものを含む）を対象とするには、アプリ設定エンドポイントを使用します。

テンプレートを使用してアプリを作成または更新する

このエンドポイントは、テンプレートアプリの設定を使用して新しいアプリを作成するか、既存のアプリを更新します。これは、アプリ設定を自動化するための主要エントリーポイントです。

仕組み

APIはstore_idとplatformに一致する既存のアプリを検索します。
アプリが存在しない場合、指定された詳細情報を使用して新しいアプリが作成されます。
テンプレートアプリから設定をコピーするバックグラウンドジョブがキューに入れられます。
レスポンスには、移行の進捗を計測するためのticket_tokenが含まれています。

バックグラウンドジョブは、次のいずれかの条件が満たされたときにトリガーされます。

アプリが新しく作成された
channel_setup、override_settings、editors、またはios_pv_shared_secretsフィールドが更新された
force_update が次に設定された： true

APIプロトコル

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

メソッド： POST

リクエストボディ： アプリペイロードの作成/更新

レスポンス: アプリの移行レスポンス

パラメーター

パラメーター	データタイプ	必須	説明
`store_id`	`String`	はい	iOSアプリ：iTunes Store ID（数字）。 Androidアプリ：バンドルID（例：`com.example.app`）
`platform`	`String`	はい	ターゲットプラットフォーム。次のいずれかを使用：`android`または`ios`
`bundle_id`	`String`	はい	アプリのバンドルID（例：`com.example.app`）
`name`	`String`	はい	アプリの表示名
`template_app_token`	`String`	いいえ	設定のコピー元のアプリトークン。指定されていない場合、アカウントで設定されたトークンが使用されます。
`sections`	`Array[String]`	いいえ	移行対象のアプリセクションのリスト空の場合、すべてのセクションが移行されます。
`force_update`	`Boolean`	いいえ	`true`に設定すると、アプリが変更されなくても移行ジョブを強制的に実行。デフォルトは`false`です。
`channel_setup`	`Object`	いいえ	パートナー固有の構成。詳細はチャネル設定を参照してください。
`override_settings`	`Object`	いいえ	テンプレートアプリからオーバーライドする設定。詳細については、オーバーライド設定をご覧ください。
`editors`	`Array[String]`	いいえ	アプリへのアクセス権が付与されたカスタムユーザーのメールアドレス。管理者、編集者、閲覧者ロールのユーザーは自動的にアクセス権が付与されます。
`ios_pv_shared_secret`	`String`	いいえ	このアプリのiOS購入認証用共有シークレット
`verification`	`Boolean`	いいえ	iOSアプリを認証するには、`true`に設定します。アカウントで認証が有効になっているiOSアプリにのみ適用されます。デフォルトは`false`です。

セクション

sectionsパラメーターを使用して、特定の設定のみを移行します。

1
{
2
   "sections": ["partners", "events", "fraud_prevention_settings"]
3
}

利用可能なセクションについては、アプリのセクションのリストでご確認ください。

オーバーライド設定

テンプレートアプリの値を使用する代わりに、アプリの特定の設定をカスタマイズするには、override_settingsを使用します。オーバーライド設定は保存され、その後の移行において自動的に適用されます。

上書き設定で実行できる操作は3つあります。

操作	方法
表示	`GET /app/{app_token}/settings`を使用して現在のアプリ設定を表示します。`additional_info.overrides`に保存された上書きペイロードを表示するには、`GET /app/{app_token}`を使用します。
作成 / 更新	`override_settings`を`POST /app`または`POST /app/{app_token}`に送信します。新しい値は保存された上書きにマージされるため、変更したいフィールドのみを送信できます。
消去	`POST /app/{app_token}`を`"override_settings": null`で呼び出し、アプリの保存された上書きを全て削除します。

partners を上書きする場合：

GET /app/{app_token}/settingsのpartners配列型を使用します。
パートナーは name によってマッチングされます。
サポートされている転送フラグ： revenue_forwarding、session_forwarding、parameter_forwarding、cost_forwarding、attributed_only、 uninstall_forwarding、 ad_revenue_forwarding、 limited_data_use、 inactive_user_definition
channel_setup パートナー固有のフィールドのフラットキーと値のマップ。パートナーがサポートしていないキーは、ダッシュボードAPIから無視される場合があります。
events_linking アプリイベント名からパートナーイベント名へのマップ。
app_info は読み取り専用セクションであり、override_settingsではサポートされていません。
channel_setup リクエストレベルのchannel_setupフィールドの値が最も優先されます。
リクエストレベルのchannel_setupにキーがない場合、App Automationは保存されたアプリのchannel_setupにフォールバックします。
override_settings.partners[].channel_setup は追加のフォールバックソースとして使用されます。

{
   "override_settings": {
      "partners": [
         {
            "name": "facebook",
            "revenue_forwarding": false,
            "session_forwarding": false,
            "parameter_forwarding": false,
            "cost_forwarding": false,
            "attributed_only": false,
            "uninstall_forwarding": false,
            "ad_revenue_forwarding": false,
            "limited_data_use": true,
            "inactive_user_definition": false,
            "channel_setup": {
               "app_id": "651107451918933"
            },
            "events_linking": {
               "purchase_inapp": "fb_mobile_purchase"
            }
         },
         {
            "name": "snapchat",
            "limited_data_use": false,
            "channel_setup": {
               "app_id": "1404426295"
            }
         }
      ]
   }
}

例

新しいAndroidアプリを作成

curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My Android App",
    "bundle_id": "com.example.myapp",
    "store_id": "com.example.myapp",
    "platform": "android"
}'

{
   "adjust_app_token": "abc123xyz",
   "name": "My Android App",
   "bundle_id": "com.example.myapp",
   "store_id": "com.example.myapp",
   "ticket_token": "e5b07bb3-b5f3-40a8-8a2d-197d30b6beff",
   "sk_app_id": null
}

チャネル設定を含むiOSアプリを作成

curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My iOS App",
    "bundle_id": "com.example.myiosapp",
    "store_id": "123456789",
    "platform": "ios",
    "channel_setup": {
        "facebook": { "app_id": "987654321" },
        "google": { "link_id": "google_link_123" }
    }
}'

{
   "adjust_app_token": "xyz789abc",
   "name": "My iOS App",
   "bundle_id": "com.example.myiosapp",
   "store_id": "123456789",
   "ticket_token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   "sk_app_id": "86372991152"
}

特定のセクションのみを移行

curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My App",
    "bundle_id": "com.example.app",
    "store_id": "com.example.app",
    "platform": "android",
    "sections": ["events", "partners", "callbacks"]
}'

既存のアプリを強制アップデート

curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My App",
    "bundle_id": "com.example.app",
    "store_id": "com.example.app",
    "platform": "android",
    "force_update": true
}'

SDKシグネチャーの設定

Adjustシグネチャーライブラリを使用してAndroidアプリのトラフィックを保護する場合、アプリオートメーションAPIを使用してシグネチャー認証を実施し、アプリの証明書フィンガープリント（android_signature_hash）を管理できます。

仕組み

シグネチャーの設定は、テンプレートアプリメソッドで処理されます。

すべての有効な証明書フィンガープリント（android_signature_hash）が、テンプレートアプリからターゲットアプリにコピーされます。
テンプレートアプリから、enforce_signature設定も適用されます。
アカウントマネージャーの対応は不要で、すぐに利用可能です。

テンプレートアプリに証明書フィンガープリントを追加して、シグネチャー認証を有効にする手順については、SDKシグネチャー設定ガイドを参照してください。

オーバーライドシグネチャー設定

override_settingsフィールドを使用して、android_signature_hashかenforce_signature、またはその両方をターゲットアプリにオーバーライドできます。

Androidのシグネチャーハッシュのみをオーバーライドするには、override_settingsにandroid_signature_hashを指定してください。
有効化設定のみをオーバーライドするには、override_settingsにenforce_signatureを指定してください。
両方をオーバーライドするには、両方のフィールドをoverride_settingsに含めてください。

例

テンプレートアプリからシグネチャーを移行

curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My Android App",
    "bundle_id": "com.example.myapp",
    "store_id": "com.example.myapp",
    "platform": "android",
    "sections": ["signature"],
    "force_update": true
}'

android_signature_hashのみをオーバーライド

curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My Android App",
    "bundle_id": "com.example.myapp",
    "store_id": "com.example.myapp",
    "platform": "android",
    "sections": ["signature"],
    "override_settings": {
        "signature": {
            "android_signature_hash": [
                "AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AB"
            ]
        }
    }
}'

enforce_signatureのみをオーバーライド

curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My Android App",
    "bundle_id": "com.example.myapp",
    "store_id": "com.example.myapp",
    "platform": "android",
    "sections": ["signature"],
    "override_settings": {
        "signature": {
            "enforce_signature": true
        }
    },
    "force_update": true
}'

android_signature_hashとenforce_signatureの両方をオーバーライド

curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My Android App",
    "bundle_id": "com.example.myapp",
    "store_id": "com.example.myapp",
    "platform": "android",
    "sections": ["signature"],
    "override_settings": {
        "signature": {
            "android_signature_hash": [
                "AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AA:AB",
                "BB:BB:BB:BB:BB:BB:BB:BB:BB:BB:BB:BB:BB:BB:BB:BB:BB:BB:BB:BC"
            ],
            "enforce_signature": true
        }
    },
    "force_update": true
}'

アプリ設定を更新する

既存アプリの名前、ストアID、またはバンドルIDを更新します。保存されたoverride_settingsは、今後の移行のために管理することもできます。

APIプロトコル

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

メソッド： POST

レスポンス： アプリのレスポンスを更新

パラメーター

パラメーター	データタイプ	入力する値	必須	説明
`app_token`	`String`	パス	はい	Adjustアプリトークン。
`name`	`String`	ボディ	はい	アプリの新しい表示名。
`store_id`	`String`	ボディ	いいえ	新しいストアID。 iOS ：iTunes StoreのID。 Android ：バンドルID。
`bundle_id`	`String`	ボディ	いいえ	新しいバンドルID。
`override_settings`	`Object`	ボディ	いいえ	今後の移行に向けて上書き設定が保存されました。保存された上書きを全て解除するには、`null`に設定します。

例

curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My Renamed App",
    "store_id": "com.example.newapp"
}'

{
   "store_id": "com.example.newapp",
   "name": "My Renamed App",
   "ticket_token": "f1e2d3c4-b5a6-7890-1234-567890abcdef"
}

保存された上書き設定をクリアする

curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My Renamed App",
    "store_id": "com.example.newapp",
    "override_settings": null
}'

ストアIDでアプリを取得する

ストアIDとプラットフォームを使用して、アプリの詳細を取得します。

APIプロトコル

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

メソッド： GET

レスポンス: アプリのレスポンスを取得

パラメーター

パラメーター	データタイプ	入力する値	必須	説明
`store_id`	`String`	クエリ	はい	iOS ：iTunes StoreのID。 Android ：バンドルID。
`platform`	`String`	クエリ	はい	ターゲットプラットフォーム。次のいずれかを使用：`android`または`ios`

例

curl --location 'https://automate.adjust.com/app-automation/app?store_id=com.example.myapp&platform=android' \
--header 'Authorization: Bearer {your-adjust-api-token}'

{
   "name": "My Android App",
   "store_id": "com.example.myapp",
   "platform": "android",
   "adjust_app_token": "abc123xyz",
   "additional_info": { "overrides": {} },
   "channel_setup": {
      "facebook": { "app_id": "123456789" },
      "google": { "link_id": "adwords_link_id" }
   },
   "cross_promo_token": "hgj3li1"
}

トークンでアプリを取得する

Adjustアプリトークンを使用してアプリの詳細を取得します。

APIプロトコル

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

メソッド： GET

レスポンス: アプリのレスポンスを取得

パラメーター

パラメーター	データタイプ	入力する値	必須	説明
`app_token`	`String`	パス	はい	Adjustアプリトークン。

例

curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz' \
--header 'Authorization: Bearer {your-adjust-api-token}'

{
   "name": "My Android App",
   "store_id": "com.example.myapp",
   "platform": "android",
   "adjust_app_token": "abc123xyz",
   "additional_info": { "overrides": {} },
   "channel_setup": {
      "facebook": { "app_id": "123456789" }
   },
   "cross_promo_token": "hgj3li1"
}

すべてのアプリを一覧表示する

アカウント内のすべてのアプリのリストを取得します。必要に応じて、作成日でフィルタリングできます。

APIプロトコル

エンドポイント： https://automate.adjust.com/app-automation/apps/list

メソッド： GET

レスポンス： アプリ名トークンオブジェクトの配列

パラメーター

パラメーター	データタイプ	入力する値	必須	説明
`start_date`	`String`	クエリ	いいえ	この日付以降に作成されたアプリをフィルタリングします。日付はISO 8601形式で指定します（例：`2024-01-01T00:00:00Z`）。
`end_date`	`String`	クエリ	いいえ	この日付以前に作成されたアプリをフィルタリングします。日付はISO 8601形式で指定します。

例

curl --location 'https://automate.adjust.com/app-automation/apps/list' \
--header 'Authorization: Bearer {your-adjust-api-token}'

[
   {
      "name": "My Android App",
      "token": "abc123xyz"
   },
   {
      "name": "My iOS App",
      "token": "xyz789abc"
   },
   {
      "name": "Another App",
      "token": "def456uvw"
   }
]

日付範囲でフィルタリング

curl --location 'https://automate.adjust.com/app-automation/apps/list?start_date=2024-01-01T00:00:00Z&end_date=2024-06-30T23:59:59Z' \
--header 'Authorization: Bearer {your-adjust-api-token}'

データモデル

アプリペイロードの作成/更新

パラメーター	データタイプ	説明
`store_id`*	`String`	iOSアプリ：iTunes StoreのID。 Androidアプリ：バンドルID。
`platform`*	`String`	ターゲットプラットフォーム。次のいずれかを使用：`android`または`ios`
`bundle_id`*	`String`	アプリのバンドルID。
`name`*	`String`	アプリの表示名
`template_app_token`	`String`	設定のコピー元のアプリトークン。指定がない場合は、デフォルト設定を使用します。
`sections`	`Array[String]`	移行対象のアプリセクション。指定がない場合は、すべてのセクションを移行します。
`force_update`	`Boolean`	アプリが変更されていなくても、強制的に移行。デフォルトは`false`です。
`channel_setup`	`Object`	パートナー固有の構成。チャネル設定を参照してください。
`override_settings`	`Object`	テンプレートアプリからオーバーライドする設定。
`editors`	`Array[String]`	アプリへのアクセス権が付与されたユーザーのメールアドレス。
`ios_pv_shared_secret`	`String`	iOS購入認証の共有シークレット。
`verification`	`Boolean`	iOSアプリを認証するかどうか。デフォルトは`false`です。

アプリ移行のレスポンス

パラメーター	データタイプ	説明
`adjust_app_token`*	`String`	作成または更新されたアプリのAdjustアプリトークン。
`name`*	`String`	アプリの表示名
`bundle_id`*	`String`	アプリのバンドルID。
`store_id`*	`String`	アプリのストアID。
`ticket_token`*	`String`	移行ジョブのステータスを計測するUUID。ステータスエンドポイントと共に使用します。
`sk_app_id`	`String`	認証済みiOSアプリのStoreKitアプリID。該当しない場合は`null`です。

アプリのレスポンスを取得

パラメーター	データタイプ	説明
`name`*	`String`	アプリの表示名
`store_id`*	`String`	アプリのストアID。
`platform`*	`String`	ターゲットプラットフォーム。`android` または `ios`です。
`adjust_app_token`*	`String`	Adjustアプリトークン。
`additional_info`*	`Object`	オーバーライド設定を含むアプリの追加情報。
`channel_setup`	`Object`	パートナー固有の構成。
`cross_promo_token`	`String`	クロスプロモーションリンクトークン。

アプリレスポンスの更新

パラメーター	データタイプ	説明
`store_id`*	`String`	更新されたストアID。
`name`*	`String`	更新された表示名。
`ticket_token`*	`String`	アップデートジョブのステータスを計測するためのUUID。

アプリ名トークン

パラメーター	データタイプ	説明
`name`*	`String`	アプリの表示名
`token`*	`String`	Adjust アプリトークン