adjust-icon

アプリ設定エンドポイント

/app/{app_token}/settingsエンドポイントを使用して詳細なアプリ設定を取得します。このエンドポイントは、イベント、パートナー、アトリビューション設定など、アプリの設定に関する包括的な情報を提供します。

アプリ設定を取得

特定のアプリの詳細設定を取得します。すべての設定をリクエストするか、特定のセクションでフィルタリングできます。

APIプロトコル

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

メソッド： GET

レスポンス： アプリ設定レスポンス

パラメーター

パラメーターデータタイプ入力する値必須説明
app_tokenStringパスはいAdjustアプリトークン。
sectionsArray[String]クエリいいえ特定のセクションでフィルタリング。指定がない場合は、すべてのセクションが返されます。

利用可能なセクション

このエンドポイントは、アプリ設定レスポンスにリストされた全てのセクションをサポートします。

例

すべてのアプリ設定を取得

リクエスト - cURL
curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings' \
--header 'Authorization: Bearer {your-adjust-api-token}'
レスポンス
{
   "app_info": {
      "id": 12345,
      "name": "My App",
      "app_token": "abc123xyz",
      "default_platform": "android",
      "stores": {
         "google_play": { "store_id": "com.example.myapp" }
      }
   },
   "events": [
      {
         "name": "purchase",
         "unique": false,
         "archived": false,
         "token": "abc1de",
         "app_token": "abc123xyz"
      },
      {
         "name": "registration",
         "unique": true,
         "archived": false,
         "token": "fgh2ij",
         "app_token": "abc123xyz"
      }
   ],
   "partners": [
      {
         "name": "facebook",
         "revenue_forwarding": true,
         "session_forwarding": false,
         "parameter_forwarding": true,
         "events_linking": { "purchase": "fb_purchase" }
      }
   ],
   "attribution_settings": {
      "click_device_matching": { "window": 604800, "enabled": true },
      "click_fingerprinting": { "window": 86400, "enabled": true },
      "impression_device_matching": { "window": 86400, "enabled": true }
   }
}

特定のセクションのみを取得

リクエスト - cURL
curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings?sections=events&sections=partners' \
--header 'Authorization: Bearer {your-adjust-api-token}'
レスポンス
{
   "events": [
      {
         "name": "purchase",
         "unique": false,
         "archived": false,
         "token": "abc1de",
         "app_token": "abc123xyz"
      }
   ],
   "partners": [
      {
         "name": "facebook",
         "revenue_forwarding": true,
         "session_forwarding": false,
         "events_linking": {}
      }
   ]
}

SDKシークレットを取得（v3を含む）

リクエスト - cURL
curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings?sections=combined_secrets' \
--header 'Authorization: Bearer {your-adjust-api-token}'
レスポンス
{
   "combined_secrets": {
      "enforce_install_signing": true,
      "secrets": [
         {
            "id": 1001,
            "name": "Production Secret",
            "active": true,
            "value": ["secret1", "secret2", "info1", "info2"],
            "internal_version": 2,
            "version": 2,
            "created_at": "2024-01-15T10:30:00Z",
            "updated_at": "2024-01-15T10:30:00Z"
         },
         {
            "id": 2001,
            "platform": "android",
            "label": "Android SDK Secret",
            "active": true,
            "algorithm": "adj1",
            "internal_version": 2,
            "version": 3,
            "created_at": "2024-06-01T12:00:00Z",
            "updated_at": "2024-06-01T12:00:00Z"
         }
      ]
   }
}

設定をCSV形式で取得する

アプリ設定をCSV形式でエクスポートします。現在、イベントのエクスポートがサポートされています。

APIプロトコル

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

メソッド： GET

レスポンス： CSVファイルの内容

パラメーター

パラメーターデータタイプ入力する値必須説明
sectionStringクエリはいエクスポートするセクション。現在サポートされているのはeventsのみです。
app_tokensStringクエリはいエクスポートに含めるアプリトークンのコンマ区切りのリスト。

例

リクエスト - cURL
curl --location 'https://automate.adjust.com/app-automation/settings/csv?section=events&app_tokens=abc123xyz,def456uvw' \
--header 'Authorization: Bearer {your-adjust-api-token}'
レスポンス（CSV）
app_token,event_name,event_token,unique,archived
abc123xyz,purchase,abc1de,false,false
abc123xyz,registration,fgh2ij,true,false
def456uvw,purchase,klm3no,false,false
def456uvw,level_complete,pqr4st,false,false

データモデル

アプリ設定レスポンス

すべてのフィールドはオプションであるため、要求された場合にのみ、対応するセクションが含まれます。

パラメーターデータタイプ説明
app_infoObjectアプリの基本情報。
attribution_privacy_modelStringアトリビューションプライバシーモデル（iOSのみ）。
attribution_settingsObjectアトリビューション期間の設定。
callbacksArray[Object]サーバーコールバックの設定。
csv_upload_settingsObjectクラウドストレージのアップロード設定。
eventsArray[Object]イベントの定義。
external_data_forwardingObjectデータ転送の設定。
fraud_prevention_settingsObject不正防止の設定。
partnersArray[Object]パートナーモジュールの設定。
purchase_verificationObject購入認証の設定。
signatureObjectAndroidフィンガープリントを含むシグネチャー設定。
sdk_secretsObjectレガシー版のSDKシークレットの設定。
combined_secretsObjectすべてのSDKシークレット（レガシー＋v3）。
skad_networkObjectSKAdNetwork v3の設定。
skad_network_v4ObjectSKAdNetwork v4の設定。
preview_link_settingsObjectソーシャル共有プレビューの設定。
s2sObjectサーバー間（S2S）セキュリティ設定。
trackersArray[Object]トラッカーの設定。

イベント設定

パラメーターデータタイプ説明
name*Stringイベント名。
unique*Booleanイベントがユーザーごとに一意かどうか。
archived*Booleanイベントをアーカイブするかどうか。
token*StringSDK実装用のイベントトークン。
app_token*Stringこのイベントが属するアプリトークン。

パートナー設定

パラメーターデータタイプ説明
name*Stringパートナーの名前/スラッグ。
revenue_forwardingBoolean収益データを転送するかどうか。
session_forwardingBooleanセッションデータを転送するかどうか。
parameter_forwardingBooleanパートナーパラメーターを転送するかどうか。
cost_forwardingBooleanコストデータを転送するかどうか。
attributed_onlyBooleanアトリビュートされたデータのみを転送するかどうか。
uninstall_forwardingBooleanアンインストールデータを転送するかどうか。
ad_revenue_forwardingBoolean広告収益を転送するかどうか。
channel_setupObjectパートナー固有の設定。
events_linkingObjectこのパートナーのイベント名のマッピング。

シークレットのレスポンスの組み合わせ

パラメーターデータタイプ説明
enforce_install_signing*Boolean未署名のインストールを拒否するかどうか。
secrets*Array[Object]レガシー版を含むすべてのSDKシークレットのリスト。

レガシー版シークレット

パラメーターデータタイプ説明
id*IntegerシークレットID。
nameStringシークレットの名前/ラベル。
active*Booleanシークレットがアクティブであるかどうか。
value*Array[String]シークレットの値。
internal_version*IntegerSDKシグネチャーライブラリのバージョン。
version*IntegerSDKシークレットのバージョン（1または2）。
created_at*String作成時のISO形式のdatetime。
updated_at*String最終更新時のISO形式のdatetime。

SDKシークレット

パラメーターデータタイプ説明
id*IntegerシークレットID。
platform*Stringターゲットプラットフォーム（android、ios）。
label*Stringシークレットのラベル。
active*Booleanシークレットがアクティブであるかどうか。
algorithm*Stringシグネチャーのアルゴリズム。
internal_version*IntegerSDKシグネチャーライブラリのバージョン。
version*IntegerSDKシークレットのバージョン（3以降）。
created_at*String作成時のISO形式のdatetime。
updated_at*String最終更新時のISO形式のdatetime。