SKAN v4マッピングAPI

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

重要:
対象のアプリがSKAdNetwork v4を使用するように設定されていない場合、このエンドポイントはv3のマッピングスキーマにフォールバックします。 SKAN v3のマッピングエンドポイントに関するドキュメントをご覧ください。

エンドポイント

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

GETリクエスト

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

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

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

例：1125517808

レスポンス

マッピングエンドポイントは、SKAdNetwork v4によって送信された3つのポストバックに対応する3つのJSONオブジェクトの配列を返します。各オブジェクトは対応するconversion_windowで識別されます。

エンドポイントは、1つ目のポストバックに対してのみ、細かい​ マッピング情報と 粗い​ マッピング情報の両方を返します。2つ目と3つ目のポストバックには、 粗い​ マッピング情報が含まれます。

[
   {
      "data": {
         "fine": [{}],
         "coarse": [{}],
         "settings": {},
      },
      "conversion_window": 1
   },
   {
      "data": {
         "coarse": [{}],
         "settings": {},
      },
      "conversion_window": 2
   }
   {
      "data": {
         "coarse": [{}],
         "settings": {},
      },
      "conversion_window": 3
   }
]

細かいconversion valueフィールド

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

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

[
   {
      "data": {
         "fine": [
            {
               "conversion_value":12,
               "events":[
                  {
                     "event_name":"Purchase",
                     "count_min":3,
                     "count_max":10,
                     "revenue_min":3.00,
                     "revenue_max":10.00
                  },
                  {
                     "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で計測されます。

粗いconversion valueフィールド

粗いconversion value は、コンバージョン数がプライバシーのしきい値を満たせず、粒度の細かいconversion valueを提供できない場合に使用されます。 粗いCVは、low、medium、またはhighとすることができ、これらは事前定義されたCV値の集計されたバケットとして機能します。

[
   {
      "data": {
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ]
      }
   }
]
パラメーターデータタイプデフォルト値説明
coarse_conversion_value文字列未定義粗いconversion valueのレベル。次のいずれかになります：
  • "low"
  • "medium"
  • "high"
event_name文字列nullマッピングされたイベントの名前。
count_min数値1イベントが指定された回数以上記録された。
count_max数値無制限イベントが記録された回数が指定された回数を下回った。
revenue_min数値0イベントで記録された総収益が、指定された金額を上回った。 金額はアプリの reporting_currencyで計測されます。
revenue_max数値無制限イベントで記録された総収益が、指定された金額を上回らなかった。 金額はアプリの reporting_currencyで計測されます。

レスポンス設定フィールド

[
   {
      "data": {
         "settings": {
            "lock_window": {
               "time_in_hours": 24
            },
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      }
   }
]
フィールドデータタイプ説明
app_store_id文字列アプリのApp Store ID。リクエストで送信された app_store_id パラメーターと一致します。
updated_at数値リクエストを行っているパートナーが確認できる、最新のマッピング変更のUnixタイムスタンプ。
lock_windowオブジェクト ロック期間に関連する設定。
time_in_hours数値ロック期間（時間単位）。
reporting_currency文字列アプリのレポート通貨のISO 4217通貨コード。マッピングスキーマで定義された全ての収益額に適用されます。

完全なレスポンスの例

[
   {
      "data": {
         "fine": [
            {
               "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"
                  }
               ]
            }
         ],
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ],
         "settings": {
            "lock_window": {
               "time_in_hours": 24
            },
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      },
      "conversion_window": 1
   },
   {
      "data": {
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ],
         "settings": {
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      },
      "conversion_window": 2
   },
   {
      "data": {
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ],
         "settings": {
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      },
      "conversion_window": 3
   }
]

レスポンスエラーコード

エラーコード説明
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回アップデートを取得することを推奨します。