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		此 cue 点的结束时间。
played		此 cue 点是否已播放。
start		此 cue 点的开始时间。

类 google.ima.dai.api.LiveStreamRequest

字段

assetKey

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

构造函数：

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

属性

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

类 google.ima.dai.api.StreamData

字段

adProgressData、 cuepoints、 errorMessage、 streamId、 subtitles、 url

用于指定数据流数据的类。

属性

名称	类型	说明
adProgressData		与当前播放的广告相关的时间信息。
cuepoints		点播直播的广告 cuepoint。这些信息可能会随着直播的进行而发生变化。此值仅会在 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	在 cue 点发生变化时，为按需串流分派。
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)

返回给定直播时间的上一个 cue 点。如果不存在此类 cuepoint，则返回 null。此接口用于实现“快速返回”等功能，并在发布商检测到用户快进时调用，以便将用户返回到广告插播时间点。

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

参数	类型	说明
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 完整版本的字符串。