实例 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  }]

创建

• 未设置“status”参数创建的实例将自动设置为“激活”
• 为不在应用商店中运行的应用程序创建的实例将自动设置为“非活动”
• 对于具有相同广告网络的实例，应用程序配置必须具有相同的值
• 对于自定义网络实例的创建，需要“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  }]

更新

方法

请求参数

请求示例 URL

支持的参数

请求示例

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

删除

• 无法删除默认实例。
• 无法恢复已删除的实例。

方法

请求的参数

请求示例 URL

支持的参数

请求正文示例

{    "ids": [1458, 5769]}

成功

报错

示例

{    "errorsArray": [        {            "code": ERR-402,            "errorMessage":"实例名称对于相同的广告格式和网络必须唯一",            "params": {                "instanceName": "abc"            }        }    ],    "code": 400}

API v3（以前版本）

获取实例

描述

身份验证类型

方法

必需参数

请求示例 URL

响应参数

JSON 响应示例

{  "appKey": "aa2209b1d",  "appName":“My Test app”，  "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",                  "英国"                ]              }            ],            "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",                  "英国"                ]              }            ],            "abVersion":"N/A"          }        ]      },      "networkBidderInstances": []    },    "banner": {      "activeNetworks": [],      "networkInstances": {        "ironSource": [          {            "id": 0,            "name": "Default",            "status": "inactive",            "abVersion":"N/A"          }        ]      }    }  }}

创建实例

• 未设置“status”参数创建的实例将自动设置为“激活”
• 为不在应用商店中运行的应用程序创建的实例将自动设置为“非活动”
• 对于聚合用户 - 每个新创建的实例都将包含在 app 的所有聚合组中。
• 每个 app 每个广告单元最多限制 10 个实例。要延长此限制，请联系支持人员或联系您的帐户经理。
• 要创建投标人网络，请联系支持人员或联系您的帐户经理。

CPM 定价

1. CPM 定价 (CPM Pricing) 允许您控制和灵活地定义 LevelPlay 网络的预期 CPM 速率。 在此处阅读更多信息。
2. CPM 定价仅适用于指定的帐户。要激活 CPM 定价，请联系支持人员或联系您的帐户经理。
3. 有关使用定价实例的最佳实践，请访问我们的最佳实践文章。

1. 要为实例设置全局定价，请使用星号角色“*”填充实例的国家/地区字段。
2. 未定价的实例和未定义定价的国家/地区将被设置为使用优化定价。
3. 根据 ISO 3166-1 Alpha-2，国家/地区定义基于两个字母的国家/地区代码

身份验证类型

方法

必需参数

可选参数

请求示例网址

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"      }    ]  }}

更新实例

• 更新调用的最大数量限制为每天 6 次。
• 为了激活非默认实例，必须首先激活默认实例（实例 ID=0）。
• 更新实例定价将仅替换同一实例上的所有定价值。
• 要更新投标人网络，请联系支持人员或联系您的帐户经理。
• 要删除实例级别速率，请添加具有空字字符串值的 速率 参数（例如“

身份验证类型

方法

必需参数

可选参数

请求示例网址

请求正文示例

{  "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. 每次调用可以删除一个实例。
2. 无法删除默认实例。
3. 无法恢复已删除的实例。
4. Response 包含 app 的所有实例（已删除的实例除外）。

身份验证类型

方法

必需参数

请求示例网址

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",              "英国"            ]          }        ]      }    ]  },  "banner": {    "ironSource": [      {        "id": 0,        "name": "Default",        "status": "inactive"      }    ]  }}