Ad Unit Management API

Ad Unit Management APIにリクエストを送信することで、MAXの広告ユニットを表示および管理できます。

このAPIには5つのエンドポイントがあります。

/ad_unit エンドポイント
- /ad_unit/«ad-unit-ID»に対するGETリクエスト：特定の広告ユニットの詳細を表示
- /ad_unit/に対しPOSTリクエスト：新しい広告ユニットを作成
- /ad_unit/«ad-unit-ID»に対しPOSTリクエスト：広告ユニットのアドネットワーク設定を管理
- /ad_unit/«ad-unit-ID»/«segment-ID»に対しGETリクエスト：広告ユニットのセグメントのウォーターフォールを取得
- /ad_unit/«ad-unit-ID»/«segment-ID»に対しPOSTリクエスト：広告ユニットのセグメントのウォーターフォールを作成、編集、非推奨化、昇格、または削除
/ad_unitsエンドポイント
- /ad_unitsに対しGETリクエスト：すべての広告ユニットの詳細を表示
/ad_unit_experimentエンドポイント
- /ad_unit_experiment/«ad-unit-ID»に対しGETリクエスト：広告ユニットテストの詳細を表示
- /ad_unit_experiment/«ad-unit-ID»に対しPOSTリクエスト：有効な広告ユニットがない場合、新しい広告ユニットテストを作成
- /ad_unit_experiment/«ad-unit-ID»に対しPOSTリクエスト：広告ユニットテストを昇格または非推奨化
- /ad_unit_experiment/«ad-unit-ID»/«segment_id»に対しGETリクエスト：広告ユニットテストのセグメントのウォーターフォールを取得
- /ad_unit_experiment/«ad-unit-ID»/«segment_id»に対しPOSTリクエスト：広告ユニットテストのセグメントのウォーターフォールを作成、編集、非推奨化、昇格、または削除
/test_deviceエンドポイント
- /test_deviceに対しPOSTリクエスト：新しいテストデバイスを作成
- /test_device/«test-device-ID»に対しGETリクエスト：特定のテストデバイスの詳細を表示
- /test_device/«test-device-ID»に対しPOSTリクエスト：テストデバイスの設定を管理
/test_devicesエンドポイント
- /test_devicesにGETリクエスト：すべてのテストデバイスの詳細を表示

このページの次のセクションで、これらのエンドポイントについて詳しく説明します。

`/ad_unit`エンドポイント

広告ユニットを作成するには、このエンドポイントにPOSTリクエストを行います。リクエストボディーには、下記の必須フィールドを含めます。 1回のリクエストで作成できるのは1つの広告ユニットのみです。

ターゲットURL

https://o.applovin.com/mediation/v1/ad_unit

`POST`

リクエストボディー

{
  "name": "My Inter Ad Unit",
  "platform": "ios",
  "package_name": "com.test.app",
  "ad_format": "INTER"
}

レスポンスボディー

{
  "id": "1234567890abcdef",
  "name": "My Inter Ad Unit",
  "platform": "ios",
  "package_name": "com.test.app",
  "ad_format": "INTER",
  "has_active_experiment": false,
  "disabled": false
}

リクエスト/レスポンスボディーフィールド一覧

名前	説明	例	作成時に必須（`POST`）
`ad_format`	広告ユニットのフォーマット。	`INTER`、`BANNER`、`REWARD`	要
`disabled`	この広告ユニットが無効（読み取り専用）かどうか。	`不要`	不要
`has_active_experiment`	この広告ユニットに有効なテスト（読み取り専用）があるかどうか。	`不要`	不要
`id`	広告ユニットID。広告ユニットを作成する際はこれを含めないでください。これは、作成リクエストへのレスポンスで返されます。	`1234567890abcdef`	不要
`name`	広告ユニット名。	`"Mr. Bullet Rewarded"`	要
`package_name`	この広告ユニットに関連付けられているアプリのパッケージ名/バンドルID。	`com.my.test.app`	要
`platform`	広告ユニットのプラットフォーム。	`ios`、`android`	要
`template_size`	ネイティブ広告テンプレート。ネイティブ広告ユニットの場合のみ。	`small_template_1`、`medium_template_1`、`custom_template_1`	要

`/ad_unit/«ad-unit-ID»`エンドポイント

このエンドポイントを使用して、広告ユニット設定を表示（GET）または編集（POST）できます。（広告ユニットテストを作成、更新、昇格または無効にするには、下記の/ad_unit_experiment/エンドポイントを参照してください。） MAXは、ここで設定したCPM値を使用してウォーターフォールを定義します。ただし、アカウントと特定のアドネットワークをAuto CPMを使用するように設定する場合、Auto CPMが新しい値を学習するまで、ここで設定した値がデフォルトのCPM値として適用されます。

広告ユニットのより詳細な情報を取得するには、クエリパラメーターfieldsを含めてください。その値を、表示したい追加フィールド名がコンマ区切りで記載されたリストに設定します。 fieldsには、ad_network_settings（有効なもののみ）、disabled_ad_network_settings（無効なもののみ）、frequency_capping_settings、bid_floors、segments、banner_refresh_settings、およびmrec_refresh_settingsが含まれます。これらのfields値に対応するオブジェクトについては、以下の説明を参照してください。

ターゲットURL

https://o.applovin.com/mediation/v1/ad_unit/«ad-unit-ID»?fields=ad_network_settings,disabled_ad_network_settings,frequency_capping_settings,bid_floors,banner_refresh_settings,segments

例

`GET`

レスポンスボディー

{
  "id": "1234567890abcdef",
  "name": "My Inter Ad Unit",
  "platform": "ios",
  "package_name": "com.test.app",
  "ad_format": "INTER",
  "has_active_experiment": false,
  "disabled": false,
  "ad_network_settings": [
    {
      "FACEBOOK_NETWORK": {
        "disabled": false,
        "ad_network_ad_units": [
           {
             "ad_network_ad_unit_id": "8247030622430922_5618972399256249",
             "disabled": false
           }
        ]
      }
    },
    {
      "ADMOB_NETWORK": {
        "disabled": false,
        "ad_network_app_id": "ca-app-pub-3555987499620362~3024971981",
        "ad_network_ad_units": [
          {
            "ad_network_ad_unit_id": "ca-app-pub-3555987499620362/4382996128",
            "disabled": false,
            "cpm": "30.00",
            "countries": {
              "type": "INCLUDE",
              "values": [
                "us",
                "ca",
                "gb",
                "au"
              ]
            }
          },
          {
            "ad_network_ad_unit_id": "ca-app-pub-3555987499620362/5476585941",
            "disabled": false,
            "cpm": "20.00",
            "countries": {
              "type": "EXCLUDE",
              "values": [
                "us",
                "ca",
                "gb",
                "au"
              ]
            }
          }
        ]
      }
    }
  ],
  "frequency_capping_settings": [
    {
      "type": "time",
      "time_capping_settings": {
        "day_limit": 10,
        "minute_frequency": 10
      },
      "session_capping_settings": {
        "session_limit": 0
      },
      "countries" : {
        "type": "INCLUDE",
        "values" : [
          "ca",
          "us"
        ]
      }
    }
  ],
  "bid_floors": [
    {
      "country_group_name": "t1 eng",
      "cpm": "10.00",
      "countries": {
        "type": "INCLUDE",
        "values": [
          "au",
          "ca",
          "gb",
          "nz",
          "us"
        ]
      }
    },
    {
      "country_group_name": "eea",
      "cpm": "5.00",
      "countries": {
        "type": "INCLUDE",
        "values": [
          "at",
          "pt",
          "ro",
          "se",
          "si",
          "sk"
        ]
      }
    }
  ],
  "banner_refresh_settings":{
    "interval": 0
  },
  "segments":[
    {
      "id": 347324,
      "name": "LAT iPads",
      "id_type": "no_id",
      "device_type": "tablets",
      "segment_keys": [
        [
          "+1:2"
        ]
      ]
    }
  ]
}

`POST`

リクエストボディー

{
  "id":"«ad-unit-ID»",
  "name":"«ad-unit-name»",
  "platform":"«ad-unit-platform»",
  "ad_format":"«ad-unit-format»",
  "package_name":"«ad-unit-package-name»",
  "ad_network_settings": [
    {
      "ADMOB_NETWORK": {
        "disabled": true,
        "ad_network_app_id": "ca-app-pub-3555987499620362~3024971981",
        "ad_network_ad_units": []
      }
    }
  ],
  "frequency_capping_settings": [
    {
      "type": "time",
      "time_capping_settings": {
        "day_limit": 10,
        "minute_frequency": 10
      },
      "session_capping_settings": {
        "session_limit": 0
      },
      "countries" : {
        "type": "INCLUDE",
        "values" : [
          "ca",
          "us"
        ]
      }
    }
  ]
}

レスポンス

レスポンスはすべての広告ユニットの詳細を返します。

`ad_network_settings`配列

ad_network_settings配列には、設定したアドネットワークごとに1つのアドネットワークオブジェクトが含まれます。ネットワークAPI名（例：FACEBOOK_NETWORK）は、各アドネットワークオブジェクトのキーとなります。各アドネットワークには特定のフィールドが必要です。これらのフィールドの意味については、以下のアドネットワークオブジェクト一覧の表を参照してください。ネットワークAPI名のオブジェクトキーと特定のフィールドの設定方法に関するネットワーク固有の手順については、アドネットワーク一覧を参照してください。

アドネットワークオブジェクト

名前	説明	例
`ad_network_ad_units`	特定のアドネットワークの広告ユニットを表すオブジェクトのリスト。一部のアドネットワークに必要です。	`ad_network_ad_units`オブジェクトを参照してください。
`ad_network_app_id`	ネットワークアプリID。一部のネットワークではこの値が存在しない場合がありますが、特定の広告ネットワークでは必須となります。アドネットワーク一覧を参照してください。	`ca-app-pub-3555987499620362~3024971981`
`ad_network_app_key`	ネットワークアプリキー。一部のネットワークではこの値が存在しませんが、特定の広告ネットワークでは必須となります。アドネットワーク一覧を参照してください。	`123456789`
`bid_floors`	この広告ユニットのCPMの最低単価を表すオブジェクト。`bid_floors`オブジェクトを参照してください	（オプション）。
`disabled`	このネットワークがこの広告ユニットで有効か無効かを示します（オプション）。	`不要`
`frequency_cap_settings`	非推奨です。
`frequency_capping_settings`	この広告ユニットに対してフリークエンシーキャップを適用する方法を記述したオブジェクトのリスト（オプション）。	`frequency_capping_settings`オブジェクトを参照してください。

`ad_network_ad_units`オブジェクト

特定のアドネットワークに加えた変更は、他のアドネットワークの設定に影響しません。 1つのアドネットワークのみを更新する場合は、すべてのアドネットワークを含むリクエストを作成する必要はありません。特定のアドネットワーク設定の一部を変更するには、該当のアドネットワークのMAX広告ユニットに関連付けられたすべての情報を含める必要があります。既存のアドネットワークに新しい広告ユニットを追加するには、該当のアドネットワークに含まれるすべての広告ユニットをリクエストに含めてください。特定のアドネットワークのすべての広告ユニットをdisabledとしてマークすると、そのアドネットワークは無効になります。

名前	説明	例
`ad_network_ad_unit_id`（必須）	アドネットワーク広告ユニットのID。一部のネットワークはこの値を持たず、`N/A`を返すことがあります。以下のアドネットワーク一覧を参照してください。	`ca-app-pub-3555987499620362/4382996128`
`cpm`（必須、ビディングネットワークを除く）	この広告ユニットの各インプレッションに対して支払われるCPM。	`20.00`
`countries`（必須）	特定のアドネットワークの広告ユニットに対して、ホワイトリストまたはブラックリストに登録されている国を表すオブジェクト。	`countries`オブジェクトを参照してください。
`disabled`（オプション）	このアドネットワークの広告ユニットが有効かどうかを示します。	`不要`

`countries`オブジェクト

このオブジェクトは、特定のad_network_ad_unitにどの国を含めるか、除外するかを定義します。

名前	説明	例	必要性
`type`	これらの国をホワイトリストまたはブラックリストに登録するかどうかを示します。	`INCLUDE`、`EXCLUDE`	要
`values`	2文字のISO国コードのリスト。空のリストは、タイプが`INCLUDE`か`EXCLUDE`かに関わらず、すべての国を意味します。	`["us", "ca", "jp"]`	要

`frequency_capping_settings`オブジェクト

フリークエンシーキャップには、セッションベースと時間ベースの2つの種類があります。セッションベースのフリークエンシーキャップの場合、1回のセッションにおいて各ユーザーに表示される広告の上限を最大数として設定します。時間ベースの場合、特定の時間枠（分単位で定義）内に設定された最大数が、各ユーザーに表示される広告数の上限となります。

名前	説明	例
`countries`（必須）	このフリークエンシーキャップが適用される国。フィールドの説明については、`countries`オブジェクトを参照してください。フリークエンシーキャップは現在`type=INCLUDE`のみをサポートしています。`frequency_capping_objects`に含める国名は区切られている必要があります。	`{ "type": "INCLUDE", "values": ["at", "pt", "ro", "se", "si", "sk"] }`
`session_capping_settings`（`type==session`の場合に必須）	ユーザーに表示されるセッションあたりの最大広告表示数（`session_limit`）を表すオブジェクト。`type`=`time`の場合は、`session_limit=0`に設定します。	`{"session_limit": 10}`
`time_capping_settings`（`type`=`time`の場合に必須）	1日あたりの広告表示数（`day_limit`）および広告の表示間隔（分単位）（`minute_frequency`）を指定するオブジェクト。 `type` が `session` と等しい場合は、`day_limit` と `minute_frequency` に `0` を設定してください。	`{"day_limit": 10, "minute_frequency": 10}`
`type`（必須）	使用するフリークエンシーキャップのタイプ。	`time`、`session`

`bid_floors`オブジェクト

このオブジェクトは、特定の国に関連付けるCPM最低入札単価を定義します。入札の最低価格を定義しない国には、最低入札単価は設定されません。 bid_floorsオブジェクトを含むすべての更新リクエストには、最低単価のリストをすべて含めてください。

名前	説明	例	必要性
`countries`	この最低入札単価に関連付けられる国のリスト。このオブジェクトの説明については、`countries`オブジェクトを参照してください。ここでは`type=INCLUDE`のみがサポートされています。	`{ "type": "INCLUDE", "values": ["at", "pt", "ro", "se", "si", "sk"] }`	要
`country_group_name`	グループ化された国または地域を表す名前。	`"T1 EN Speaking"`	要
`cpm`	アドネットワークがこの広告ユニットの各インプレッションに入札する際の最低CPM価格。このグループに属する国に、制限を超える広告を提供できない場合、MAXは広告リクエストを充填しません。	`2.00`	要

`banner_refresh_settings`オブジェクト

このオブジェクトは、どのバナー広告ユニットがどれくらいのインターバルでリフレッシュするのか、また、新しいバナー広告を取得するのかを定義します。 intervalを0に設定すると、この広告ユニットはMAXが定義したデフォルトのリフレッシュレートでリフレッシュされます。

名前	説明	例
`interval`	バナープレースメントをリフレッシュする前に待機する秒数。0、10、15、20、30、45、60、および300の値で定義できます。	`10`

`mrec_refresh_settings`オブジェクト

このオブジェクトは、どのMREC広告ユニットがどれくらいのインターバルでリフレッシュし、新しいMREC広告を取得するのかを定義します。 intervalを0に設定すると、この広告ユニットはMAXが定義したデフォルトのリフレッシュレートで更新されます。

名前	説明	例
`interval`	MRECプレースメントをリフレッシュする前に待機する秒数。0、10、15、20、30、45、60、および300の値で定義できます。	`10`

`segment`オブジェクト

このオブジェクトは、ユーザーセグメンテーションのターゲティングルールを定義し、インベントリの異なるセグメントごとに異なる広告ユニットのウォーターフォールを作成します。 IDステータスやデバイスタイプ別にユーザーセグメンテーションを行うことができます。詳細は、SDK連携ガイド > プラットフォーム > オーバービュー > 「データおよびキーワードの送信」のドキュメントを参照してください。

メイン広告ユニットでは、segmentオブジェクトがsegmentsという名前のリストに含まれています（注：リスト名の最後に小文字の「s」がついています）。これは、その広告ユニットに関連付けられたウォーターフォールセグメンテーションの読み取り専用リストです。セグメンテーションが定義された特定の広告ユニットウォーターフォールを確認するとき、または新しいウォーターフォールモデルを作成するとき、セグメントオブジェクトはキーsegmentに関連付けられます（キー名の最後に小文字の「s」はついていません）。

名前	説明	例
`device_type`	デバイスタイプターゲティング。`"all"`（デフォルト）、`"phones"`、`"tablets"`のオプションがあります。	`"tablets"`
`id`	このセグメントに関連付けられたウォーターフォールのID。新しいウォーターフォールを作成する場合は、この値を含めないでください。	`81234`
`id_type`	デバイスIDターゲティング。`"all"`（デフォルト）、`"id_only"`、`"no_id"`のオプションがあります。	`"no_id"`
`name`	このウォーターフォールの名前。	`"No-ID iPhones"`
`segment_keys`	セグメントを定義するキーと値を示す配列。	`[ "+101:202" ]`

発生する可能性があるエラー

名前	説明	例
`Bad Request`	HTTPレスポンスコード	`400`
`Unauthorized`	HTTPレスポンスコード	`401`
`Forbidden`	HTTPレスポンスコード	`403`

`/ad_units`エンドポイント

このエンドポイントを使用して、すべての有効な広告ユニットの基本情報を確認できます。このエンドポイントへのGETリクエストは、有効な広告ユニットのみを返します。このAPIでは、広告ユニットを有効または無効にすることはできません。これを行うにはUIを利用してください。

リクエストにクエリパラメーターfieldsを含めると、すべての有効な広告ユニットのより詳細な情報を取得できます。表示させたい追加フィールドの名前をコンマ区切りのリストで設定してください。 fieldsには、ad_network_settings、frequency_capping_settings、bid_floorsが含まれます。これらの追加フィールドをリクエストした際に返されるフィールド値は、/ad_unit/«ad-unit-ID»エンドポイントを使用して単一の広告ユニットをリクエストした場合に自動的に返される対応オブジェクトの値と同じです。

広告ユニットが多すぎる場合、このエンドポイントへのリクエストはタイムアウトになるか、500のレスポンスコードを返す可能性があります。クエリパラメーターlimitを追加すると、返される広告ユニットの数を制限できます。リクエストが返す広告ユニット数を整数で設定します。すべての広告ユニットにページネーションを設定するには、クエリパラメーターoffsetを追加します。結果セットの最初の結果が出る前に、全リスト内でスキップする広告ユニット数を整数で設定します。このoffset値が広告ユニットの合計数よりも大きい場合、レスポンスは空の配列を返します。

ターゲットURL

https://o.applovin.com/mediation/v1/ad_units

例

`GET`

レスポンスボディー

[
  {
    "name": "My Inter Ad Unit",
    "platform": "ios",
    "package_name": "com.test.app",
    "ad_format": "INTER",
    "ad_unit_id": "45de6aa565cf865f",
    "has_active_experiment": false,
    "disabled": false
  },
  {
    "name": "My Rewarded Ad Unit",
    "platform": "android",
    "package_name": "com.test.app",
    "ad_format": "REWARD",
    "ad_unit_id": "565c45df8e6aa65f",
    "has_active_experiment": false,
    "disabled": false
  }
]

広告ユニットオブジェクト

名前	説明	例
`ad_format`	広告ユニットのフォーマット。	`INTER`、`BANNER`、`REWARD`
`ad_unit_id`	広告ユニットID。	`1234567890abcdef`
`disabled`	この広告ユニットが無効（読み取り専用）かどうか。	`不要`
`has_active_experiment`	この広告ユニットに有効なテスト（読み取り専用）があるかどうか。	`不要`
`name`	広告ユニット名。	`"Mr. Bullet Rewarded"`
`package_name`	この広告ユニットに関連付けられているアプリのパッケージ名/バンドルID。	`com.my.test.app`
`platform`	広告ユニットのプラットフォーム。	`ios`、`android`

発生する可能性があるエラー

名前	説明	例
`Bad Request`	HTTPレスポンスコード	`400`
`Unauthorized`	HTTPレスポンスコード	`401`
`Forbidden`	HTTPレスポンスコード	`403`

`/ad_unit_experiment/«ad-unit-ID»`エンドポイント

このエンドポイントを使用して、広告ユニットを作成、表示、編集、昇格、または非推奨にすることができます。すべての広告ユニットテストの詳細を取得するには、リクエストにクエリパラメーターfieldsを含めます。値を確認したいフィールド名をコンマ区切りで設定してください。 fieldsには、ad_network_settings、frequency_capping_settings、bid_floorsが含まれます。これらのfields値に対応するオブジェクトについては、上の説明を参照してください。

ターゲットURL

https://o.applovin.com/mediation/v1/ad_unit_experiment/«ad-unit-ID»?fields=ad_network_settings,frequency_capping_settings,bid_floors

例

`GET`

レスポンスボディー

{
  "id": "e74c3b7797b0ce7a",
  "experiment_name": "add_admob_inter_lines",
  "platform": "ios",
  "ad_format": "INTER",
  "package_name": "com.testapp.test",
  "disabled": false,
  "promote": false,
  "deprecate": false,
  "ad_network_settings": [
    {
      "ADMOB_NETWORK": {
        "disabled": true,
        "ad_network_app_id": "ca-app-pub-3555987499620362~3024971981",
        "ad_network_ad_units": []
      }
    }
  ],
  "frequency_capping_settings": [
    {
      "type": "time",
      "time_capping_settings": {
        "day_limit": 10,
        "minute_frequency": 10
      },
      "session_capping_settings": {
        "session_limit": 0
      },
      "countries" : {
        "type": "INCLUDE",
        "values" : [
          "ca",
          "us"
        ]
      }
    }
  ],
  "bid_floors": [
    {
      "country_group_name": "t1 eng",
      "cpm": "10.00",
      "countries": {
        "type": "INCLUDE",
        "values": [
          "au",
          "ca"
        ]
      }
    }
  ]
}

`POST`

テスト作成のリクエストボディー

エンドポイントにテストの作成リクエストを行う場合は、リクエストボディーからid値を除外するか、値をnullに設定します。

{
  "experiment_name": "test_adjusting_frequency_cap",
  "frequency_capping_settings": […]
}

テスト作成のリクエストボディー

{
  "id": "e74c3b7797b0ce7a",
  "experiment_name": "test_adjusting_frequency_cap",
  "disabled": false,
  "promote": false,
  "deprecate": false,
  "ad_network_settings":[{…}], // same as parent ad unit
  "frequency_capping_settings": […],
  "bid_floors":[{…}] // same as parent ad unit
}

テスト非推奨化のリクエストボディー

{
  "id": "e74c3b7797b0ce7a",
  "experiment_name": "test_adjusting_frequency_cap",
  "promote": false,
  "deprecate": true
}

テスト非推奨化レスポンスボディー

{
  "message": "Experiment successfully deprecated"
}

テスト昇格リクエストボディー

{
  "id": "e74c3b7797b0ce7a",
  "experiment_name": "test_adjusting_frequency_cap",
  "promote": true,
  "deprecate": false
}

テスト昇格レスポンスボディー

{
  "message": "Experiment successfully promoted"
}

広告ユニットテストオブジェクト

名前	説明	例	必要性
`ad_network_settings`	アドネットワークの設定。	`/ad_unit/«ad-unit-ID»`エンドポイントを参照してください。	不要
`bid_floors`	入札最低価格。	`/ad_unit/«ad-unit-ID»`エンドポイントを参照してください。	不要
`deprecate`	このテストを非推奨化したいかどうか。	`要`	不要
`disabled`	広告ユニットが無効かどうか。	`不要`	不要（読み取り専用）
`experiment_name`	広告ユニットテスト名。	`"aggressive_freq_caps"`	作成および編集の場合は必要、昇格および非推奨化の場合は不要
`frequency_capping_settings`	フリークエンシーキャップの設定。	`/ad_unit/«ad-unit-ID»`エンドポイントを参照してください。	不要
`id`	広告ユニットID（親広告ユニットIDと同じ）。	`"e74c3b7797b0ce7a"`	作成、昇格または非推奨化の場合は必要、作成の場合は不要（存在しない、または空でなければならない）
`promote`	このテストを昇格したいかどうか。	`要`	不要
`test_group_allocation`	このテストの対象であるユーザーの割合。50、25、10、および5の値で定義できます。	`25`	不要

発生する可能性があるエラー

名前	説明	例
`Bad Request`	HTTPレスポンスコード	`400`
`Unauthorized`	HTTPレスポンスコード	`401`
`Forbidden`	HTTPレスポンスコード	`403`

`/test_device`エンドポイント

テストデバイスを作成するには、このエンドポイントにPOSTリクエストを行います。リクエストボディーには、下記の必須フィールドを含めます。 1回のリクエストで作成できるのは1つのテストデバイスのみです。

ターゲットURL

https://o.applovin.com/mediation/v1/test_device

例

リクエストボディー

{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": false,
  "network": "APPLOVIN_NETWORK"
}

レスポンスボディー

{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": false,
  "network": "APPLOVIN_NETWORK"
}

リクエスト/レスポンスボディーフィールド一覧

名前	説明	例	作成時に必須（`POST`）
`device_id`	テストデバイスのIDFA。	`"2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1"`	要
`disabled`	デバイスIDのステータス（無効または有効）。	`不要`	要
`name`	テストデバイス名。	`"My Test Device"`	要
`network`	テストモードのデバイスIDが有効になっているネットワーク。	`APPLOVIN_NETWORK`	要

`/test_device/«test-device-ID»`エンドポイント

このエンドポイントを使用して、テストデバイス設定を表示（GET）または編集（POST）します。

ターゲットURL

https://o.applovin.com/mediation/v1/test_device/«test-device-ID»

例

ターゲットURL

https://o.applovin.com/mediation/v1/test_device/2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1

`GET`

レスポンスボディー

{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": false,
  "network": "APPLOVIN_NETWORK"
}

`POST`

リクエストボディー

{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": true,
  "network": "FACEBOOK_NETWORK"
}

レスポンスボディー

{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": true,
  "network": "FACEBOOK_NETWORK"
}

このJSONオブジェクトは、/test_deviceエンドポイントによって返されるものと同じです。

`/test_devices`エンドポイント

このエンドポイントを使用して、アカウント内のすべてのテストデバイスの基本情報を確認できます。レスポンスには、無効なテストデバイスと有効なテストデバイスの両方が含まれます。

ターゲットURL

https://o.applovin.com/mediation/v1/test_devices

例

レスポンスボディー

{
  "name": "My Test Device",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1",
  "disabled": false,
  "network": "APPLOVIN_NETWORK"
},
{
  "name": "My Test Device 2",
  "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe2",
  "disabled": false,
  "network": "FACEBOOK_NETWORK"
}

これらのJSONオブジェクトは、/test_deviceエンドポイントによって返されるものと同じです。

複数のウォーターフォール

ユーザーセグメンテーションに基づいて、特定の広告ユニットに追加のウォーターフォールを作成できます。ウォーターフォールの作成、ウォーターフォールの編集、ウォーターフォールテストの作成/編集/非推奨化/昇格は、このページに記載されている他のリクエストと同様の方法で行うことができます。リクエストを適用するセグメントを指定するには、エンドポイントの末尾に/«segment-ID»を追加します。ここでは、«segment-ID»が広告ユニットレスポンスにおけるsegmentオブジェクトのid値です。新しいセグメントは、広告ユニットにデフォルトで設定されているものと同じウォーターフォールで始まります。ユーザーセグメンテーションの定義方法については、セグメントオブジェクトを参照してください。

例

`GET`

広告ユニット1234567890abcdefのセグメントID 213のウォーターフォールを取得する：

https://o.applovin.com/mediation/v1/ad_unit/1234567890abcdef/213

広告ユニット1234567890abcdefのセグメントID 213のテストウォーターフォールを取得する：

https://o.applovin.com/mediation/v1/ad_unit_experiment/1234567890abcdef/213

`POST`

広告ユニット1234567890abcdefのNo-ID iPhoneユーザーの新しいウォーターフォールを作成する：

https://o.applovin.com/mediation/v1/ad_unit/1234567890abcdef

{
  "id": "1234567890abcdef", // ad unit ID
  "name": "MyApp_iOS_Banners", // ad unit name
  "platform": "ios",
  "ad_format": "BANNER",
  "package_name": "com.company.myapp",
  "disabled": false,
  "segment": {
    "name": "No-ID iPhones", // waterfall name
    "id_type": "no_id",
    "device_type": "phones",
    "segment_keys": [
      [
        "+1:2"
      ]
    ]
  }
}

広告ユニット1234567890abcdefのセグメントID 213のウォーターフォールを削除する（disabledを要に設定）：

https://o.applovin.com/mediation/v1/ad_unit/1234567890abcdef/213

{
  "id": "1234567890abcdef", // ad unit ID
  "name": "MyApp_iOS_Banners", // ad unit name
  "platform": "ios",
  "ad_format": "BANNER",
  "package_name": "com.company.myapp",
  "disabled": true
}

アドネットワーク

以下は、広告ユニットAPIがアドネットワークとアプリ識別子に使用する名前と、各アドネットワーク内で使用される名前の対応表です。ネットワークのad_network_app_id（ID）またはad_network_app_key（キー）の値が記載されている場合は、ad_network_settingsオブジェクトを更新するリクエストを発行する際にその値が必要になります。ネットワークの値が記載されていない場合、値は不要です。

ネットワーク	ネットワークAPI名	ID	キー	広告ユニットID
AdColony入札	`ADCOLONY_NETWORK`	アプリID	⸺	Zone ID
AdMob	`ADMOB_NETWORK`	GoogleアプリID	⸺	広告ユニットID
AdMobネイティブ	`ADMOB_NATIVE_NETWORK`	GoogleアプリID	⸺	広告ユニットID
BidMachine入札	`BIDMACHINE_BIDDING`	ソースID	⸺	⸺
BIGO Ads入札	`BIGO_BIDDING`	アプリID	⸺	スロットID
Chartboost	`CHARTBOOST_NETWORK`	アプリID	アプリ署名	広告の場所
CSJ	`CSJ_NETWORK`	アプリID	⸺	スロットID
DT Exchange	`FYBER_NETWORK`	アプリID	⸺	スポットID
DT Exchange入札	`FYBER_BIDDING`	アプリID	⸺	プレースメントID
Google アドマネージャー	`GOOGLE_AD_MANAGER_NETWORK`	⸺	⸺	プレースメントID
Google アドマネージャーネイティブ	`GOOGLE_AD_MANAGER_NATIVE_NETWORK`	⸺	⸺	プレースメントID
Google Bidding	`ADMOB_BIDDING`	GoogleアプリID	⸺	広告ユニットID
HyprMX	`HYPRMX_NETWORK`	販売者ID	⸺	プレースメント名
InMobi	`INMOBI_NETWORK`	アカウントID	⸺	プレースメントID
InMobi入札	`INMOBI_BIDDING`	アカウントID	⸺	プレースメントID
ironSource	`IRONSOURCE_NETWORK`	アプリキー	⸺	インスタンスID
ironSource入札	`IRONSOURCE_BIDDING`	アプリキー	⸺	インスタンスID
Liftoff Monetize	`VUNGLE_NETWORK`	アプリID	⸺	プレースメントリファレンスID
Liftoff Monetize入札	`VUNGLE_BIDDING`	アプリID	⸺	プレースメントリファレンスID
LINE	`LINE_NETWORK`	アプリID	⸺	スロットID
LINEネイティブ	`LINE_NATIVE_NETWORK`	アプリID	⸺	スロットID
Maio	`MAIO_NETWORK`	メディアID	⸺	Zone ID
Meta Audience Network	`FACEBOOK_MEDIATE`	⸺	⸺	プレースメントID
Meta Audience Network入札	`FACEBOOK_NETWORK`	⸺	⸺	プレースメントID
Meta Audience Networkネイティブ入札	`FACEBOOK_NATIVE_BIDDING`	⸺	⸺	プレースメントID
Mintegral¹	`MINTEGRAL_NETWORK`	アプリID	アプリキー	広告ユニットID
Mintegral入札¹	`MINTEGRAL_BIDDING`	アプリID	アプリキー	広告ユニットID
Mintegralネイティブ入札¹	`MINTEGRAL_NATIVE_BIDDING`	アプリID	アプリキー	広告ユニットID
MobileFuse	`MOBILEFUSE_NETWORK`	パブリッシャーID	⸺	プレースメントID
MobileFuse入札	`MOBILEFUSE_BIDDING`	⸺	⸺	プレースメントID
MobileFuseネイティブ入札	`MOBILEFUSE_NATIVE_BIDDING`	⸺	⸺	プレースメントID
Moloco入札	`MOLOCO_BIDDING`	⸺	アプリキー	広告ユニットID
Ogury	`OGURY_PRESAGE_NETWORK`	アセットキー	⸺	広告ユニットID
Ogury入札	`OGURY_PRESAGE_BIDDING`	アセットキー	⸺	広告ユニットID
Pangle	`TIKTOK_NETWORK`	アプリID	⸺	スロットID
Pangle入札	`TIKTOK_BIDDING`	アプリID	⸺	スロットID
Pangleネイティブ	`TIKTOK_NATIVE_NETWORK`	アプリID	⸺	スロットID
Pangleネイティブ入札	`TIKTOK_NATIVE_BIDDING`	アプリID	⸺	スロットID
PubMatic入札	`PUBMATIC_BIDDING`	パブリッシャーID	プロフィールID	広告ユニットID
Smaato	`SMAATO_NETWORK`	パブリッシャーID	⸺	広告スペースID
Smaato入札	`SMAATO_BIDDING`	パブリッシャーID	⸺	広告スペースID
Smaatoネイティブ入札	`SMAATO_NATIVE_BIDDING`	パブリッシャーID	⸺	広告スペースID
Tapjoy入札	`TAPJOY_NETWORK`	SDKキー	⸺	プレースメント名
Tencent	`TENCENT_NETWORK`	アプリID	⸺	広告スロットID
Unity Ads	`UNITY_NETWORK`	ゲームID	⸺	プレースメントID
Unity入札	`UNITY_BIDDING`	ゲームID	⸺	プレースメントID
Verve Group入札	`VERVE_BIDDING`	アプリトークン	⸺	ゾーンリファレンス
VK Ad Network	`MYTARGET_NETWORK`	⸺	⸺	プレースメントID
VK Ad Network入札	`MYTARGET_BIDDING`	⸺	⸺	プレースメントID
VK Ad Networkネイティブ入札	`MYTARGET_NATIVE_BIDDING`	⸺	⸺	プレースメントID
Yandex	`YANDEX_NETWORK`	⸺	⸺	ブロックID
Yandex入札	`YANDEX_BIDDING`	⸺	⸺	ブロックID
YSO Network入札	`YSO_BIDDING`	⸺	⸺	キー

¹ Mintegral / Mintegral入札には、追加のプレースメントIDを含めることができます。これは、トップレベルのオブジェクト内のextraParametersオブジェクトによってAPIで処理されます。 extraParametersオブジェクトには、このプレースメントIDの値を取得するフィールド、ad_network_optional_placement_idがあります。以下の例を参照してください。

{
  "MINTEGRAL_NETWORK": {
    "disabled": false,
    "targets": {},
    "ad_network_ad_units": [
      {
        "ad_network_ad_unit_id": "1232524",
        "extraParameters": null,
        "disabled": false,
        "cpm": "1.23",
        "countries": {
          "type": "INCLUDE",
          "values": []
        }
      }
    ],
    "ad_network_app_id": "testappId",
    "ad_network_app_key": "testappKey",
    "extraParameters": {
      "ad_network_optional_placement_id": "1234354"
    }
  }
}

ご利用規約 | プライバシー | EULA | DMCA | Cookie設定

Ad Unit Management API

/ad_unitエンドポイント

ターゲットURL

POST

リクエストボディー

レスポンスボディー

リクエスト/レスポンス ボディーフィールド一覧

/ad_unit/«ad-unit-ID»エンドポイント

ターゲットURL

例

GET

レスポンスボディー

POST

リクエストボディー

レスポンス

ad_network_settings配列

アドネットワークオブジェクト

ad_network_ad_unitsオブジェクト

countriesオブジェクト

frequency_capping_settingsオブジェクト

bid_floorsオブジェクト

banner_refresh_settingsオブジェクト

mrec_refresh_settingsオブジェクト

segmentオブジェクト

発生する可能性があるエラー

/ad_unitsエンドポイント

ターゲットURL

例

GET

レスポンスボディー

広告ユニットオブジェクト

発生する可能性があるエラー

/ad_unit_experiment/«ad-unit-ID»エンドポイント

ターゲットURL

例

GET

レスポンスボディー

POST

テスト作成のリクエストボディー

テスト作成のリクエストボディー

テスト非推奨化のリクエストボディー

テスト非推奨化レスポンスボディー

テスト昇格リクエストボディー

テスト昇格レスポンスボディー

広告ユニットテストオブジェクト

発生する可能性があるエラー

/test_deviceエンドポイント

ターゲットURL

例

リクエストボディー

レスポンスボディー

リクエスト/レスポンス ボディーフィールド一覧

/test_device/«test-device-ID»エンドポイント

ターゲットURL

例

ターゲットURL

GET

レスポンスボディー

POST

リクエストボディー

レスポンスボディー

/test_devicesエンドポイント

ターゲットURL

例

レスポンスボディー

複数のウォーターフォール

例

GET

POST

アドネットワーク

`/ad_unit`エンドポイント

`POST`

リクエスト/レスポンスボディーフィールド一覧

`/ad_unit/«ad-unit-ID»`エンドポイント

`GET`

`POST`

`ad_network_settings`配列

`ad_network_ad_units`オブジェクト

`countries`オブジェクト

`frequency_capping_settings`オブジェクト

`bid_floors`オブジェクト

`banner_refresh_settings`オブジェクト

`mrec_refresh_settings`オブジェクト

`segment`オブジェクト

`/ad_units`エンドポイント

`GET`

`/ad_unit_experiment/«ad-unit-ID»`エンドポイント

`GET`

`POST`

`/test_device`エンドポイント

リクエスト/レスポンスボディーフィールド一覧

`/test_device/«test-device-ID»`エンドポイント

`GET`

`POST`

`/test_devices`エンドポイント

`GET`

`POST`