OMID 分册导航

OpenRTB / AdCOM 承载

承载

出处状态：OpenRTB 侧的唯一官方出处是 2018-07 的 Working Draft（工作草案），早于 OpenRTB 2.6 定稿。文中对 2.6 与 AdCOM 1.0 的描述以草案当时的形态为准；与本站 OpenRTB 2.6 模块的字段基线如有出入，以 OpenRTB 模块的官方 2.6 正文为准，本页只讲 OMID 相关的 ext 约定。

本页目录

定位与职责
API Frameworks 清单（List 5.6）
请求侧：广告位是否支持 OMID
响应侧：创意是否要求 OMID
会话方标识：omidpn 与 omidpv
omidpn / omidpv 的挂载位置
Native 广告的事件追踪器承载
相关章节

定位与职责

开放测量接口定义（Open Measurement Interface Definition，OMID）的能力声明与会话方标识在竞价链路由 OpenRTB 与 AdCOM 承载。请求侧：imp.{banner,video,audio,native}.api 取值 7（AdCOM APIFrameworks 的 OMID-1）声明广告位支持 OMID，bid.apis 声明创意要求 OMID，source.ext.omidpn 与 source.ext.omidpv 传递 OMID Partner 对象的 name 与 versionString。Native 广告以 event 取值 555 的自定义事件追踪器承载验证脚本资源。

格式: OpenRTB 2.0–2.6 · AdCOM 1.0
出处状态: Working Draft · 2018-07
承载点: api = 7 · omidpn · omidpv · event 555
官方文档: CC-BY 3.0 (IAB Tech Lab) ↗

API Frameworks 清单（List 5.6）

字面值	官方描述
1	VPAID 1.0
2	VPAID 2.0
3	MRAID-1
4	ORMMA
5	MRAID-2
6	MRAID-3
7	OMID-1

通告建议按上表扩展 OpenRTB 的 API Frameworks 清单，取值 7 表示 OMID 1.0。在 OpenRTB 2.0 与 2.1 中不存在取值 6；若扩展既有的 2.0 / 2.1 实现，通告建议跳过 6 直接用 7 表示 OMID 支持，以保留升级路径。本站 OpenRTB 2.6 的同一清单见 AdCOM 枚举总览（list_apiframeworks），取值 7 的官方描述为「OMID 1.0」。

请求侧：广告位是否支持 OMID

请求侧用 api 字段声明本广告位支持哪些 API 框架。通告的表述是「若某 API 未被显式列出，即视为不支持」。

承载点	类型	起始版本	含义
imp.{banner,video,audio,native}.api	integer array	OpenRTB 2.0+	取值含 7 表示该广告位支持 OMID。通告正文的标题写作 Banner/Video/Native/Audio Object，即四种展示形式对象同用此字段。ENList of supported API Frameworks for this impression. Refer to List 5.6. If an API is not explicitly listed, it is assumed not to be supported.

响应侧：创意是否要求 OMID

响应侧用 Bid 对象的字段声明本次返回的创意要求使用 OMID。这与请求侧的语义不同：请求侧讲广告位能力，响应侧讲创意要求。

承载点	类型	起始版本	含义
bid.apis	integer array	OpenRTB 2.6	2.6 起的数组形态；在 AdCOM 中同名字段为 apis。ENA list of APIs required by the markup if applicable. Refer to List 5.6.
bid.api已废弃	integer	OpenRTB 2.4+	单值形态，2.6 起由 apis 数组取代；存量 2.4 / 2.5 响应中仍会遇到。ENNOTE: Deprecated in favor of the apis integer array in OpenRTB 2.6. API required by the markup if applicable. Refer to List 5.6.

会话方标识：omidpn 与 omidpv

这两个字段标识是哪个集成方（广告 SDK）安装了 OM SDK，与 API 框架数组是并列的两件事：数组声明能力，这两字段声明实现方。二者对应 OMID Partner 对象的两个构造参数。

承载点	类型	起始版本	含义
omidpn	string	—	对应 Partner 对象的 name 参数；在 VAST 侧由宏 [OMIDPARTNER] 的前半段承载。ENIdentifier of the OM SDK integration. This is the same as the "name" parameter of the OMID Partner object.
omidpv	string	—	对应 Partner 对象的 versionString 参数；在 VAST 侧由宏 [OMIDPARTNER] 的后半段承载。ENVersion of the OM SDK integration. This is the same as the "versionString" parameter of the OMID Partner object.

omidpn / omidpv 的挂载位置

OpenRTB 2.xBidRequest.Source.Ext

通告给出三种可选扩展位置，并说明当认证适用于本次竞价请求的全部广告位时，放在 Source.Ext 是合适的。

"source": {
  "ext": {
    "omidpn": "MyIntegrationPartner",
    "omidpv": "7.1"
  }
},
"imp": [{
  "banner": { "api": [7] }
}]

OpenRTB 3.0 / AdCOM 1.0events.ext

AdCOM 用 events 对象表达竞价请求的 OMID 能力，故通告认为会话方信息放在同一对象里是合理的；能力本身由 events.apis 承载。

"events": {
  "apis": [7],
  "ext": {
    "omidpn": "MyIntegrationPartner",
    "omidpv": "7.1"
  }
}

两个字段在 OpenRTB 2.x 与 3.0 中的字段名与类型相同，只是挂载的对象不同。官方 proto 的 Source.Ext 中，omidpn 与 omidpv 分别为第 2、3 号字段。

Native 广告的事件追踪器承载

OpenRTB Native Ads 1.2 §4.7 Event Trackers Request Object

Native 广告不通过展示形式对象的 api 字段下发验证脚本，而是复用事件追踪器（event tracker）：以自定义事件取值标识这是 OMID 资源，由 SSP 与发布方决定何时执行脚本。

对象	字面值	含义
event	555	OMID —— 新增自定义取值ENEvent should be set to a custom value of "555" to signify that this is OMID and the SSP and publisher will determine when to execute OMID script.
method	2	JS（沿用既有取值 2）ENMethod should always be "2" for JS. Previous guidance to use '555' is not necessary unless the script is non-JS, non-img.
ext.vendorKey	ext	提供 OMID 脚本的厂商键；与 VAST 侧 Verification@vendor 的作用相同。SSP / 发布方在收到时必须把它传给 OMID。ENThe vendor key for the company providing the OMID javascript, e.g. "company.com-omid"
ext.verification_parameters	ext	传给 OM SDK 的附加验证参数；与 VAST 侧 VerificationParameters 的作用相同。官方原文此处含一处标点瑕疵（e.g,.），本站照录。ENAdditional verification parameters for the OMSDK, populated by e.g,. "[parameters string]"

"eventtrackers": {
  "event": 555,
  "method": 2,
  "url": "https://verification.com/omid_verification.js",
  "ext": {
    "vendorKey": "company.com-omid",
    "verification_parameters": "[parameters string]"
  }
}

验证脚本地址放在标准的 eventtrackers.url 字段，不另造字段。
两个 ext 扩展是任意交易平台都可支持的自定义字段，但通告强烈建议 SSP 与 DSP 作为 OMID 支持的一部分予以支持。