google. ima. 3
將外部公用 API 提供給發布者,並與廣告管理員的內部執行個體通訊。
方法
收合
收合()
收合目前的廣告。這是 HTML5 SDK 的免人工管理。
設定 YAML
configureDAI(content, adsrenderSettings)
設定必要的參數,以便從 DAILoaded 事件取得這個 Ad Manager 的參照。
參數 |
|
---|---|
內容 |
物件 可播放發布商內容的物件。 值不得為空值。 |
adsrender Settings |
選用 Ads 轉譯設定 控制廣告的顯示設定 (選用)。 值可以是空值。 |
destroy
delete()
移除在執行階段載入且必須在廣告完成時正確移除的廣告素材資源,並停止廣告和所有追蹤。
捨棄廣告插播
捨棄 AdBreak()
如果目前正在播放廣告插播,請捨棄廣告插播並繼續播放內容。 否則,請忽略下一個已排定的廣告時段。例如,系統可在廣告載入器載入後立即呼叫此方法來忽略片頭廣告,而不會失去日後的片中廣告或片尾廣告。除非廣告請求傳回播放清單或 VMAP 回應,否則不會發生任何錯誤。
展開
expand()
展開目前的廣告。這是 HTML5 SDK 的免人工管理。
主軸
Focus()
將焦點放在略過按鈕 (如果有的話)。如果不存在,則將焦點放在互動元素上,包括圖示或互動式廣告素材。
getAd 可略過狀態
getAdskippableState() 傳回布林值
如果目前可以略過廣告,則傳回「是」。當這個值變更時,AdsManager
會啟動 AdEvent.SKIPPABLE_STATE_CHANGED
事件。
- 傳回
-
boolean
如果廣告目前可以略過,傳回 True,否則傳回 False。
getCuePoints
getCuePoints() 會傳回數字陣列
傳回以秒為單位的偏移陣列,指出已排定的廣告時段。片頭廣告以 0 表示,片尾廣告則以 -1 表示。空白的陣列表示廣告或廣告連播沒有時間表,而且可以隨時播放。
- 傳回
-
non-null Array of number
時間偏移清單,以秒為單位。
getRemainingTime
getRemainingTime() 傳回數字
取得目前播放廣告的剩餘時間。如果廣告尚未載入或已經播放完畢,API 會傳回 -1。
- 傳回
-
number
傳回目前廣告的剩餘時間。如果目前廣告的未定義時間 (例如自訂廣告) 未定義,則該值會傳回 -1。
getVolume
getVolume() 傳回數字
取得目前廣告的音量。
- 傳回
-
number
目前廣告的音量,從 0 (靜音) 到 1 (最大)。
init
init(width, height, viewMode, videoElement)
呼叫 init 以初始化廣告管理員上的廣告體驗。
參數 |
|
---|---|
width |
數字 廣告的選擇寬度。 |
height |
數字 廣告的選擇高度。 |
查看模式 |
檢視模式 所選的檢視模式。 值不得為空值。 |
影片元素 |
選用 HTML 影片元素 自訂播放的影片元素。此影片元素會覆寫 AdDisplayContainer 建構函式中提供的元素。除非絕對必要,否則請使用這項屬性;否則,建議您在建立 AdDisplayContainer 時指定此影片元素。 值可以是空值。 |
自訂點擊追蹤追蹤
isCustomClickTrackingUsed() 傳回布林值
如果您在目前的廣告中用於自訂點擊追蹤元素,則傳回 true。只有在您為 AdDisplayContainer
提供選用的點擊追蹤元素、使用自訂播放,且目前不是 AdSense/AdX 廣告時,才能使用自訂點擊追蹤功能。
- 傳回
-
boolean
是否使用自訂點擊追蹤。
自訂播放
isCustomplayUsed() 會傳回布林值
如果自訂影片元素用於播放目前的廣告,則傳回「是」。當自訂影片元素在 AdDisplayContainer
上提供選用影片元素時,就會播放自訂播放功能。這樣一來,自訂影片元素就能提供更流暢的廣告瀏覽體驗。
- 傳回
-
boolean
是否要使用自訂播放。
暫停
pause()
暫停目前正在播放的廣告。顯示靜態重疊廣告、廣告尚未載入或已經播放完畢時,這個函式都不會發生任何動作。
resize
調整大小(寬度、高度、檢視模式)
調整目前廣告的大小。
參數 |
|
---|---|
width |
數字 新的廣告版位寬度。 |
height |
數字 新的廣告版位高度。 |
查看模式 |
檢視模式 新的檢視模式。 值不得為空值。 |
resume
重新啟用()
繼續載入並暫停目前廣告。顯示靜態重疊廣告、廣告尚未載入或已經播放完畢時,這個函式都不會發生任何動作。
setVolume
setVolume(音量)
設定目前廣告的音量。
參數 |
|
---|---|
音量 |
數字 要設定的音量,從 0 (靜音) 到 1 (最大)。 |
略過
略過()
AdsManager.getAdSkippableState()
為 true 時略過目前廣告。在其他情況下呼叫時,略過設定不會產生任何作用。略過作業完成後,AdsManager
會啟動 AdEvent.SKIPPED
事件。
開始播放
start()
開始播放廣告。
開發人員必須先呼叫 AdDisplayContainer.initialize()
。
停止
stop()
停止播放廣告。呼叫這個代碼會讓發布商返回內容。
更新廣告算繪設定
updateAdsrenderSettings(adsrenderSettings)
更新廣告顯示設定。當廣告顯示設定 (例如位元率) 需要更新時,特別適合用於廣告插播之間的 VMAP 應用實例。
參數 |
|
---|---|
adsrender Settings |
Ads 轉譯設定 新版廣告顯示方式設定。 值不得為空值。 |