此页面由 Cloud Translation API 翻译。

Google IMA DAI SDK API

google.ima.dai.api.Ad 类

方法

getAdId, getAdPodInfo, getAd2,Creative2,封装容器,封装容器,getAdvertiserName,getApiFramework,getCompanionAds, getCreativeId, getDealId,getDealId。getCreativeAdId 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

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

属性

名称	类型	说明
`end`		此广告插入点的结束时间。
`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、{STREAM2{STREAM2 START2 QUARTIAL、START2 QUARTIAL、START2 QUARTIAL{QUARTIAL}、START2 ；QUARTIALIZE；2.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 以及将视频流和广告事件转发给发布商。此管理器并非继承自 BaseAdapter，因为它不是特定广告的管理器，而是整个视频流的管理器

构造函数：

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

`contentTimeForStreamTime(streamTime)`

返回给定视频流时间不含广告的内容时间。返回直播的指定流式传输时间。

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

参数	类型	说明
`streamTime`	`number`	插入广告的播放时间（以秒为单位）。

`onTimedMetadata(metadata)`

传入已处理的元数据字典。字典需要将键“TXXX”作为值，并使用用户定义的元数据字符串。如果您的播放器提供原始元数据，请改为调用 ima.dai.api.StreamManager.processMetadata。

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

`previousCuePointForStreamTime(streamTime)`

返回指定视频流时间的上一个广告插入点。如果不存在此类广告插入点，则返回 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 的字符串。