google.
google.ima 命名空间提供了对 SDK 的类、接口、枚举和属性的访问权限。
类
广告
由代表不同广告类型的类扩展的广告类。
AdCuePoints
广告插入点列表表示广告插播时间点的时间表。请注意，广告插播时段内的个别广告未包含在投放时间中。
DisplayDisplayContainers
此类表示展示广告的容器。SDK 会在 containerElement 参数内自动创建结构，以便放置视频广告和重叠式广告。
创建此类的实例时，它会在 containerElement 中创建一个 IFRAME 并加载 SDK 核心。必须保留此 IFRAME，SDK 才能正常运行。播放完所有广告且不再需要 SDK 后，请使用 destroy() 方法卸载 SDK。
containerElement 参数必须是 DOM 的一部分。为确保广告正确展示，您需要正确设置 containerElement 位置。建议您将播放器放置在内容视频播放器上方，并调整尺寸，使其覆盖整个视频播放器。如需详细了解推荐的实现方式，请参阅 SDK 文档。
注意：必须始终在用户操作（如点击或点按）直接调用的代码中调用 initialize() 方法。
广告错误
AdError 向用户显示关于广告加载或播放期间是否发生故障的信息。errorType 访问器会提供关于错误发生在广告加载还是广告播放期间的信息。
AdErrorEvent 类中的方法
从 Google 或 DoubleClick 服务器加载广告时出现错误时会触发此事件。可用于注册事件的类型为 AdsLoader 和 VPAID。
广告事件
当广告状态发生变化以及用户与广告互动时，广告会以通知的形式引发此事件类型。例如，广告开始播放、点击等。您可以在 SurfaceFlinger 中注册各种状态更改事件。
AdMetadataEvent
此类已弃用。请使用 SurfaceFlinger.getCuePoints() API。 包含元数据的特定广告事件。
AdPodInfo
广告可能属于广告连播。此对象会显示与该 Pod 相关的元数据，例如广告连播中的广告数量以及广告连播内的位置。
此对象中包含的 getTotalAds API 通常正确无误，但在某些情况下，它代表 SDK 的最佳猜测。如需了解详情，请参阅该方法的文档。
AdProgressData
此对象可在广告播放期间公开当前进度的相关信息。
AdsLoader
AdsLoader 允许客户端从广告服务器请求广告。为此，用户必须先注册 VPAIDLoadedEvent 事件，然后再请求广告。
Ad Manager
向发布商提供外部公共 API，并与广告管理器的内部实例进行通信。
VPAIDLoadedEvent
该事件会在通过 AdsLoader 从 Google 或 DoubleClick 广告服务器成功加载广告时触发。您可以在 AdsLoader 上注册此事件。
AdsRenderingSettings
定义用于控制广告呈现的参数。
AdsRequest
用于指定广告请求属性的类。
随播广告
表示随播广告。
CompanionAdSelectionSettings
CompanionAdSelectionSettings 对象用于在调用 ima.Ad.getCompanionAds 函数时定义选择条件。
ImaSdkSettings
此类包含 SDK 级设置。
UniversalAdIdInfo
此对象会公开与广告素材相关联的通用广告 ID 的相关信息，包括广告 ID 值和广告 ID 注册表。
枚举
OmidAccessMode
string
OMID for Web 的可用访问模式，用于控制验证脚本可以访问多少内容。
值 |
|
|---|---|
|
LIMITED |
验证脚本进行了沙盒化处理，无法访问广告素材或发布商页面，因此无法直接确认其位于哪个发布商网域。 |
|
网域 |
验证脚本进行了沙盒化处理，无法访问广告素材或发布商页面。不过，该脚本的加载方式可以直接导致确认它位于哪个发布商网域上。 |
|
FULL |
验证脚本可直接访问广告素材和发布商页面。 |
OMID 供应商
number
标识 OMID 验证供应商。供应商按字母顺序排列。
值 |
|
|---|---|
|
Comscore |
|
|
双击 |
|
|
|
|
|
INT_GRAL_AD_SCIENCE |
|
|
地铁 |
|
|
MOAT |
|
|
尼尔森 |
|
|
像素 |
|
|
其他 |
脚本网址与任何其他供应商都不匹配时使用的默认供应商。 |
界面元素
string
用于指定可配置为显示或隐藏的不同界面元素的枚举。对于 AdSense 广告和 ADX 广告，这些设置可能会被忽略。
值 |
|
|---|---|
|
广告归因 |
在广告界面中显示“广告”文字。必须存在才能显示倒计时器。 |
|
COUNTDOWN |
必须显示广告标示，才能显示倒计时器。 |
视图模式
string
用于指定广告不同 VPAID 视图模式的枚举。
值 |
|
|---|---|
|
中 |
一般广告查看模式。 |
|
全屏 |
全屏广告视图模式。向广告管理员指明，发布商会将当前的 AdDisplayContainer 排列方式视为全屏（例如，模拟全屏）。这不会导致广告管理器进入全屏模式。 |
- 已弃用
属性
OmidAccessMode
string
OMID for Web 的可用访问模式，用于控制验证脚本可以访问多少内容。
值 |
|
|---|---|
|
LIMITED |
验证脚本进行了沙盒化处理，无法访问广告素材或发布商页面，因此无法直接确认其位于哪个发布商网域。 |
|
网域 |
验证脚本进行了沙盒化处理，无法访问广告素材或发布商页面。不过，该脚本的加载方式可以直接导致确认它位于哪个发布商网域上。 |
|
FULL |
验证脚本可直接访问广告素材和发布商页面。 |
OMID 供应商
number
标识 OMID 验证供应商。供应商按字母顺序排列。
值 |
|
|---|---|
|
Comscore |
|
|
双击 |
|
|
|
|
|
INT_GRAL_AD_SCIENCE |
|
|
地铁 |
|
|
MOAT |
|
|
尼尔森 |
|
|
像素 |
|
|
其他 |
脚本网址与任何其他供应商都不匹配时使用的默认供应商。 |
界面元素
string
用于指定可配置为显示或隐藏的不同界面元素的枚举。对于 AdSense 广告和 ADX 广告，这些设置可能会被忽略。
值 |
|
|---|---|
|
广告归因 |
在广告界面中显示“广告”文字。必须存在才能显示倒计时器。 |
|
COUNTDOWN |
必须显示广告标示，才能显示倒计时器。 |
视图模式
string
用于指定广告不同 VPAID 视图模式的枚举。
值 |
|
|---|---|
|
中 |
一般广告查看模式。 |
|
全屏 |
全屏广告视图模式。向广告管理员指明，发布商会将当前的 AdDisplayContainer 排列方式视为全屏（例如，模拟全屏）。这不会导致广告管理器进入全屏模式。 |
- 已弃用
设置
非 null ImaSdkSettings
全局单例设置实例。