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：

Class 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：

Class google.ima.dai.api.CuePoint

欄位

end, played, start

這個類別用於指定提示點的屬性，代表 DAI VOD 串流中的廣告插播。

屬性

名稱	類型	說明
end		這個提示點的結束時間。
played		這個提示點是否已播放。
start		這個提示點的開始時間。

Class google.ima.dai.api.LiveStreamRequest

欄位

assetKey

這個類別用於指定直播要求屬性。

建構函式：

參數	類型	說明
opt_liveStreamRequest	Object	已指派串流要求屬性的物件。

屬性

名稱	類型	說明
assetKey		這項資訊會用來決定要播放哪個串流。 直播請求素材資源金鑰是識別碼，可在 DFP 使用者介面中找到。

Class google.ima.dai.api.StreamData

欄位

adProgressData、 cuepoints、 errorMessage、 streamId、 subtitles、 url

用於指定串流資料的類別。

屬性

名稱	類型	說明
adProgressData		目前播放廣告的相關時間資訊。
cuepoints		隨選串流的廣告提示點。這些資訊可能會隨著串流進度而改變。只有在 CUEPOINTS_CHANGED AdEvent 的事件監聽器中，才會填入這個值。
errorMessage
streamId
subtitles
url

Class google.ima.dai.api.StreamEvent

方法

getAd, getStreamData

串流管理員會在串流狀態變更時，以通知形式引發這個事件類型。

getAd()

傳回 google.ima.dai.api.Ad：傳回含有廣告資訊的物件。

getStreamData()

傳回 google.ima.dai.api.StreamData：傳回含有串流資訊的物件。

Enum 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

處理動態廣告插播串流。這個類別會管理與動態廣告插播後端的互動，並處理追蹤 Ping，以及將串流和廣告事件轉送給發布商。這個管理員不會從 BaseAdsManager 繼承，因為它不是特定廣告的管理員，而是整個串流的管理員

建構函式：

參數	類型	說明
videoElement	HTMLVideoElement	實際的影片播放器元素。

contentTimeForStreamTime(streamTime)

針對指定串流時間，傳回不含廣告的內容時間。傳回直播的指定串流時間。

傳回 number：移除廣告後，與指定串流時間相應的內容時間。

參數	類型	說明
streamTime	number	插入廣告的串流時間 (以秒為單位)。

onTimedMetadata(metadata)

傳遞已處理中繼資料的字典。字典預期會以使用者定義的中繼資料字串做為值，並以鍵 'TXXX' 做為鍵。如果播放器提供原始中繼資料，請改為呼叫 ima.dai.api.StreamManager.processMetadata。

參數	類型	說明
metadata	Object	中繼資料字典。

previousCuePointForStreamTime(streamTime)

傳回指定串流時間的前一個提示點。如果沒有這類提示點，則傳回空值。這項事件可用於實作自動返回等功能，且會在發布商偵測到使用者搜尋時呼叫，以便讓使用者返回廣告插播。

傳回 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	不含任何廣告的內容時間 (以秒為單位)。

Class google.ima.dai.api.StreamRequest

欄位

adTagParameters、 apiKey、 streamActivityMonitorId

用於指定串流要求屬性的類別。

屬性

名稱	類型	說明
adTagParameters		您可以在串流請求中覆寫一組有限的廣告代碼參數。 詳情請參閱「 為串流提供指定目標參數」一文。您可以使用 dai-ot 和 dai-ov 參數設定偏好的串流變體。詳情請參閱「 覆寫串流變體參數」。
apiKey		串流要求 API 金鑰。這項功能是透過 DFP 管理 UI 設定，並提供給發布商，讓他們解鎖內容。 並驗證嘗試存取內容的應用程式。
streamActivityMonitorId		用於透過串流播放活動監控器偵錯串流的 ID。 發布商可透過這項功能，在串流播放活動監控器工具中輕鬆找到串流記錄。

Class google.ima.dai.api.VODStreamRequest

欄位

contentSourceId, videoId

這個類別用於指定 VOD 串流要求的屬性。

建構函式：

參數	類型	說明
opt_VODStreamRequest	Object	已指派串流要求屬性的物件。

屬性

名稱	類型	說明
contentSourceId		發布商內容的專屬 ID，來自 CMS。點播串流必須提供。
videoId		影片內容來源的 ID。這是隨選串流的必填項目。

常數 google.ima.VERSION

包含完整 SDK 版本的字串。