类:Ad Manager

方法

收起

收起

收起当前广告。对于 HTML5 SDK,这是空操作。

配置 VPAID

configureDisplay(content, adsRenderingSettings)

设置从 LoadedLoaded 事件获取对此 Ad 的引用所需的参数。

参数

内容

对象

用于播放发布商内容的对象。

值不能为 null。

adsRenderingSettings

选填

AdsRenderingSettings

用于控制广告呈现的可选设置。

值可以为 null。

destroy

destroy()

移除在运行时加载且需要在广告播放完毕时正确移除的广告素材资源,并停止广告和所有跟踪。

舍弃 AdBreak

舍弃 AdBreak()

如果广告插播时间点当前正在播放,请舍弃该时间点并恢复内容。 否则,请忽略下一个排定的广告插播时间点。例如,这可以在广告管理器加载后立即调用,以忽略前贴片广告,同时不会丢失未来插播广告或后贴片广告。除非广告请求返回播放列表或 VMAP 响应,否则该操作将为空操作。

展开

展开()

展开当前广告。对于 HTML5 SDK,这是空操作。

焦点

focus()

将焦点置于“跳过”按钮上(如果存在)。如果不存在,则重点关注互动元素,包括图标或互动广告素材。

getAdSkippableState

getAdSkippableState() 返回布尔值

如果当前可以跳过广告,则返回 true。当此值发生更改时,AdsManager 会触发 AdEvent.SKIPPABLE_STATE_CHANGED 事件。

返回

boolean 如果广告当前可跳过,则为 true,否则为 false。

getCuePoints

getCuePoints() 返回数字数组

返回一个偏移数组(以秒为单位),用于指明何时播放已安排的广告插播时间点。前贴片广告由 0 表示,后贴片由 -1 表示。空数组表示广告或广告连播没有投放时间,可以随时播放。

返回

non-null Array of number:时间偏移(以秒为单位)。

getRemainingTime

getRemainingTime() 返回数字

获取当前正在播放的广告的剩余时间。如果广告尚未加载或已完成播放,该 API 会返回 -1。

返回

number 返回当前广告的剩余时间。如果未定义当前广告(例如自定义广告)的剩余时间,该值会返回 -1。

getVolume

getVolume() 会返回数字

获取当前广告的音量。

返回

number:当前广告的音量,从 0(静音)到 1(最高)。

init

init(width, height, viewMode, videoElement)

调用 init 以初始化广告管理器上的广告体验。

参数

width

number

广告的指定宽度。

高度

number

广告的选定高度。

视图模式

视图模式

所选的查看模式。

值不能为 null。

videoElement

选填

HTMLVideo 元素

用于自定义播放的视频元素。此视频元素会替换 AdDisplayContainer 构造函数中提供的元素。仅在绝对必要时才使用此属性,否则建议您在创建 AdDisplayContainer 时指定此视频元素。

值可以为 null。

使用了 CustomClickTrackingUsed

isCustomClickTrackingUsed() 返回布尔值

如果对当前广告使用了自定义点击跟踪元素,则返回 true。只有在向 AdDisplayContainer 提供可选的点击跟踪元素、使用自定义播放且当前广告不是 AdSense/AdX 广告的情况下,才使用自定义跟踪。

返回

boolean:是否使用自定义点击跟踪。

使用了 CustomPlaybackUsed

isCustomPlaybackUsed() 返回布尔值

如果使用自定义视频元素播放当前广告,则返回 true。在自定义视频元素将提供更顺畅的广告观看体验的平台上,当向 AdDisplayContainer 提供可选视频元素时,会发生自定义播放。

返回

boolean:是否使用自定义播放。

暂停

pause()

暂停当前播放的广告。当显示静态叠加层、广告尚未加载或播放完毕时,此函数将为空操作。

resize

调整大小(宽度、高度、viewMode)

调整当前广告的大小。

参数

width

number

新的广告位宽度。

高度

number

新的广告位高度。

视图模式

视图模式

新的视图模式。

值不能为 null。

resume

简历()

恢复当前已加载和暂停的广告。当显示静态叠加层、广告尚未加载或播放完毕时,此函数将为空操作。

setVolume

setVolume(音量)

设置当前广告的音量。

参数

音量

number

要设置的音量,从 0(静音)到 1(最高)。

跳过

跳过()

AdsManager.getAdSkippableState() 为 true 时,跳过当前广告。在其他情况下调用时,跳过操作无效。跳过完成后,AdsManager 会触发 AdEvent.SKIPPED 事件。

启动

start()

开始播放广告。

开发者必须先调用 AdDisplayContainer.initialize()

停止

停止

停止播放广告。调用此函数可让发布商重新访问内容。

updateAdsRenderingSettings

updateAdsRenderingSettings(adsRenderingSettings)

更新广告呈现设置。它应专门用于需要更新广告呈现设置(例如比特率)时的广告插播时间点之间的 VMAP 用例。

参数

adsRenderingSettings

AdsRenderingSettings

更新后的广告呈现设置。

值不能为 null。