Google IMA DAI SDK API

1. 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

方法

getAdId、 getAdPodInfo、 getAdSystem、 getAdvertiserName、 getApiFramework、 getCompanionAds、 getCreativeAdId、 getCreativeId、 getDealId、 getDescription、 getDuration、 getTitle、 getVastMediaHeight、 getVastMediaWidth、 getWrapperAdIds、 getWrapperAdSystems、 getWrapperCreativeIds

一个类，表示动态广告植入期间的广告对象。 此类公开了 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

方法

getAdPosition、getMaxDuration、getPodIndex、getTimeOffset、getTotalAds

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

getAdPosition()

退货 number：

getMaxDuration()

退货 number：

getPodIndex()

退货 number：

getTimeOffset()

退货 number：

getTotalAds()

退货 number：

类 google.ima.dai.api.AdProgressData

字段

adBreakDuration、 adPosition、 currentTime、 duration、 totalAds

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

属性

名称	类型	说明
adBreakDuration
adPosition
currentTime
duration
totalAds

类 google.ima.dai.api.CompanionAd

方法

getAdSlotId、 getContent、 getContentType、 getHeight、 getWidth

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

getAdSlotId()

退货 string：

getContent()

退货 string：

getContentType()

退货 string：

getHeight()

退货 number：

getWidth()

退货 number：

类 google.ima.dai.api.CuePoint

字段

end、played、start

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

属性

名称	类型	说明
end		相应 CuePoint 的结束时间。
played		相应提示点是否已播放。
start		相应广告插播点的开始时间。

类 google.ima.dai.api.LiveStreamRequest

字段

assetKey

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

构造函数：

参数	类型	说明
opt_liveStreamRequest	Object	已分配了流请求属性的对象。

属性

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

类 google.ima.dai.api.StreamData

字段

adProgressData、cuepoints、errorMessage、streamId、subtitles、url

用于指定流数据的类。

属性

名称	类型	说明
adProgressData		当前播放的广告的时长相关信息。
cuepoints		点播视频流的广告提示点。这些值可能会随着直播的进行而变化。此字段仅在 CUEPOINTS_CHANGED AdEvent 的事件监听器中填充。
errorMessage
streamId
subtitles
url

类 google.ima.dai.api.StreamEvent

方法

getAd、 getStreamData

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

getAd()

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

getStreamData()

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

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

字段

AD_BREAK_ENDED、 AD_BREAK_STARTED、 AD_PROGRESS、 CLICK、 COMPLETE、 CUEPOINTS_CHANGED、 ERROR、 FIRST_QUARTILE、 LOADED、 MIDPOINT、 STARTED、 STREAM_INITIALIZED、 THIRD_QUARTILE

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

值

值	说明
AD_BREAK_ENDED	在广告插播结束时触发。
AD_BREAK_STARTED	在广告插播开始时触发。
AD_PROGRESS	在广告进度更新时触发。
CLICK	在广告播放期间，当点击元素被点击或点按时分派。
COMPLETE	在广告播放完毕时触发。
CUEPOINTS_CHANGED	在提示点发生变化时，针对按需播放的视频流进行调度。
ERROR	发生错误时触发。
FIRST_QUARTILE	在广告播放到第一个四分之一时触发。
LOADED	在流清单可用时触发。
MIDPOINT	在广告播放到中点时触发。
STARTED	在广告开始时触发。
STREAM_INITIALIZED	在初始化流时触发。
THIRD_QUARTILE	在广告播放到四分之三时触发。

类 google.ima.dai.api.StreamManager

方法

contentTimeForStreamTime、 onTimedMetadata、 previousCuePointForStreamTime、 processMetadata、 requestStream、 setClickElement、 streamTimeForContentTime

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

构造函数：

参数	类型	说明
videoElement	HTMLVideoElement	实际的视频播放器元素。

contentTimeForStreamTime(streamTime)

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

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

参数	类型	说明
streamTime	number	插入广告后的视频流时间（以秒为单位）。

onTimedMetadata(metadata)

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

参数	类型	说明
metadata	Object	元数据字典。

previousCuePointForStreamTime(streamTime)

返回指定视频流时间的前一个 CuePoint。如果不存在此类 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、apiKey、streamActivityMonitorId

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

属性

名称	类型	说明
adTagParameters		您可以在视频流请求中替换一组有限的广告代码参数。如需了解详情，请参阅 为视频流提供定位参数。您可以使用 dai-ot 和 dai-ov 参数来指定视频流变体偏好设置。 如需了解详情，请参阅 替换视频流变体参数。
apiKey		流式传输请求 API 密钥。它通过 DFP 管理界面进行配置，并提供给发布商以解锁其内容。 它会验证尝试访问相应内容的应用。
streamActivityMonitorId		用于通过视频流活动监控工具调试视频流的 ID。 此属性用于提供一种便捷的方式，让发布商能够在直播活动监控工具中找到直播日志。

类 google.ima.dai.api.VODStreamRequest

字段

contentSourceId、 videoId

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

构造函数：

参数	类型	说明
opt_VODStreamRequest	Object	已分配了视频流请求属性的对象。

属性

名称	类型	说明
contentSourceId		来自内容管理系统 (CMS) 的发布商内容的唯一标识符。对于点播流，此参数为必需参数。
videoId		视频内容来源的标识符。对于点播流是必需的。

常量 google.ima.VERSION

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