Google IMA DAI SDK API

    1. google.ima.dai.api.Ad
    2. google.ima.dai.api.AdPodInfo
    3. google.ima.dai.api.AdProgressData
    4. google.ima.dai.api.CompanionAd
    5. google.ima.dai.api.CuePoint
    6. google.ima.dai.api.LiveStreamRequest
    7. google.ima.dai.api.StreamData
    8. google.ima.dai.api.StreamEvent
    9. google.ima.dai.api.StreamEvent.Type
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.VERSION

类 google.ima.dai.api.Ad

方法

一个类，表示动态广告植入期间的广告对象。 此类公开了 ima.Ad 属性的一个子集。

getAdId()


返回值 string：

getAdPodInfo()


返回值 google.ima.dai.api.AdPodInfo：

getAdSystem()


返回值 string：

getAdvertiserName()


返回值 string：

getApiFramework()


返回值 string：

getCompanionAds()


返回值 Array.<google.ima.dai.api.CompanionAd>：

getCreativeAdId()


返回值 string：

getCreativeId()


返回值 string：

getDealId()


返回值 string：

getDescription()


返回值 string：

getDuration()


返回值 number：

getTitle()


返回值 string：

getVastMediaHeight()


返回值 number：

getVastMediaWidth()


返回值 number：

getWrapperAdIds()


返回值 Array.<string>：

getWrapperAdSystems()


返回值 Array.<string>：

getWrapperCreativeIds()


返回值 Array.<string>：

类 google.ima.dai.api.AdPodInfo

方法

一个类，用于表示动态广告插播期间的广告插播时段信息对象。此类公开了 ima.AdPodInfo 属性的子集。

getAdPosition()


返回值 number：

getMaxDuration()


返回值 number：

getPodIndex()


返回值 number：

getTimeOffset()


返回值 number：

getTotalAds()


返回值 number：

类 google.ima.dai.api.AdProgressData

字段

用于指定广告进度数据的类。

属性

名称 类型 说明
adBreakDuration

adPosition

currentTime

duration

totalAds

类 google.ima.dai.api.CompanionAd

方法

一个类，用于表示动态广告插播期间的随播广告对象。此类公开了 ima.CompanionAd 属性的子集。

getAdSlotId()


返回值 string：

getContent()


返回值 string：

getContentType()


返回值 string：

getHeight()


返回值 number：

getWidth()


返回值 number：

类 google.ima.dai.api.CuePoint

字段

用于指定广告插播点的属性的类，表示 DAI VOD 流中的广告插播时间。

属性

名称 类型 说明
end

相应 CuePoint 的结束时间。
played

相应 CuePoint 是否已播放。
start

相应 CuePoint 的开始时间。

类 google.ima.dai.api.LiveStreamRequest

字段

用于指定直播请求属性的类。

构造函数：
参数 类型 说明
opt_liveStreamRequest Object

已分配了流请求属性的对象。

属性

名称 类型 说明
assetKey

此属性用于确定应播放哪个媒体流。 直播请求素材资源键是一种标识符，可在 DFP 界面中找到。

类 google.ima.dai.api.StreamData

字段

用于指定流数据的类。

属性

名称 类型 说明
adProgressData

当前播放的广告的时长相关信息。
cuepoints

点播视频流的广告提示点。这些可能会随着直播的进行而变化。此值仅在 CUEPOINTS_CHANGED AdEvent 的事件监听器中填充。
errorMessage

streamId

subtitles

url

类 google.ima.dai.api.StreamEvent

方法

当流状态发生变化时，流管理器会引发此事件类型作为通知。

getAd()


返回 google.ima.dai.api.Ad：包含广告信息的返回对象。

getStreamData()


返回 google.ima.dai.api.StreamData：包含流信息的返回对象。

枚举 google.ima.dai.api.StreamEvent.Type

字段

IMA SDK 支持的事件类型列表。

值

值 说明
AD_BREAK_ENDED

在广告插播结束时触发。
AD_BREAK_STARTED

在广告插播开始时触发。
AD_PROGRESS

当广告进度更新时触发。
CLICK

在广告播放期间，当用户点击或点按点击元素时调度。
COMPLETE

在广告播放完毕时触发。
CUEPOINTS_CHANGED

在 cuepoint 发生变化时，针对按需播放的视频流进行调度。
ERROR

发生错误时触发。
FIRST_QUARTILE

在广告播放到第一个四分之一时触发。
LOADED

在流清单可用时触发。
MIDPOINT

在广告播放到中点时触发。
STARTED

在广告开始时触发。
STREAM_INITIALIZED

在初始化流时触发。
THIRD_QUARTILE

在广告播放到四分之三时触发。

类 google.ima.dai.api.StreamManager

方法

处理动态广告插播视频流。它负责管理与 DAI 后端的互动，并处理跟踪 ping，以及将视频流和广告事件转发给发布商。此管理器不继承自 BaseAdsManager，因为它不是特定广告的管理器，而是整个视频流的管理器

构造函数：
参数 类型 说明
videoElement HTMLVideoElement

实际的视频播放器元素。

contentTimeForStreamTime(streamTime)

返回指定媒体流时间的不含广告的内容时间。返回直播的指定直播时间。

返回值 number：移除广告后与给定视频流时间对应的内容时间。

参数 类型 说明
streamTime number

插入广告后的视频流时间（以秒为单位）。

onTimedMetadata(metadata)

传入已处理元数据的字典。该字典应包含键“TXXX”，其值为用户定义的元数据字符串。如果播放器提供原始元数据，请改为调用 ima.dai.api.StreamManager.processMetadata。

参数 类型 说明
metadata Object

元数据字典。

previousCuePointForStreamTime(streamTime)

返回指定视频流时间的前一个 CuePoint。如果不存在此类提示点，则返回 null。用于实现回放等功能，并在发布商检测到用户快进时调用，以便将用户返回到广告插播时间。

返回 google.ima.dai.api.CuePoint：指定直播时间的上一个提示点。

参数 类型 说明
streamTime number

已定位到的视频流时间。

processMetadata(type, data, timestamp)

处理直播的定时元数据。如果视频播放器提供未解析的元数据以及时间戳，请使用此方法；否则，请调用 ima.dai.api.StreamManager.onTimedMetadata。

参数 类型 说明
type string

元数据的类型。必须为“ID3”。
data Uint8Array

原始标记数据。对于 ID3，必须是整个标记。
timestamp number

应处理数据的时间。

requestStream(streamRequest)

使用提供的视频流参数请求加载视频流。

参数 类型 说明
streamRequest google.ima.dai.api.StreamRequest

包含用于加载流元数据的参数。

setClickElement(clickElement)

设置广告点击后到达的元素。此元素在广告播放时用作点击或点按接收器，可能会导致导航离开当前网页。

参数 类型 说明
clickElement Element

用作广告点击后到达网址的元素。

streamTimeForContentTime(contentTime)

返回指定内容时间对应的含广告的视频流时间。返回直播的指定内容时间。

返回 number：插入广告后与指定内容时间对应的视频流时间。

参数 类型 说明
contentTime number

不含任何广告的内容时长（以秒为单位）。

类 google.ima.dai.api.StreamRequest

字段

用于指定流式请求属性的类。

属性

名称 类型 说明
adTagParameters

您可以在视频流请求中替换一组有限的广告代码参数。 为视频流提供定位参数一文提供了更多信息。 您可以使用 dai-ot 和 dai-ov 参数来指定视频流变体偏好设置。 如需了解详情，请参阅 替换视频流变体参数。
apiKey

流式传输请求 API 密钥。它通过 DFP 管理界面进行配置，并提供给发布商以解锁其内容。 它会验证尝试访问相应内容的应用。
streamActivityMonitorId

用于通过视频流活动监控工具调试视频流的 ID。 此参数用于提供一种便捷的方式，让发布商能够在直播活动监控工具中找到直播日志。

类 google.ima.dai.api.VODStreamRequest

字段

用于指定 VOD 视频流请求属性的类。

构造函数：
参数 类型 说明
opt_VODStreamRequest Object

已分配了视频流请求属性的对象。

属性

名称 类型 说明
contentSourceId

来自 CMS 的发布商内容的唯一标识符。对于按需播放的视频，此参数为必需参数。
videoId

视频内容来源的标识符。对于点播视频是必需的。

常量 google.ima.VERSION

包含 SDK 完整版本的字符串。