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 類別

Fields

用來指定廣告進度資料的類別。

屬性

名稱 類型 說明
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 類別

Fields

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

屬性

名稱 類型 說明
end

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

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

這個提示點的開始時間。

google.ima.dai.api.LiveStreamRequest 類別

Fields

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

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

物件已獲派串流要求屬性。

屬性

名稱 類型 說明
assetKey

這會用來判斷應播放哪一個串流。直播活動請求素材資源金鑰是在 DFP UI 中找到的 ID。

google.ima.dai.api.StreamData 類別

Fields

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

屬性

名稱 類型 說明
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

Fields

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 類別

方法

處理動態廣告插播串流。這個外掛程式能管理與 DAI 後端的互動，並處理追蹤連線偵測 (ping) 以及將串流和廣告事件轉送給發布商。這個管理員不會繼承 BaseAD 的特定廣告，因為該管理員並非特定廣告的管理工具，而是整個串流的管理器。

建構函式：
參數 類型 說明
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

不含任何廣告的內容時間 (以秒為單位)。

google.ima.dai.api.StreamRequest 類別

Fields

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

屬性

名稱 類型 說明
adTagParameters

您可以覆寫串流請求中的少數廣告代碼參數。 為串流提供指定目標參數可提供詳細資訊。 您可以將 dai-ot 和 dai-ov 參數用於串流變化版本偏好設定。詳情請參閱「 覆寫串流變化版本參數」。
apiKey

串流要求 API 金鑰。可透過 DFP 管理員 UI 設定，並提供給發布商用來解鎖內容。驗證嘗試存取內容的應用程式。
streamActivityMonitorId

要透過串流活動監控器對串流進行偵錯的 ID。 這個屬性是方便發布商在串流活動監控工具中尋找串流記錄的便利方法。

google.ima.dai.api.VODStreamRequest 類別

Fields

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

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

物件。

屬性

名稱 類型 說明
contentSourceId

發布商內容的專屬 ID (從 CMS 取得)。這是隨選串流的必要項目，
videoId

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

常數 google.ima.VERSION

包含完整版本 SDK 的字串。