インスタンス API v4

• CRUD のサポート
• 広告ネットワークのアプリケーションレベル構成の変更
• ウォーターフォールグループへのインスタンスの追加または削除 (アクティブな AB テストアプリケーションのサポート)

レート制限

認証タイプ

GET

説明

メソッド

リクエストパラメーター

リクエストの URL 例

反応パラメータ

反応例

[  {    "instanceId":1072562,    "instanceName": "",    "adUnit": "rewardedVideo",    "adFormat": "rewarded",    "networkName": "unityAds",    "appConfig1": "qtr",    "instanceConfig1": "trb",    "isBidder": true,    "groups": [101663],    "isLive": true  },  {    "instanceId":1014428,    "instanceName":"Default",    "adUnit": "interstitial",    "adFormat": "interstitial",    "networkName": "unityAds",    "appConfig1": "qertb",    "instanceConfig1": "qtrb",    "isBidder": false,    "groups": [101664],    "isLive": true,    "rate":25  },  {    "instanceId":1845809,    "instanceName":"Default",    "adUnit": "rewardedVideo",    "adFormat": "rewarded",    "networkName": "adManager",    "appConfig1": "bqw",    "instanceConfig1": "qqr",    "isBidder": false,    "groups": [101663 ],    "isLive": true,    "rate":4  }]

作成

• 「状態」パラメーターの設定なしで作成されたインスタンスは、自動的に「アクティブ」に設定されます。
• ストアで公開されていないアプリ用に作成されたインスタンスは自動的に「非アクティブ」に設定されます。
• アプリケーション設定は同じ広告ネットワークのインスタンスに対して同じ値にする必要があります
• カスタムのネットワークワークインスタンスを作成する場合は、'networkKey' パラメーターが必要です。これはネットワークワークのドキュメントで確認できます。

メソッド

リクエストパラメーター

リクエストの URL 例

サポートされているパラメーター

リクエスト例

[  {      "instanceName": "newInstance",           "networkName": "unityAds",      "adUnit": "rewardedVideo",      "isBidder": true,      "appConfig1":"414n"      "instanceConfig1": "aaa1",      "instanceConfig2": "aaa1",      "groups": [12345],      "isLive": true  },  {      "instanceName": "newInstance_2",           "networkName": "unityAds",      "adFormat": "rewarded",      "isBidder": false,      "appConfig1":"414n"      "instanceConfig1": "bbb1",      "groups": [12345],      "isLive": true,      "rate":5  }]

update

メソッド

リクエストパラメーター

リクエストの URL 例

サポートされているパラメーター

リクエスト例

[  {      "instanceId":122,      "instanceName": "newInstance",      "appConfig1":"414n"      "instanceConfig1": "aaa1",      "instanceConfig2": "aaa1",      "groups": [1],      "isLive": true,      "rate":2  }]

DELETE

• デフォルト インスタンスは削除できません。
• 削除されたインスタンスは復元できません。

メソッド

リクエストされたパラメーター

リクエストの URL 例

サポートされているパラメーター

リクエスト ボディ例

{    "ids": [1458, 5769]}

Success

エラー

例

{    "errorsArray": [        {            "code": ERR-402、            "errorMessage":"インスタンス名は、同じ広告形式とネットワークで一意のものでなければなりません。",            "params": {                "instanceName": "abc"            }        }    ],    "code": 400}

API v3 (以前のバージョン)

インスタンスの取得

説明

認証タイプ

メソッド

必須パラメーター

リクエストの URL 例

反応パラメータ

JSON 反応例

{  "appKey": "aa2209b1d",  "appName":"マイテストアプリケーション",  "appStatus": "active",  "platform":"Android",  "bundleId": "com.test.app",  "creationDate":N/A  "adUnits": {    "rewardedVideo": {      "activeNetworks": [        "ironSource",        "AdColony"      ],      "activeBidderNetworks": [        ""      ],      "networkInstances": {        "ironSource": [          {            "id": 0,            "name": "Default",            "status": "active",            "pricing": [              {                "eCPM":"10.5",                "Countries": [                  "FR",                  "UK"                ]              }            ],            "abVersion":N/A          }        ],        "AdColony": [          {            "id": 0,            "zoneId": "zone_ID_US_High",            "name": "US_high",            "status": "active",            "rate":87,            "abVersion":N/A          },          {            "id": 2851429,            "zoneId": "zone_ID_US_Low",            "name": "US_Low",            "status": "active",            "rate":12,            "abVersion":N/A          }        ]      },      "networkBidderInstances": []    },    "offerWall": {      "activeNetworks": [        "ironSource"      ]    },    "interstitial": {      "activeNetworks": [],      "activeBidderNetworks": [],      "networkInstances": {        "ironSource": [          {            "id": 0,            "name": "Default",            "status": "inactive",            "pricing": [              {                "eCPM":"8.5",                "Countries": [                  "FR",                  "UK"                ]              }            ],            "abVersion":N/A          }        ]      },      "networkBidderInstances": []    },    "banner": {      "activeNetworks": [],      "networkInstances": {        "ironSource": [          {            "id": 0,            "name": "Default",            "status": "inactive",            "abVersion":N/A          }        ]      }    }  }}

インスタンスの作成

• '状態' パラメーターが設定されていないインスタンスは、自動的に 'active' に設定されます。
• ストアで公開されていないアプリ用に作成されたインスタンスは、自動的に非アクティブに設定されます。
• メディエーションユーザーの場合 - 新しく作成された各インスタンスは、アプリケーションのすべてのメディエーショングループに含まれます。
• 各アプリケーションは、広告単位あたり最大10インスタンスに制限されています。この制限を拡張するには、サポート接触またはアカウントマネージャに接触してください。
• 入札者ネットワークを作成するには、サポート接触またはアカウントマネージャに接触。

CPM の価格設定

1. CPM Pricing (CPM 価格設定) では、LevelPlay ネットワークから期待される CPM レートをコントロールおよび柔軟に定義できます。 詳細については、こちらを参照してください。
2. CPM 価格は、特定のアカウントに対してのみ使用できます。CPM 価格設定をアクティベートするには、サポート接触またはアカウントマネージャーに接触してください。
3. インスタンスの価格設定に関するベスト プラクティスについては、ベスト プラクティス記事を参照してください。

1. インスタンスのグローバル価格を設定するには、インスタンスの国フィールドにアスタリスク文字「*」を入力します。
2. 価格設定なしで作成されたインスタンスと定義された価格設定のない国は、最適化された価格設定を使用するように設定されます。
3. 国は、ISO 3166-1 アルファ 2 に従って、2 文字の国名コードに基づいて定義されます

認証タイプ

メソッド

必須パラメーター

任意パラメータ

リクエスト URL 例

https://platform.ironsrc.com/partners/publisher/instances/v3

リクエスト ボディ例

{  "appKey": "d11a21a5",  "configurations": {    "ironSource": {      "interstitial": [        {          "instanceName": "low_interstitial",          "status": "active",          "pricing": [            {              "country": [                "FR",                "DE"              ],              "eCPM":3            }          ],          "pricingType": "eCPM"        },        {          "instanceName": "high_interstitial",          "status": "active",          "pricing": [            {              "country": [                "IL",                "US"              ],              "eCPM":20            }          ]        }      ]    },    "adColony": {      "rewardedVideo": [        {          "instanceName": "adcolony_rv",          "status": "active",          "zoneId":102030,          "rate":10        }      ]    }  }}

JSON 反応例

{  "rewardedVideo": {    "AdColony": [      {        "id": 6701121,        "zoneId":"102030",        "name": "adcolony_rv",        "status": "active",        "rate":10,        "abVersion":N/A      }    ]  },  "interstitial": {    "ironSource": [      {        "id": 0,        "name": "Default",        "status": "active",        "abVersion":N/A      },      {        "id": 6701117,        "name": "low_interstitial",        "status": "active",        "abVersion":N/A        "pricing": [          {            "eCPM":3,            "Countries": [              "FR",              "DE"            ]          }        ]      },      {        "id": 6701119,        "name": "high_interstitial",        "status": "active",        "abVersion":N/A        "pricing": [          {            "eCPM":20,            "Countries": [              "IL",              "US"            ]          }        ]      }    ],    "ironSourceBidding": [      {        "id": 2948695,        "name": "",        "status": "inactive",        "abVersion":N/A      }    ]  }}

インスタンス更新

• 更新コールの最大数は 1 日あたり 6 に制限されています。
• デフォルト以外のインスタンスをアクティベートするには、まずデフォルト インスタンス（インスタンス ID＝0）をアクティベートする必要があります。
• インスタンスの価格を更新すると、同じインスタンスのすべての価格値が置き換えられます。
• 入札者ネットワークを更新するには、サポートに接触するか、アカウントマネージャにお問い合わせください。
• インスタンスレベルのレートを削除するには、空の文字文字列 (例えば "") で rate パラメーターを追加します。

認証タイプ

メソッド

必須パラメーター

任意パラメータ

リクエスト URL 例

リクエスト ボディ例

{  "appKey":"6bc83099",  "configurations": {    "ironSourceBidding": {      "rewardedVideo": [        {          "instanceId":327,          "status": "inactive"        }      ]    }  }}

JSON 反応例

{  "rewardedVideo": {    "ironSource": [      {        "id": 0,        "name": "Default",        "status": "inactive",        "abVersion":N/A      }    ],    "AdColony": [      {        "id": 0,        "name": "default",        "status": "active",        "abVersion":N/A      },      {        "id": 326,        "name": "lw",        "status": "inactive",        "rate":"2",        "abVersion":N/A      }    ],    "ironSourceBidding": [      {        "id": 327,        "name": "-",        "status": "inactive",        "abVersion":N/A      }    ]  },  "interstitial": {    "ironSource": [      {        "id": 0,        "name": "Default",        "status": "active",        "abVersion":N/A      }    ]  },  "banner": {    "ironSource": [      {        "id": 0,        "name": "Default",        "status": "inactive",        "abVersion":N/A      }    ]  }}

インスタンスの削除

説明

1. 呼び出しごとに 1 つのインスタンスを削除できます。
2. デフォルト インスタンスは削除できません。
3. 削除されたインスタンスは復元できません。
4. 反応には、削除されたインスタンスを除くすべてのアプリケーションのインスタンスが含まれます。

認証タイプ

メソッド

必須パラメーター

リクエスト URL 例

JSON 反応例

{  "rewardedVideo": {    "ironSource": [      {        "id": 0,        "name": "Default",        "status": "active"      },      {        "id": 45678,        "name": "thirdRVInstance",        "status": "inactive"      }    ]  },  "interstitial": {    "ironSource": [      {        "id": 0,        "name": "Default",        "status": "active"      },      {        "id": 23456,        "name": "secondISInstance",        "status": "active",        "pricing": [          {            "eCPM":"0.01",            "Countries": [              "FR",              "UK"            ]          }        ]      }    ]  },  "banner": {    "ironSource": [      {        "id": 0,        "name": "Default",        "status": "inactive"      }    ]  }}