SKAN v3マッピングAPI

マッピングエンドポイントは、広告主のconversion valueマッピングに関する情報を返します。ネットワークパートナーは、エンドポイントに GET​ リクエストを送信することで、いつでもこの情報を取得できます。

エンドポイント

https://app.adjust.com/skadnetwork/{sk_network_token}/mapping/{app_store_id}

GETリクエスト

マッピング情報をJSONオブジェクトとして返します。各GETリクエストには、以下のパラメーターを含める必要があります。

パラメーターデータタイプ入力する値説明
sk_network_token*文字列パスAdjustによって割り当てられたパートナー固有のトークン。

例：abcdefklmn
app_store_id*文字列パスアプリのApp Store ID。

例：1125517808

レスポンス

マッピングエンドポイントは、アプリに関連するメタデータを含むJSONオブジェクトと、マッピングされたconversion valueの配列を返します。各値については個別に説明します。

{
   "app_store_id":"1125517808",
   "updated_at":1617234177,
   "cut_off_period":1,
   "reporting_currency":"USD",
   "conversion_values":[
      {
         "conversion_value":7,
         "events":[
            "..."
         ]
      },
      {
         "conversion_value":10,
         "events":[
            "..."
         ]
      },
      {
         "conversion_value":12,
         "events":[
            "..."
         ]
      }
   ]
}

レスポンス メタデータ パラメーター

フィールドデータタイプ説明
app_store_id文字列アプリのApp Store ID。リクエストで送信された app_store_id パラメーターと一致します。
updated_at数値リクエストを行っているパートナーが確認できる、最新のマッピング変更のUnixタイムスタンプ。
cut_off_period数値アプリのconversion valueのカットオフ設定。値は 時間単位で表示されます。
reporting_currency文字列アプリのレポート通貨のISO 4217通貨コード。マッピングスキーマで定義された全ての収益額に適用されます。

レスポンスconversion valueフィールド

注意:
共有設定とイベント連携が適用された後、マッピングエンドポイントは、少なくとも1つのパートナーイベントを持つconversion valueのマッピング情報を返します。詳細については、 APIの動作 をご覧ください。

マッピングエンドポイントは、マッピングされた各conversion valueの内訳と関連する詳細を返します。

{
   "app_store_id":"1125517808",
   "updated_at":1617234177,
   "cut_off_period":1,
   "reporting_currency":"USD",
   "conversion_values":[
      {
         "conversion_value":12,
         "events":[
            {
               "event_name": "Purchase",
               "count_min": 3,
               "count_max": 10,
               "revenue_min": 3.000,
               "revenue_max": 10.000
            },
            { "event_name": "Registration" }
         ]
      }
   ]
}

イベントカウントと収益範囲はオプションのパラメーターで、広告主がパートナーアクセスをどのように設定したかに応じて返されます。以下の詳細をマッピングすることが可能です。

  • セッション（Session）
  • セッションカウント（Session count）
  • イベント（Event）
  • イベントカウント（Event count）
  • イベント収益（Event revenue）
  • アプリ内課金（IAP）
  • 広告収益（Ad Revenue）
  • 総収益（Total Revenue）
注意:
収益情報を表示するには、広告主がリクエストを行うパートナーの収入共有を有効にする必要があります。

カウントおよび収益範囲パラメーターは全てオプションであり、以下のように定義されます。

パラメーターデータタイプデフォルト値説明
count_min数値1イベントまたはセッションが指定された回数以上記録された。
count_max数値無制限イベントまたはセッションが記録された回数が、指定された回数を下回った。
revenue_min数値0総収益が指定された金額を上回った。金額はアプリの reporting_currencyで計測されます。
revenue_max数値無制限総収益が指定された金額を上回らなかった。金額はアプリの reporting_currencyで計測されます。

完全なレスポンスの例

{
   "app_store_id":"1125517808",
   "updated_at":1617234177,
   "cut_off_period":1,
   "reporting_currency":"USD",
   "conversion_values":[
      {
         "conversion_value":7,
         "events":[
            {
               "event_name":"Registration"
            }
         ]
      },
      {
         "conversion_value":10,
         "events":[
            {
               "event_name":"TutorialComplete"
            }
         ]
      },
      {
         "conversion_value":12,
         "events":[
            {
               "event_name":"Purchase",
               "count_min":3,
               "count_max":10,
               "revenue_min":3.00,
               "revenue_max":10.00
            },
            {
               "event_name":"Registration"
            }
         ]
      }
   ]
}

レスポンスエラーコード

エラーコード説明
400 Bad RequestストアIDがないか、正しくフォーマットされていません。
401 Unauthorizedネットワークトークンがないか、認識されていません。
403 Forbiddenアプリは認識されていますが、リクエストされたアプリのパートナー共有の要件が満たされていませんでした。
404 Not Foundリクエストされたアプリが見つからないか、SKAdNetworkに対して検証されていません。
422 Unprocessable EntityリクエストされたアプリはAdjustによって認識および検証されましたが、このアプリのconversion value管理機能は有効化されていません。
429 Too Many Requestsリクエストはパートナー/アプリごとに制限されます。Adjustでは、1日に1回アップデートを取得することを推奨します。