google. ima. AdDisplayContainer
此类表示展示广告的容器。该 SDK 会自动在 containerElement 参数内创建结构,以包含视频和重叠式广告。
创建此类的实例后,它会在 containerElement 中创建一个 IFRAME 并加载 SDK 核心。必须保留此 IFRAME,SDK 才能正常运行。在所有广告都播放完毕且不再需要 SDK 时,使用 destroy()
方法卸载 SDK。
containerElement 参数必须是作为 DOM 一部分的一个元素。只有在正确放置 ContainerElement 的情况下,才能正确展示广告。建议将其放置在内容视频播放器上方,并调整尺寸以覆盖整个视频播放器。 如需详细了解推荐的实现方式,请参阅 SDK 文档。
注意:始终必须在用户操作(例如点击或点按)直接调用的代码中调用 initialize()
方法。
构造函数
广告容器
new AdDisplayContainer(containerElement, videoElement, clickTrackingElement)
参数 |
|
---|---|
containerElement |
要在其中展示广告的元素。 该元素必须插入到 DOM 中,然后才能创建 AdDisplayContainer。 值不能为 null。 |
videoElement |
选填 指定备用视频广告播放元素。我们建议您始终传入内容视频播放器。 值不能为 null。 |
ClickTrackingElement |
选填 指定备用视频广告点击元素。将此字段留空,以便 SDK 处理点击。即使提供了 AdSense SDK,仅当非 AdSense/AdX 广告素材显示在不支持视频播放器环境的环境中(例如 iPhone 或 Android 4.0 之前的版本)时,SDK 才会使用自定义点击跟踪元素。自定义点击跟踪元素绝不应呈现在视频播放器上,因为它可能会拦截对 SDK 呈现的界面元素的点击。另请注意,SDK 不会修改自定义点击跟踪元素的可见性。这意味着,如果提供自定义点击跟踪元素,则必须在播放线性广告时正确显示该元素。 您可以在 ima.AdEvent.Type.STARTED 事件触发时检查 ima.Crashlytics.isCustomClickTrackingUsed,以确定是否显示您的自定义点击跟踪元素。如果应该触发点击跟踪,您应该在 ima.AdEvent.Type.CONTENT_RESUME_REQUESTED 事件触发时隐藏点击跟踪元素。 值不能为 null。 |
方法
destroy
destroy()
销毁内部状态和之前创建的 DOM 元素。系统会卸载 IMA SDK,且不会再对任何 API 进行调用。
initialize
初始化()
初始化内部视频元素以进行播放。您必须将此方法作为用户操作的直接结果,以便浏览器可以将视频元素标记为用户启动。
如果视频已静音,某些浏览器将允许在没有用户互动的情况下播放视频。对于此行为,请使用 AdsRequest.setAdWillPlayMuted(true)
并在 AdsManager.start()
之前调用此方法。