竞价请求由一个竞价请求对象、至少一个展示对象和一些提供展示上下文的其他对象组成。
imp.tagid 或 `< placement ID>` 中使用有效的广告位 ID imp.ext.placementid。您必须至少输入其中一个参数值。InMobi 提供全面的数据压缩支持,可有效减小传输数据的大小。压缩功能既可用于交易所或发布商发送的竞价请求,也可用于竞价方返回的竞价响应。更多信息,请参阅OpenRTB API 规范版本。
要指示传输 gzip 压缩的竞价请求,请设置以下标头:
<span class="hljs-attr">content-encoding:</span> <span class="hljs-string">gzip</span>
要请求压缩响应,请在请求中包含以下标头:
<span class="hljs-attr">accept-encoding:</span> <span class="hljs-string">gzip</span>
以下表格列出了 InMobi 根据 IAB OpenRTB API 规范版本 2.5 支持的请求参数。
|
属性 |
范围 |
类型 |
描述 |
|
ID |
必需的 |
细绳 |
交易所提供的竞价请求的唯一标识符。 |
|
重要 |
必需的 |
对象数组 |
Imp 对象数组(3.2.4 节)表示提供的展示次数。至少需要一个 Imp 对象。我们支持 [1 个视频对象] 和 [1 个横幅对象,1 个视频对象] |
|
应用程序 |
必需的 |
目的 |
通过 App 对象(3.2.14 节)获取发布商应用的详细信息。这是必需的,因为当前版本仅支持应用内变现。 |
|
设备 |
必需的 |
目的 |
通过设备对象(第 3.2.18 节)获取有关用户设备的详细信息,该设备将接收广告。 |
|
用户 |
受到推崇的 |
目的 |
通过用户对象(第 3.2.20 节)获取有关设备的用户(即广告受众)的详细信息。 |
|
tmax |
选修的 |
整数 |
交易所允许接收报价的最长时间(以毫秒为单位),包括互联网延迟以避免超时。 |
| bcat | 选修的 | 字符串数组 | 使用 IAB 内容分类屏蔽的广告商类别。更多信息,请参阅OpenRTB2.5的表 5.1 。 |
| badv | 选修的 | 字符串数组 | 按域名屏蔽广告商列表(例如,“ford.com”)。 |
|
来源 |
选修的 |
目的 |
提供库存来源数据的源对象(第 3.2.2 节) |
| 法规
|
选修的 |
目的 |
法规对象(第 3.2.3 节)规定了针对此请求生效的任何行业、法律或政府法规。 |
|
外部 |
选修的 |
目的 |
OpenRTB 交易所特定扩展的占位符(如有) |
|
范围 |
范围 |
类型 |
描述 |
|
pchain |
受到推崇的 |
细绳 |
支付 ID 链字符串包含 TAG 支付 ID 协议 v1.0 中描述的嵌入式语法。 |
|
ext.omidpn |
选修的 |
细绳 |
OM SDK 集成的标识符。这与 OMID 合作伙伴对象的“名称”参数相同。 |
|
ext.omidpv |
选修的 |
细绳 |
OM SDK 集成的标识符。这与 OMID 合作伙伴对象的“名称”参数相同。 |
|
外部链 |
选修的 |
目的 |
它代表供应链中的各个环节,同时也是衡量供应链是否完整的指标。 |
|
范围 |
范围 |
类型 |
描述 |
|
完全的 |
必需的 |
整数 |
指示链是否包含所有参与交易的节点,这些节点最终指向网站、应用程序或其他库存媒介的所有者,其中 0 = 否,1 = 是。 |
|
节点 |
必需的 |
对象数组 |
一个按供应链顺序排列的 SupplyChainNode 对象数组。在完整的供应链中,第一个节点代表初始广告系统和交易中涉及的卖家 ID。在不完整的供应链中,它代表第一个已知的节点。最后一个节点代表发送此竞价请求的实体。 |
|
版本 |
必需的 |
细绳 |
供应链规范版本:“1.0” |
|
范围 |
范围 |
类型 |
描述 |
|
亚西 |
必需的 |
细绳 |
竞价方连接的SSP、交易平台、标头包装器等系统的规范域名。如果存在ads.txt文件,则此值应与其中用于标识卖家的值相同。 |
|
侧 |
必需的 |
细绳 |
该标识符与广告系统中的卖家或经销商帐户关联。 其长度应限制为 64 个字符。 |
|
领域 |
选修的 |
细绳 |
该节点表示该实体的企业域名。 |
|
惠普 |
必需的 |
整数 |
指示此节点是否会参与库存支付流程。对于当前版本,该值应始终为“1 ”。 |
|
范围 |
范围 |
类型 |
描述 |
|
西班牙裔美国人 |
选修的 |
整数 |
指示此请求是否受美国联邦贸易委员会制定的 COPPA 法规约束的标志,其中 0 = 否,1 = 是。 |
|
外部 |
选修的 |
目的 |
OpenRTB 交易所特定扩展的占位符。 |
|
ext.gdpr |
选修的 |
整数 |
指示该请求是否受 GDPR 约束,其中 0 表示否,1 表示是 |
| gpp | 选修的 | 细绳 | 根据 IAB 指南传递 GPP 字符串。这提供了符合全球隐私法规的隐私相关信号。 |
|
范围 |
范围 |
类型 |
描述 |
|
ID |
必需的 |
细绳 |
在竞价请求的上下文中,此展示的唯一标识符(通常从 1 开始递增) |
|
横幅 |
横幅广告展示所需信息 |
目的 |
横幅对象(第 3.2.6 节);如果此次展示是横幅广告机会,则此项为必填项 |
|
视频 |
视频曝光量所需 |
目的 |
视频对象(第 3.2.7 节);如果此次展示是视频广告机会,则此项为必填项 |
|
显示管理器 |
选修的 |
细绳 |
广告服务器/竞价方/交易平台/渠道的名称。 |
|
显示管理器 |
选修的 |
细绳 |
广告服务器/中介平台的版本(如有) |
|
实施 |
选修的 |
整数 |
1 = 广告为插屏式或全屏式,0 = 非插屏式 |
|
标签 ID |
必需的 |
细绳 |
此字段应填写InMobi位置 ID |
|
竞价底线 |
选修的 |
漂浮 |
本次展示的最低出价以CPM(每千次展示费用)表示。 |
|
安全的 |
选修的 |
整数 |
此标志用于指示展示是否需要安全的 HTTPS URL 素材和标记,其中 0 表示不安全,1 表示安全。如果省略此标志,则安全状态未知,但 |
|
经验 |
选修的 |
整数 |
关于拍卖和实际曝光之间可能间隔的秒数的提示。 |
|
外部 |
选修的 |
目的 |
OpenRTB 交易所特定扩展的占位符。 |
|
ext.placementid |
选修的 |
整数 |
这是一个 InMobi 特有的扩展。此扩展可替代 'imp.tagid'。InMobi 要求 'imp.tagid' 或 'imp.ext.placementid' 中必须包含有效的广告位 ID。'imp.tagid ' 和 'imp.ext.placementid' 二者必选其一。 |
InMobi 支持 SKAdNetwork 4.0 及更高版本。
|
属性 |
范围 |
类型 |
描述 |
|
版本 |
选修的 |
细绳 |
skadnetwork 支持的版本最高为“4.0”。 |
|
版本 |
选修的 |
字符串数组 |
包含支持的 skadnetwork 版本(最高为 ["4.0"])的字符串数组。 |
|
源应用程序 |
必需的 |
细绳 |
苹果应用商店中发布商应用的 ID。应与“app.bundle”匹配。 |
|
skadnetids |
必需的 |
字符串数组 |
发布商应用 Info.plist 文件中与出价请求相关的 SKAdNetworkItem 条目子集,以小写字符串形式表示。 |
| skadnetlist | 选修的 | 目的 | 将在后续版本中支持。 |
|
产品页面 |
选修的 |
整数 |
支持自定义产品页面。详情请参阅 Apple 的自定义产品页面文档。例如:“productpage”:1 |
更多信息请参见SKAdNetwork。
|
范围 |
范围 |
类型 |
描述 |
|
西 |
受到推崇的 |
整数 |
以设备无关像素 (DIP) 为单位的精确宽度; |
|
h |
受到推崇的 |
整数 |
设备无关像素 (DIP) 的精确高度; |
|
格式 |
受到推崇的 |
对象数组 |
表示允许的横幅尺寸的格式对象数组(参见 3.2.10 节)。 |
|
ID |
选修的 |
细绳 |
此横幅对象的唯一标识符(可选) |
|
电池 |
选修的 |
整数数组 |
受阻的创造力属性 |
|
位置 |
选修的 |
整数 |
屏幕上的广告位 |
|
哑剧演员 |
选修的 |
字符串数组 |
支持的内容 MIME 类型。请参阅OpenRTB2.5。 |
|
顶框 |
选修的 |
整数 |
指示横幅是否位于顶部框架而不是 iframe 中,其中 0 = 否,1 = 是。 |
|
API |
选修的 |
整数数组 |
此展示支持的 API 框架列表。API 值 [7] 用于指示支持 OMID-1。请参阅OpenRTB2.5。 |
|
范围 |
范围 |
类型 |
描述 |
|
哑剧演员 |
必需的 |
字符串数组 |
支持的内容 MIME 类型。请参阅OpenRTB2.5。 |
|
心智 |
受到推崇的 |
整数 |
视频广告最短播放时长(秒)。 |
|
最大持续时间 |
受到推崇的 |
整数 |
视频广告最长播放时长(秒)。 |
|
协议 |
受到推崇的 |
整数数组 |
支持的视频协议列表。请参阅 oRTB 2.5 文档中的列表 5.8。 |
|
西 |
必需的 |
整数 |
视频播放器的宽度(以设备无关像素 (DIP) 为单位)。 |
|
h |
必需的 |
整数 |
视频播放器的高度(以设备无关像素 (DIP) 为单位)。 |
|
启动延迟 |
受到推崇的 |
整数 |
表示启动延迟时间(秒)。 |
|
线性 |
选修的 |
整数 |
指示印象必须是线性的、非线性的等等。如果未指定,则假定所有形式都允许。 |
|
跳过 |
选修的 |
整数 |
表示播放器是否允许跳过视频,其中 0 = 否,1 = 是。 |
|
跳过 |
选修的 |
整数 |
总时长超过此秒数的视频可以跳过。 |
|
电池 |
选修的 |
整数数组 |
受阻的创造力属性 |
|
伴侣广告 |
选修的 |
对象数组 |
Banner 对象数组 |
|
API |
选修的 |
整数数组 |
此展示支持的 API 框架列表。更多信息,请参阅 OpenRTB2.5。API值 |
|
伴侣型 |
选修的 |
整数数组 |
支持的 VAST 配套广告类型。请参阅OpenRTB2.5。 |
|
外部 |
选修的 |
目的 |
|
|
外部奖励 |
选修的 |
整数 |
指示视频是否以激励视频形式播放,其中 1 表示激励视频,0 表示非激励视频。 |
|
范围 |
范围 |
类型 |
描述 |
|
西 |
受到推崇的 |
整数 |
宽度以设备无关像素 (DIP) 为单位。 |
|
h |
受到推崇的 |
整数 |
以设备无关像素 (DIPS) 为单位的高度。 |
|
比率 |
选修的 |
整数 |
以比率表示尺寸时的相对宽度。 |
|
赫拉蒂奥 |
选修的 |
整数 |
用比例表示尺寸时的相对高度。 |
|
妇女 |
选修的 |
整数 |
设备无关像素 (DIPS) 的最小宽度 |
|
范围 |
范围 |
类型 |
描述 |
|
ID |
受到推崇的 |
细绳 |
交易所特定站点 ID |
|
姓名 |
选修的 |
细绳 |
网站名称(可能应出版商要求使用别名) |
|
领域 |
选修的 |
细绳 |
网站的域名(例如,“mysite.foo.com”)。 |
|
猫 |
选修的 |
细绳 |
网站的 IAB 内容类别列表 |
|
页 |
选修的 |
细绳 |
展示广告的页面网址。 |
|
移动的 |
受到推崇的 |
整数 |
指示网站是否已进行编程以优化在移动设备上查看时的布局,其中 0 = 否,1 = 是。 |
|
范围 |
范围 |
类型 |
描述 |
|
捆 |
选修的 |
细绳 |
平台特定的应用程序标识符,旨在确保每个应用程序的唯一性,并且独立于应用程序交易所。在 Android 系统中,这应该是程序包名称(例如 com.foo.mygame)。 |
|
领域 |
选修的 |
细绳 |
应用程序的域名(例如,“mygame.foo.com”)。 |
|
商店网址 |
选修的 |
细绳 |
已安装应用的 App Store URL;符合 IQG 2.1 标准。 |
|
猫 |
选修的 |
字符串数组 |
应用的 IAB 内容类别列表。更多信息,请参阅OpenRTB2.5的列表 5.1。 |
|
内容 |
选修的 |
目的 |
应用程序内内容详情(第 3.2.16 节)。 |
|
范围 |
范围 |
类型 |
描述 |
|
ID |
选修的 |
细绳 |
用于唯一标识内容的ID。 |
|
插曲 |
选修的 |
整数 |
剧集编号 |
|
标题 |
选修的 |
细绳 |
内容标题 |
|
系列 |
选修的 |
细绳 |
内容系列 |
|
季节 |
选修的 |
细绳 |
内容季 |
|
艺术家 |
选修的 |
细绳 |
内容作者署名:艺术家。 |
|
类型 |
选修的 |
细绳 |
最能描述内容的类型。 |
|
专辑 |
选修的 |
细绳 |
内容所属的专辑 |
|
ISRC |
选修的 |
细绳 |
符合 ISO3901 标准的国际标准记录代码 |
|
制作人 |
选修的 |
细绳 |
内容生产者详情(第 3.2.17 节)。 |
|
网址 |
选修的 |
细绳 |
内容的 URL,供买方进行背景分析或审核。 |
|
猫 |
选修的 |
字符串数组 |
用于描述内容生产者的 IAB 内容类别列表。请参阅 OpenRTB2.5。 |
|
产品 |
选修的 |
整数 |
生产质量 |
|
视频质量 |
选修的 |
整数 |
视频质量 |
|
语境 |
选修的 |
细绳 |
内容类型(游戏、视频、文本等) |
|
内容评级 |
选修的 |
细绳 |
内容评级 |
|
用户评分 |
选修的 |
细绳 |
用户对内容的评分 |
|
qagmediarating |
选修的 |
整数 |
根据 IQG 指南进行媒体评级。 |
|
关键词 |
选修的 |
细绳 |
用逗号分隔的关键词列表,用于描述内容。 |
|
直播 |
选修的 |
整数 |
0 = 非直播,1 = 内容直播 |
|
来源关系 |
选修的 |
整数 |
0 = 间接,1 = 直接。 |
|
镜头 |
选修的 |
整数 |
内容长度(秒) |
|
语言 |
选修的 |
细绳 |
内容语言采用 ISO-639-1-alpha-2。 |
|
可嵌入的 |
选修的 |
整数 |
指示内容是否可嵌入(例如,可嵌入的视频播放器),其中 0 = 否,1 = 是。 |
|
范围 |
范围 |
类型 |
描述 |
|
ID |
选修的 |
细绳 |
内容生产者或发起者 ID。 |
|
姓名 |
选修的 |
细绳 |
内容制作方或原创方名称(例如,“华纳兄弟”)。 |
|
猫 |
选修的 |
字符串数组 |
一系列用于描述内容 |
|
领域 |
选修的 |
细绳 |
内容生产者的最高级别领域 |
|
范围 |
范围 |
类型 |
描述 |
|
ua |
必需的 |
细绳 |
浏览器用户代理字符串 |
|
地理 |
受到推崇的 |
目的 |
设备位置假定为用户当前位置,由 Geo 对象定义。 |
|
lmt |
必需的 |
整数 |
“限制广告跟踪”信号由商业认可(例如 iOS、Android)表示,其中 0 = 跟踪不受限制,1 = 跟踪必须根据商业准则受到限制。 |
|
dnt |
受到推崇的 |
整数 |
浏览器在标头中设置的标准“请勿跟踪”标志,其中 0 = 跟踪不受限制,1 = 请勿跟踪(适用于移动网络/网站流量)。 |
|
IP |
必需的 |
细绳 |
IPv4 地址距离设备最近。 |
|
IPv6 |
必需的 |
细绳 |
设备附近最接近的IP地址(IPv6)。 |
|
设备类型 |
选修的 |
整数 |
设备的一般类型。 |
|
制作 |
选修的 |
细绳 |
设备制造商 |
|
模型 |
选修的 |
细绳 |
设备型号 |
|
操作系统 |
选修的 |
细绳 |
操作系统 |
|
osv |
选修的 |
细绳 |
操作系统版本 |
|
高压水枪 |
选修的 |
细绳 |
设备的硬件版本 |
|
像素比率 |
选修的 |
漂浮 |
物理像素与设备无关像素的比率 |
|
连接类型 |
选修的 |
整数 |
网络连接类型。 |
|
伊法 |
必需的 |
细绳 |
经批准可供广告商以明文(未加密)形式使用的ID。例如, |
|
外部 |
选修的 |
目的 |
设备对象特有的扩展占位符 |
|
ext.ifv |
选修的 |
细绳 |
对于 iOS 设备,我们建议将未加密的设备 IDFV(供应商标识符)作为 device.ext.idv 传递。广告商可能会利用此信息进行频次限制等操作。 |
|
外部属性 |
选修的 |
整数 |
(仅限 iOS)传递一个整数,用于表示应用的跟踪授权状态,其中 |
|
范围 |
范围 |
类型 |
描述 |
|
纬度 |
选修的 |
漂浮 |
纬度范围从 -90.0 到 +90.0,其中负值为南纬。 |
|
隆 |
选修的 |
漂浮 |
经度范围从 -180.0 到 +180.0,其中负值为西经。 |
|
类型 |
选修的 |
整数 |
位置数据来源;建议在传递 |
|
国家 |
选修的 |
细绳 |
国家代码采用 ISO-3166-1-alpha-3 标准。 |
|
城市 |
选修的 |
细绳 |
城市采用联合国贸易和运输法典 |
|
拉链 |
选修的 |
细绳 |
邮政编码。 |
|
范围 |
范围 |
类型 |
描述 |
|
ID |
受到推崇的 |
细绳 |
用户在交易所的特定 ID。 |
|
买方 |
受到推崇的 |
细绳 |
买家专属用户 ID,由交易所为买家映射。强烈建议至少提供 id 或 buyeruid 中的一个。[站点特定] 可用于传递通过我们的用户同步像素接收到的 ID。 |
|
流氓 |
选修的 |
整数 |
出生年份(4 位整数) |
|
性别 |
选修的 |
细绳 |
性别,其中“M”=男性,“F”=女性,“O”=已知为其他(即,省略表示未知)。 |
|
关键词 |
选修的 |
细绳 |
以逗号分隔的关键词、兴趣或意图列表。 |
|
地理 |
选修的 |
目的 |
由地理对象定义的用户大本营位置 |
|
外部 |
选修的 |
目的 |
用户对象特有的扩展占位符 |
|
ext.eids |
选修的 |
目的 |
此用户的扩展(第三方)标识符。请参阅对象:扩展标识符(3.2.21)。 |
|
外部同意 |
选修的 |
细绳 |
在任何适用 GDPR 法规的地方,都可以使用此扩展程序传递 GDPR 同意字符串。 该字符串应传递给 user.ext.consent。 InMobi 支持布尔同意 [0,1]、TCF v1.1、TCF v2.0、TCF 2.1 和 TCF v2.2。 |
|
范围 |
范围 |
类型 |
描述 |
|
来源 |
受到推崇的 |
细绳 |
Cookie 或平台原生标识符。 |
|
u ids |
受到推崇的 |
对象数组 |
来自给定源的扩展标识符 (UID) 对象数组。请参阅对象:扩展标识符 UID (3.2.2 2)。 |
|
范围 |
范围 |
类型 |
描述 |
|
ID |
受到推崇的 |
细绳 |
Cookie 或平台原生标识符。 |
|
类型 |
受到推崇的 |
整数 |
匹配项来自哪种类型的用户代理。强烈建议设置此项,因为许多 DSP 将应用原生 ID 与浏览器 ID 区分开来,并且需要类型值才能解析 ID。 |
By installing this SDK update, you agree that your Children Privacy Compliance setting remains accurate or that you will update that setting, whenever there is a change in your app's audience. You may update the app's Children Privacy Compliance settings at https://publisher.inmobi.com/my-inventory/app-and-placements.