google. ima. AdDisplayContainer
此類別代表用來顯示廣告的容器。SDK 會自動在 containerElement 參數內建立結構來存放影片和重疊廣告。
建立這個類別的執行個體會在 containerElement 建立 IFRAME,並載入 SDK 核心。您必須保留這個 iFrame,SDK 才能正常運作。播放完所有廣告且不再需要 SDK 後,請使用 destroy()
方法卸載 SDK。
containerElement 參數必須是屬於 DOM 的一部分元素。您必須正確定位 containerElement,廣告才能正確顯示。建議您將內容置於內容影片播放器上方,並調整成整個影片播放器的大小。 如要進一步瞭解建議的實作方式,請參閱 SDK 說明文件。
注意:您必須在使用者動作 (例如點擊或輕觸) 直接叫用的程式碼中呼叫 initialize()
方法。
建構函式
AdDisplayContainer
new AdDisplayContainer(containerElement, videoElement, clickTrackingElement)
參數 |
|
---|---|
containerElement |
廣告所在的元素。 您必須先將元素插入 DOM,才能建立 AdDisplayContainer。 值不得為空值。 |
影片元素 |
選用 指定替代的影片廣告播放元素。我們建議您一律傳入內容影片播放器。 值不得為空值。 |
點擊追蹤元素 |
選用 指定替代的影片廣告點擊元素。請將此欄位留空,讓 SDK 處理點擊。即使已提供 SDK,當非 AdSense/AdX 廣告素材在不支援影片播放器的使用者介面元素 (例如 iPhone 或 Android 4.0 以下版本) 的環境中顯示時,SDK 才會使用自訂點擊追蹤元素。自訂點擊追蹤元素一律不得在影片播放器中顯示,因為這類元素可能會攔截點擊 SDK 轉譯的 UI 元素的點擊次數。另請注意,SDK 不會修改自訂點擊追蹤元素的顯示設定。也就是說,如果您提供了自訂點擊追蹤元素,則該元素在播放線性廣告時,必須正確顯示。您可以在系統啟動 ima.AdEvent.Type.STARTED 事件時檢查 ima.admanager.isCustomClickTrackingUsed,以判斷是否要顯示自訂點擊追蹤元素。如果您的 UI 觸發了 ima.AdEvent.Type.CONTENT_RESUME_REQUESTED 事件,建議您隱藏點擊追蹤元素。 值不得為空值。 |
方法
destroy
delete()
破壞內部狀態和先前建立的 DOM 元素。IMA SDK 將會卸載,且不得再呼叫任何 API。
initialize
初始化()
初始化播放的影片元素。您必須呼叫這個方法做為使用者動作的直接結果,這樣瀏覽器才能將影片元素標示為使用者啟動。
部分瀏覽器靜音時,使用者不需互動即可播放影片。為此,請使用 AdsRequest.setAdWillPlayMuted(true)
,並在 AdsManager.start()
之前呼叫此方法。