ironSource Exchange OpenRTB 2.5 规格

遵循 OpenRTB 2.5 规范，将您的 DSP 或广告平台与 ironSource Exchange 连接，以便进行程序化广告购买。

阅读时间18 分钟

最后更新于 4 天前

以下文章将说明 IronSource Exchange 支持的对象和参数，确保在查看规范时提供 OpenRTB 2.5 规范指南。

出价请求

请求对象

参数	Type（类型）	始终通过	描述
`id`	字符串	是	广告请求的唯一 ID。此 ID 必须在广告响应对象中返回。
`imp`	对象	是	ironSource 支持每个广告请求一个展示对象。请参阅展示。
`at`	整数	是	使用的拍卖类型。IronSource 仅支持首次价格拍卖。
`app`	对象	是	app程序描述。请参阅 app。
`device`	对象	是	设备描述。请参阅设备。
`user`	对象	是	用户描述。请参阅用户。
`tmax`	整数	是	IronSource 允许接收出价的最大时间（以毫秒为单位）。
`bcat`	字符串数组	是	使用 IAB 内容类别屏蔽广告主类别。
`badv`	字符串数组	否	按域代码块广告主列表
`bapp`	字符串数组	否	应用程序的代码块列表。在 Android 上，这些名称应为捆绑包或软件包名称（例如，com.foo.mygame）。在 iOS 上，这些是数字 ID。
`source`	对象	是	此音频源对象提供关于库存音频源的数据以及关于哪个实体做出最终决策的信息。
`regs`	对象	是	Regs 对象，用于指定针对该请求实施的任何行业法规、法律法规或政府法规。
`ext`	对象	否	指定的于 Ironsource 的 OpenRTB 扩展的占位符。

展示对象

参数	Type（类型）	始终通过	描述
`id`	字符串	是	ironSource 支持每个 Bid 请求中的单个展示对象。
`video`	对象	仅适用于视频	该对象用于描述视频展示。请参阅视频。
`banner`	对象	仅用于显示	对象用于描述显示展示。请参阅横幅。
`instl`	整数	否	1 = 插页式或全屏广告，0 = 非插页式广告。
`secure`	整数	是	ironSource 要求广告展示具有安全的 HTTPS 网址广告素材资源和标记。
`pmp`	对象	是	Pmp 对象包含对此展示特效的任何私有变量市场交易
`bidfloor`	浮起	是	此展示的最低出价（以 CPM 表示）。
`bidfloorcur`	字符串	是	IronSource 仅接受美元
`ext`	对象	否	指定的于 Ironsource 的 OpenRTB 扩展的占位符。

视频对象

参数	Type（类型）	始终通过	描述
`mimes`	字符串数组	是	支持的内容 MIME 类型。
`minduration`	整数	是	视频广告最小持续时间（以秒为单位）。
`maxduration`	整数	是	视频广告最大持续时间（以秒为单位）。
`protocols`	整数数组	是	受支持视频协议的数组
`w`	整数	是	视频播放器的宽度（以设备独立像素 (DIPS) 为单位）。
`h`	整数	是	视频播放器的高度（以设备独立像素 (DIPS) 为单位）。
`placement`	整数	是	展示的放置/位置类型。
`Skip`	整数	是	指示玩家是否允许跳过视频。
`battr`	整数数组	是	屏蔽的创意属性。
`playbackmethod`	整数	是	可能正在使用的播放方法。
`pos`	整数	是	广告在屏幕上的位置。
`api`	整数数组	是	此广告展示支持的 API 框架列表
`ext.rewarded`	整数	是	指示请求是否为奖励视频广告单元。1 = 是，0 = 否

参数	Type（类型）	始终通过	描述
`w`	整数	是	视频播放器的宽度（以设备独立像素 (DIPS) 为单位）。
`h`	整数	是	视频播放器的高度（以设备独立像素 (DIPS) 为单位）。
`pos`	整数	是	广告在屏幕上的位置。
`btype`	整数数组	是	屏蔽横幅广告类型。
`battr`	整数数组	是	屏蔽的创意属性。
`api`	整数数组	是	此广告展示支持的 API 框架列表

格式化对象

允许多种大小时使用。

参数	Type（类型）	始终通过	描述
`w`	整数	是	视频播放器的宽度（以设备独立像素 (DIPS) 为单位）。
`h`	整数	是	视频播放器的高度（以设备独立像素 (DIPS) 为单位）。

app程序对象

参数	Type（类型）	始终通过	描述
`id`	字符串	是	ironSource 指定的应用程序 ID
`bundle`	字符串	是	特定于平台的应用程序标识符。在 Android 上，这应该是捆绑包或软件包名称（例如，com.foo.mygame）。在 iOS 上，它通常是数字 ID。
`name`	字符串	是	应用程序名称
`storeurl`	字符串	是	App Store 网址
`cat`	字符串数组	是	app 的 IAB 内容类别

设备对象

参数	Type（类型）	始终通过	描述
`ua`	字符串	是	浏览器用户代理字符串。
`geo`	对象	是	设备的位置，假设为用户的当前位置，由 Geo 对象定义/
`lmt`	整数	是	“Limit Ad Tracking”信号，其中 0 = 跟踪不受限制，1 = 根据商业准则必须限制跟踪。
`ip`	字符串	是	最接近设备的 IPv4 地址。
`devicetype`	整数	是	设备的一般类型。
`make`	字符串	是	设备制造商。
`model`	字符串	是	设备模型。
`os`	字符串	是	操作系统
`osv`	字符串	是	操作系统版本
`language`	字符串	是	language 字符串浏览器语言，使用 ISO-639-1-Alpha-2。
`connectiontype`	整数	是	网络连接类型
`ifa`	字符串	是	已明确批准广告主使用的 ID（例如，未经过哈希）
`ext.ifv`	字符串	是	（仅限 iOS）由一个开发者分配给所有应用程序的供应商的标识符。列为 ifv 匹配 ifa 字段格式。
`ext.atts`	整数	是	（仅限 iOS）表示 app 的 app 跟踪授权状态，其中 0 = 未确定 1 = 受限 2 = 已拒绝 3 = 已授权

用户对象

参数	Type（类型）	始终通过	描述
`id`	字符串	是	用户指定的 ironSource ID
`ext.impdepth`	浮起	是	给定app会话中指定的广告放置/位置的展示量计数。会话结束时会重置展示深度。

音频源对象

参数	Type（类型）	始终通过	描述
`ext.schain`	对象	是	包含 Sellers.json 信息的 Schain 对象
`ext.schain.nodes`	对象数组	是	Publisher 的应用程序 Sellers.json 信息
`ext.header bidding`	Integer	是	指示瀑布流的类型，其中 1=出价，0=实例

Regs 对象

参数	Type（类型）	始终通过	描述
`ext.gdpr`	字符串	是	指定请求是否受 GDPR 法规的约束。

Geo 对象

参数	Type（类型）	始终通过	描述
`lat`	浮起	是	从 -90.0 到 +90.0 的纬度，其中负数为南。
`lon`	浮起	是	经度从 -180.0 到 +180.0，其中负值是西经度。
`type`	Integer	是	位置数据的音频源
`ipservice`	Integer	是	用于根据 IP 地址确定地理位置的服务或提供商（如果适用）
`country`	字符串	是	使用 ISO 的国家代码使用 ISO-3166-1-Alpha-3.3166-1-Alpha-3 的国家代码
`region`	字符串	是	使用 ISO-3166-2 的地区代码；2 字母状态代码（如果为美国）。
`metro`	字符串	是	Google 地铁代码。
`city`	字符串	是	使用联合国贸易和运输地点代码的城市。
`zip`	字符串	是	zip 字符串邮编或邮政代码。

出价响应

出价响应对象

参数	Type（类型）	要求	描述
`id`	字符串	必需	ironSource 请求 ID 必须回传给 Bid Response。
`cur`	字符串	必需	ironSource 仅支持 USD；任何其他 ISO 货币代码都会导致忽略广告响应。
`bidid`	字符串	推荐	出价者生成的响应 ID，有助于进行记录和追踪。
`nbr`	Integer	推荐	不出价的原因。请参阅 OpenRTB 2.3 规格中的清单 5.22。
`seatbid`	对象数组	推荐	一个响应中允许多个 seatbid 对象，但是 IronSource 目前仅使用一个 seatbid 对象。选择的 seatbid 对象将包含：bid.id = impression.id

席位出价对象

参数	Type（类型）	要求	描述
`bid`	对象数组	必需	IronSource 期望至少有一个出价。

Bid 对象

参数	Type（类型）	要求	描述
`id`	字符串	必需	出价者生成的出价 ID，有助于进行记录和追踪。
`impid`	字符串	推荐	此出价应用于的广告展示的 ID。该值与广告请求中提供的广告展示 ID 匹配。
`price`	浮起	必需	出价（以 CPM 为单位）。等于或小于零的值将被忽略。
`nurl`	字符串	推荐	竞价获胜时 ironSource 调用的获胜通知网址（不一定表示已投放、已观看或可计费的广告）。当 burl 不存在时，Nurl 将替换它，并报告账单通知。
`burl`	字符串	必需	当中标出价可计费时，由 ironSource 调用的计费通知 URL。
`lurl`	字符串	推荐	已知出价丢失时 ironSource 调用的丢失通知网址。IronSource 支持 `${MIN\_BID\_TO\_WIN}` 宏，用于指示赢得最终拍卖所需的最低出价。
`cid`	字符串	推荐	Campaign ID（广告系列 ID），用于协助进行广告品质检查。
`crid`	字符串	推荐	广告素材 ID，用于协助进行广告品质检查。
`adm`	字符串	必需	出价获胜时用于传达广告标记的必要手段。
`adomain`	字符串数组	必需（如果 bid.bundle=null）	用于黑名单检查的广告主域
`bundle`	字符串	必需（如果 bid.adomain=null）	特定于平台的应用程序标识符。在 Android 上，这应该是捆绑包或软件包名称（例如，“com.foo.mygame”）。在 iOS 上，它通常是数字 ID。
`cat`	字符串数组	推荐	广告素材的 IAB 内容类别。
`attr`	整数数组	推荐	描述广告素材的属性集。
`w`	Integer	必需	广告素材的宽度（以设备独立像素 (DIPS) 为单位）。
`h`	Integer	必需	广告素材的高度（以设备独立像素 (DIPS) 为单位）。

无广告响应

出价者可以使用以下任何将在 ironSource 中被视为“无出价”的内容进行响应。使用这些响应之一来明确表示您希望不对广告展示出价对于我们来说很重要，否则该响应可能会被认为是超时报错。

无出价（例如，无需求、无兴趣购买广告展示）：

HTTP 204 No Content
空 JSON 对象：“”
格式良好的无广告响应 (NBR)：
```
{"id": "1234567890", "seatbid": \[\]}
```
由于问题没有出价

格式良好的无广告响应：

{"id": "1234567890", "seatbid": \[\], "nbr": 2}

下面列出了可用于 nbr 的问题代码：

值	描述
0	未知错误
1	技术错误
2	无效请求
3	已知的网络蜘蛛
4	疑似非人为流量
5	Cload、数据中心或代理 IP
6	不支持的设备
7	被屏蔽的发布者
8	不匹配的用户

出价请求和响应示例

视频广告请求


{   id: "1627786837177779624\_a5850b20-f274-11eb-947b-0ded24f22667\_237775956\_client\_name",   imp: \[      {         id: "1",         视频：{Video            "mimes:\["               "video/mp4",               "video/3gpp",               "application/x-mpegURL"            \],            minduration：1,            maxduration：120,            protocols: \[               2,               5,               3,               6            \],            w:480,            h：320,            放置/位置：5,            skip：0,            playbackmethod：\[               5            \],            pos:7,            api: \[               7            \],            companiontype: \[               1,               2            \],            ext: { }               奖励：1            }         },         pmp: {            deals: \[               {                  id: "104v4ahb53bb5800016dqa9a",                  "bidfloor":8,                  bidfloorcur："USD"               }            \]         },         displaymanager: "ironsource",         "bidfloor":8,         bidfloorcur："USD",         secure：1      }   \],   app：{      id: "113551",      name: "Jetpack Joyride"      bundle："457446957",      "storeurl ⁇ https://itunes.apple.com/app/id457446957 ⁇       cat: \[         "IAB9"      \],      Publisher：{         id: "146249",         name: 「Halfbrick Studios Pty Ltd」      }   },   设备：{      ua:"Mozilla/5.0 (iPhone; CPU iPhone OS 14\_7\_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",      geo: { }         稍后：41.7405,         lon: \-87.6587,         type（类型）：2,         ipservice：3,         国家/地区："USA",         region："IL",         Metro:"602",         city:"芝加哥",         zip："60620"      },      lmt:0,      ip："74.93.69.246",      devicetype：4,      make："Apple",      model: "iPhone13,2",      os: "ios",      osv："14.7.1",      language: "es",      connectiontype:2,      ifa:"01234567-89ABCDEF-01234567-89ABCDEF",      ext: { }         acceptLang: "es-xl",         atts：3      }   },   用户：{      id: "01234567-89ABCDEF-01234567-89ABCDEF"   },   at:1,   tmax：996,   bcat: \[      "IAB23",      “IAB25”，      "IAB26",      "IAB8-18",      “IAB8-5”，      "IAB9-9",      "IAB11-4",      "IAB14-1",      "IAB14-3",      "IAB17-16",      "IAB9-7",      "IAB7-39",      "IAB3-7",      "IAB18-5"   \],   badv: \[      "bigo.tv"   \],   音频源：{      ext: { }         omidpn：“Ironsrc”，         omidpv："7",         schain：{schain            ver:"1.0",            完成：1,            nodes: \[               {                  asi: "ironsrc.com",                  sid："146249",                  hp：1,                  rid："1627786837177779624\_a5850b20-f274-11eb-947b-0ded24f22667\_237775956\_client\_name",                  name: 「Halfbrick Studios Pty Ltd」                  domain: "halfbrick.com"               }            \]         }      }   },   "regs": {}}

显示出价请求


{   id: "1627791578182182085\_af5e8df0-f27f-11eb-9a60-f72fd6932f89\_1452093813\_client\_name\_b",   imp: \[      {         id: "1",         banner：{            w:320,            h：480,            btype: \[               1,               4            \],            battr: \[               3,               6,               7,               8,               9,               14,               10            \],            pos:7,            api: \[               5,               3,               7            \]         },         displaymanager: "ironsource",         instl：1,         "bidfloor":1.6,         bidfloorcur："USD",         secure：1      }   \],   app：{      id: "318613",      name: “Subway Surfers（非 COPPA）”，      bundle: "com.kiloo.subwaysurf",      "storeurl ⁇ https://play.google.com/store/apps/details?id=com.kiloo.subwaysurf ⁇       cat: \[         "IAB9"      \],      Publisher：{         id: "235297",         name: "SYBO 游戏"      }   },   设备：{      ua:"Mozilla/5.0 (Linux; Android 6.0.1; SM-G532M 构建/MMB29T; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/92.0.4515.115 移动端 Safari/537.36",      geo: { }         稍后：19.3617,         lon: \-98.2338,         type（类型）：2,         ipservice：3,         国家/地区："MEX",         region："TLA",         Metro:"0",         city:"Tlaxcala City",         zip："90000"      },      lmt:0,      ip："189.167.5.112",      devicetype：4,      make: "samsung",      模型："SM-G532M",      os: "android",      osv："6.0.1",      js：1,      language: "es",      connectiontype:2,      ifa:"01234567-89ABCDEF-01234567-89ABCDEF"   },   用户：{      id: "01234567-89ABCDEF-01234567-89ABCDEF"   },   at:1,   tmax：998,   bcat: \[      "IAB23",      “IAB25”，      "IAB26",      "IAB8-18",      “IAB8-5”，      "IAB9-9",      "IAB11-4",      "IAB14-1",      "IAB14-3",      "IAB17-16",      "IAB9-7",      "IAB7-39",      "IAB3-7",      "IAB18-5"   \],   badv: \[      "caliente.mx",      "yoox.com",      "wine.com.br"   \],   音频源：{      ext: { }         omidpn：“Ironsrc”，         omidpv："7",         schain：{schain            ver:"1.0",            完成：1,            nodes: \[               {                  asi: "ironsrc.com",                  sid："235297",                  hp：1,                  rid："1627791578182182085\_af5e8df0-f27f-11eb-9a60-f72fd6932f89\_1452093813\_client\_name\_b",                  name: “SYBO Games”，                  domain: "sybogames.com"               }            \]         }      }   },   "regs": {}}


{   id: "1627783392367073418\_a03b6950-f26c-11eb-a9af-31ac778e44a2\_1539835153\_client\_name",   imp: \[      {         id: "1",         banner：{            format: \[               {                  w:320,                  h：50               },               {                  w:300,                  h：50               }            \],            w:320,            h：50,            pos:5,            api: \[               5,               3            \]         },         displaymanager: "ironsource",         tagid："2708683",         "bidfloor":0.0128,         bidfloorcur："USD",         secure：1      }   \],   app：{      id: "353553",      name: “Tile Connect - Classic 匹配 游戏”，      bundle："1529839083",      "storeurl ⁇ https://itunes.apple.com/app/id1529839083 ⁇       cat: \[         "IAB9"      \],      Publisher：{         id: "249491",         name: "希格斯科技有限公司"      }   },   设备：{      ua:"Mozilla/5.0 (iPhone; CPU iPhone OS 14\_6 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148","      geo: { }         稍后：39.9357,         lon: \-75.1832,         type（类型）：2,         ipservice：3,         国家/地区："USA",         region："PA",         Metro:"504",         city:"费城",         zip："19146"      },      lmt:0,      ip："76.98.251.72",      devicetype：4,      make："Apple",      model: "iPhone9,2",      os: "ios",      osv："14.6.0",      language ⁇ en",      connectiontype:2,      ifa:"01234567-89ABCDEF-01234567-89ABCDEF",      ext: { }         acceptLang: "en-us",         atts：3      }   },   用户：{      id: "01234567-89ABCDEF-01234567-89ABCDEF"   },   at:1,   tmax：996,   bcat: \[      "IAB23",      “IAB25”，      "IAB26",      "IAB8-18",      “IAB8-5”，      "IAB9-9",      "IAB11-4",      "IAB14-1",      "IAB14-3",      "IAB17-16",      "IAB9-7",      "IAB7-39",      "IAB3-7",      "IAB18-5"   \],   badv: \[      "gratonresortcasino.com"   \],   音频源：{      ext: { }         schain：{schain            ver:"1.0",            完成：1,            nodes: \[               {                  asi: "ironsrc.com",                  sid："249491",                  hp：1,                  rid："1627783392367073418\_a03b6950-f26c-11eb-a9af-31ac778e44a2\_1539835153\_client\_name",                  name: "希格斯科技有限公司",                  domain: "higgsgamestudio.com"               }            \]         }      }   },   "regs": {}}

大量广告响应


{   id: "1543190416705343377\_ip-172-31-13-147\_41965ed0-f10e-11e8-b7cd-fd40aa7b8b5f",   seatbid：\[      {         bid: \[            {               id: "opp\_100",               impid: "opp\_100",               price：15,               adm："VAST\_XML",               adomain：\[                  "AD\_DOMAIN"               \],               cid："6b3gxrn",               crid: "aqgwb3x7"            }         \],         seat:"2821"      }   \],   cur:"USD"}

显示插页式广告响应


{   id: "1543190412223390473\_ip-172-31-13-147\_3eea9fc0-f10e-11e8-9915-1beb61037050",   seatbid：\[      {         bid: \[            {               id: "46-45347979-4f8b-4547-8376-2cea2c3ac12a-1",               impid: "opp\_100",               price：9.9906,               nurl："NURL\_PIXEL",               adm：“CREATIVE”，               adomain：\[                  ""               \],               cid："143354",               crid："46\_10304614",               dealid："20135c3f564b7bd7dd138a480427a69f",               w:320,               h：480,               ext: { }                  agency\_name:"NAME"               }            }         \],         seat:"6"      }   \],   cur:"USD"}


{   id: "1617285225335329365\_ad0f3240-92f1-11eb-9667-c36f23277c0b\_client-banner",   seatbid：\[      {         bid: \[            {               id: "b0f43c8b-d009-4cb2-adb5-1c2782400b35",               impid: "opp\_100",               price：0.51,               nurl："NURL\_PIXEL",               "burl": ""BURL\_PIXEL",               adm："CREATIVE\_ADM",               adomain：\[                  ""               \],               crid："123456789",               w:320,               h：50            }         \]      }   \],   cur:"USD"}

ironSource Exchange OpenRTB 2.5 规格

出价请求

请求对象

参数

Type（类型）

始终通过

描述

展示对象

参数

Type（类型）

始终通过

描述

视频对象

参数

Type（类型）

始终通过

描述

Banner 对象

参数

Type（类型）

始终通过

描述

格式化对象

参数

Type（类型）

始终通过

描述

app程序对象

参数

Type（类型）

始终通过

描述

设备对象

参数

Type（类型）

始终通过

描述

用户对象

参数

Type（类型）

始终通过

描述

音频源对象

参数

Type（类型）

始终通过

描述

Regs 对象

参数

Type（类型）

始终通过

描述

Geo 对象

参数

Type（类型）

始终通过

描述

出价响应

出价响应对象

参数

Type（类型）

要求

描述

席位出价对象

参数

Type（类型）

要求

描述

Bid 对象

参数

Type（类型）

要求

描述

无广告响应

值

描述

出价请求和响应示例

视频广告请求

显示出价请求

页脚广告请求