ORTB
OMID 分册导航

客户端 API 总览

已上线

开放测量接口定义(Open Measurement Interface Definition,OMID)对外暴露两套客户端:集成方(广告 SDK / 发布方)使用的会话客户端(session client)创建并驱动会话,测量厂商使用的验证客户端(verification client)订阅会话事件。同一会话由会话侧产生事件、验证侧消费事件。

本页目录

本页将覆盖

  • 三个子页的入口卡片
  • 两套客户端的分工与产物形态
  • 官方描述原文与译文的呈现约定

本组子页

AdSession 与会话构造

会话客户端的主对象 AdSession:创建、start / finish、曝光与素材加载声明、错误上报、事件注册与元素边界更新;构造所需的 Context / Partner / VerificationScriptResource / OmidVersion 一并列出,并给出 iOS / Android 的同名对象对照。UniversalAdId 与 VastProperties 由 Context 的构造参数与 AdEvents.loaded() 引用,JS 源码已导出(packageExport 到 OmidSessionClient)但官方 JSDoc 站点未发布对应页面,故本册只在参数类型中出现,不单独成表。

  • AdSession 方法全表(名称 / 签名 / 参数 / 返回 / 官方描述)
  • 会话构造参数对象
进入本章

AdEvents 与 MediaEvents

事件注册分两类:AdEvents 承载曝光(impressionOccurred)与素材加载完成(loaded,可附 VastProperties);MediaEvents 承载 14 个媒体播放事件(start、三个四分位、complete、pause、resume、bufferStart、bufferFinish、skipped、volumeChange、playerStateChange、adUserInteraction)。事件类型常量见 AdEventType 枚举,其中多数与 VAST 追踪事件一一对应。

  • AdEvents 方法表
  • MediaEvents 方法表
进入本章

VerificationClient

验证客户端供测量厂商的验证脚本(verification script)使用:registerSessionObserver 订阅会话事件、addEventListener 订阅指定事件类型、sendUrl 与 injectJavaScriptResource 在受限环境中发起网络请求与注入脚本、setTimeout / setInterval 提供受控定时器,以及 1.6.0 引入的 attest(设备认证)。

  • 方法全表
  • 订阅模型:会话观察者与事件监听器的区别
进入本章

事件载荷与几何字段

规划中

sessionStart 载荷的 context 与 verificationParameters、geometryChange 载荷的 adView / viewport / obstructions 字段级布局,以及各字段在 full 与 limited 访问模式下的可得性差异。

  • sessionStart 载荷字段表
  • geometryChange 载荷字段表
进入本章