ORTB
OMID 分册导航

平台实现矩阵

已上线

开放测量接口定义(Open Measurement Interface Definition,OMID)的规范本体平台中立,实现分 JavaScript、iOS、Android 三条线;联网电视(Connected TV,CTV)自 1.4 起在 JS 实现内扩展。本册给出三端的库形态、版本与公开类清单,并列出同一概念在三端的命名对照。

本页目录

本页将覆盖

  • 平台矩阵(端 / 库版本 / 官方文档 / 公开类数)
  • 跨平台命名对照表
  • 四个子页的入口卡片

平台矩阵

实现库版本规范版本公开类官方文档
JavaScriptOM SDK JSOmidSessionClient · OmidVerificationClient1.6.10OMID 1.68docs.iabtechlab.com/omsdk-1.6/js/index.html
iOSOM SDK iOSOMIDOMID 1.612docs.iabtechlab.com/omsdk-1.6/ios/index.html
AndroidOM SDK Androidcom.iab.omid.library · com.iab.omid.library.adsession · com.iab.omid.library.adsession.mediaOMID 1.610docs.iabtechlab.com/omsdk-1.6/android/index.html

跨平台命名对照

概念JavaScriptiOSAndroid
ad-eventsAdEventsOMIDAdEventsAdEvents
ad-sessionAdSessionOMIDAdSessionAdSession
ad-session-configurationOMIDAdSessionConfigurationAdSessionConfiguration
ad-session-contextOMIDAdSessionContextAdSessionContext
contextContext
js-session-serviceOMIDJavaScriptSessionService
media-eventsMediaEventsOMIDMediaEventsMediaEvents
omid-versionOmidVersion
partnerPartnerOMIDPartnerPartner
script-injectorOMIDScriptInjectorScriptInjector
sdk-entryOMIDSDKOmid
universal-ad-idOMIDUniversalAdID
vast-propertiesOMIDVASTPropertiesVastProperties
verification-clientVerificationClient
verification-script-resourceVerificationScriptResourceOMIDVerificationScriptResourceVerificationScriptResource
  • ad-session-configurationJS 无对应类:creativeType/impressionType 由 AdSession.setCreativeType()/setImpressionType() 设置,事件 owner(impressionOwner/mediaEventsOwner)概念在 JS 侧不存在。
  • ad-session-context对应 JS 的 Context:JS 把 partner、verificationScriptResources、contentUrl、customReferenceData、universalAdId 与 slot/video element 折叠进 Context 及 AdSession 构造参数,原生侧则拆为 AdSessionContext(iOS 另有 AdSessionConfiguration)。
  • contextiOS/Android 无同名类:JS 的 Context 在原生侧被拆分为 AdSessionContext + AdSessionConfiguration(见 ad-session-context / ad-session-configuration 两条)。
  • js-session-service仅 iOS 公开:OM SDK iOS 内置的 JS 会话服务(Android 由 Omid/OmidJsBridge 承担,未在 javadoc 站点公开对应类)。
  • omid-version仅 JS 公开:源码 omid-version.js 顶部有 TODO(OMSDK-715) 注明该类似未使用、下个大版本应移除,但 JSDoc 站点仍发布。
  • script-injectoriOS OMIDScriptInjector / Android ScriptInjector:把验证脚本内容注入 HTML 创意;JS 侧由 OM SDK service 完成,无公开类。
  • sdk-entryiOS 为 OMIDSDK(+sharedInstance / -activate),Android 为 Omid(activate(Context) / isActive());JS 侧无对应类,服务脚本由 OM SDK service 自行装载。
  • universal-ad-id仅 iOS 公开:JS 源码有 UniversalAdId(packageExport 到 OmidSessionClient.UniversalAdId,1.5.5 新增)但官方 JSDoc 站点无对应页面;Android 的 createNativeAdSessionContext(...)/getUniversalAdId() 在签名中引用 UniversalAdId 类型,javadoc 站点亦无该页(实测 404)。
  • vast-propertiesJS 侧 VastProperties(src/common/vast-properties.js,标 @public 且在 jsdoc.json 的 include 列表内)未被官方 JSDoc 站点发布(VastProperties.html 实测 404),故 js 记 null;AdEvents.loaded(vastProperties) 因此引用了一个站点上没有文档的类型。
  • verification-client仅 JS 公开:验证脚本(第三方测量)一律使用 JS 的 OmidVerificationClient,原生 SDK 不含验证客户端。

同一概念在三端的类名对照;空缺表示该端不提供对应类。JS 侧把会话配置折进 Context 与构造参数,iOS / Android 侧则拆为独立的配置与上下文类。

本组子页

JavaScript(Web / WebView / CTV)

OM SDK JS 是 Web、应用内 WebView 与联网电视(Connected TV,CTV)三类场景共用的实现,产出两个 UMD 二进制:omid-session-client-v1.js 由广告 SDK 在构建期并入广告 HTML,omid-verification-client-v1.js 由测量厂商在构建期并入验证脚本。当前库版本 1.6.10。

  • 公开类与方法(取自官方 JSDoc)
  • 双二进制形态与三种引入方式(CommonJS / Closure / 全局)
进入本章

iOS / tvOS

OM SDK iOS 以开放测量接口定义(Open Measurement Interface Definition,OMID)为前缀的 Objective-C 类暴露接口:OMIDSDK 负责激活与状态查询,OMIDAdSession 由 OMIDAdSessionConfiguration 与 OMIDAdSessionContext 构造,OMIDScriptInjector 向 WebView 注入会话客户端,OMIDJavaScriptSessionService 承载 JS 会话的服务端。友好遮挡(friendly obstruction)注册 API 仅原生端提供。

  • 公开类与枚举清单
  • 会话配置与会话上下文的拆分方式
进入本章

Android

OM SDK Android 以 com.iab.omid.library 包暴露接口:Omid.activate 完成初始化,AdSession 由 AdSessionConfiguration 与 AdSessionContext 构造,VerificationScriptResource 提供带参与不带参两种工厂方法,广告事件与媒体事件分别在 adsession 与 adsession.media 包下。

  • 公开类清单(按包分组)
  • 初始化与激活时序
进入本章

CTV(Tizen / webOS / Fire TV)

规划中

开放测量接口定义(Open Measurement Interface Definition,OMID)在联网电视(Connected TV,CTV)场景的实现:1.4 新增 CTV 事件,1.5 增加 Samsung Tizen 与 LG webOS 支持并给出 CTV 参考应用,1.6 增加 Fire TV 与 Apple 设备的设备认证(device attestation)。CTV 场景在 JS 实现内扩展,设备类别由 DeviceCategory 枚举声明。

  • CTV 场景与移动端的差异
  • Tizen / webOS / Fire TV 的支持起点
进入本章