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

欄位

用於指定 CuePoint 屬性的類別，代表 DAI VOD 串流中的廣告插播。

屬性

名稱 類型 說明
end

這個提示點的結束時間。
played

是否已播放這個提示點。
start

這個提示點的開始時間。

類別 google.ima.dai.api.LiveStreamRequest

欄位

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

建構函式：
參數 類型 說明
opt_liveStreamRequest Object

物件，已指派串流要求屬性。

屬性

名稱 類型 說明
assetKey

用來決定應播放哪個串流。直播串流要求素材資源金鑰是可在 DFP 使用者介面中找到的 ID。

類別 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。如果不存在此類 cuepoint，則會傳回空值。此方法用於實作回彈等功能，並在發布商偵測到使用者已快轉，以便將使用者帶回廣告插播時呼叫。

傳回 google.ima.dai.api.CuePoint：指定串流時間的前一 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

來自內容管理系統的發布商內容專屬 ID。如要提供隨選串流，就必須提供這項資訊。
videoId

影片內容來源的 ID。這是隨選串流的必要條件。

常數 google.ima.VERSION

包含 SDK 完整版本的字串。