google. ima. AdEvent
當廣告狀態變更,且使用者與廣告互動時,廣告將會發出此事件類型通知。例如廣告開始播放、獲得點擊等。您可以在 PPID 上註冊各種狀態變更事件。
Enumeration
類型
字串
AdEvents 類型
價值 |
|
---|---|
AD_CAN_PLAY |
廣告開始播放時,可在廣告開頭或緩衝處理完成後播放。 |
CONTENT_PAUSE_REQUESTED |
內容暫停時觸發。此情況通常發生在廣告即將覆蓋內容前。 |
CONTENT_RESUME_REQUESTED |
應恢復內容時觸發。這通常會在廣告播完或收合時發生。 |
點擊 |
點選廣告時觸發。 |
VIDEO_CLICKED |
在影片廣告中未點擊的部分獲得點擊時觸發。 |
VIDEO_ICON_CLICKED |
使用者點選影片圖示時觸發。 |
已經開始 |
廣告開始播放時觸發。 |
AD_PROGRESS |
廣告目前的時間值變更時觸發。呼叫此事件的 getAdData() 會傳回 AdProgressData 物件。 |
AD_BUFFERING |
當廣告停止播放至緩衝區時播放。 |
影響 |
偵測到曝光網址時觸發。 |
已暫停 |
廣告暫停時觸發。 |
已恢復 |
廣告恢復時觸發。 |
「FIRST_QUARTILE」 |
廣告播放頭跨越四分之一時觸發。 |
中 |
廣告播放頭跨過中點時觸發。 |
第 3 季 |
廣告播放頭跨越第三四分位數時觸發。 |
完成 |
廣告播放完畢時觸發。 |
DURATION_CHANGE |
廣告時間長度變更時觸發。 |
USER_CLOSE |
使用者關閉廣告時觸發。 |
已載入 |
有可用廣告資料時觸發。 |
ALL_ADS_COMPLETED |
當廣告管理員完成廣告回應中的所有有效廣告,或回應未傳回任何有效廣告時,即會觸發。 |
略過數 |
使用者略過廣告時觸發。 |
LINEAR_CHANGED |
當顯示的廣告從線性變更為非線性或反轉時觸發。 |
SKIPPABLE_STATE_CHANGED |
顯示的廣告可略過狀態變更時觸發。 |
AD_METADATA |
廣告清單載入時觸發。 |
AD_BREAK_READY |
如果 autoPlayAdBreaks 為 false,當廣告規則或 VMAP 廣告插播播放時觸發。 |
LOG |
發生非嚴重錯誤時觸發。使用者無須採取任何行動,因為 SDK 會繼續因錯誤情況而繼續播放相同或下一次的廣告播放。 |
VOLUME_CHANGED (已調整) |
在音量改變時觸發。 |
VOLUME_MUTED |
廣告靜音時觸發。 |
互動 |
廣告觸發互動回呼時觸發。廣告互動包含廣告資料中的互動 ID 字串。 |
屬性
類型
字串
AdEvents 類型
價值 |
|
---|---|
AD_CAN_PLAY |
廣告開始播放時,可在廣告開頭或緩衝處理完成後播放。 |
CONTENT_PAUSE_REQUESTED |
內容暫停時觸發。此情況通常發生在廣告即將覆蓋內容前。 |
CONTENT_RESUME_REQUESTED |
應恢復內容時觸發。這通常會在廣告播完或收合時發生。 |
點擊 |
點選廣告時觸發。 |
VIDEO_CLICKED |
在影片廣告中未點擊的部分獲得點擊時觸發。 |
VIDEO_ICON_CLICKED |
使用者點選影片圖示時觸發。 |
已經開始 |
廣告開始播放時觸發。 |
AD_PROGRESS |
廣告目前的時間值變更時觸發。呼叫此事件的 getAdData() 會傳回 AdProgressData 物件。 |
AD_BUFFERING |
當廣告停止播放至緩衝區時播放。 |
影響 |
偵測到曝光網址時觸發。 |
已暫停 |
廣告暫停時觸發。 |
已恢復 |
廣告恢復時觸發。 |
「FIRST_QUARTILE」 |
廣告播放頭跨越四分之一時觸發。 |
中 |
廣告播放頭跨過中點時觸發。 |
第 3 季 |
廣告播放頭跨越第三四分位數時觸發。 |
完成 |
廣告播放完畢時觸發。 |
DURATION_CHANGE |
廣告時間長度變更時觸發。 |
USER_CLOSE |
使用者關閉廣告時觸發。 |
已載入 |
有可用廣告資料時觸發。 |
ALL_ADS_COMPLETED |
當廣告管理員完成廣告回應中的所有有效廣告,或回應未傳回任何有效廣告時,即會觸發。 |
略過數 |
使用者略過廣告時觸發。 |
LINEAR_CHANGED |
當顯示的廣告從線性變更為非線性或反轉時觸發。 |
SKIPPABLE_STATE_CHANGED |
顯示的廣告可略過狀態變更時觸發。 |
AD_METADATA |
廣告清單載入時觸發。 |
AD_BREAK_READY |
如果 autoPlayAdBreaks 為 false,當廣告規則或 VMAP 廣告插播播放時觸發。 |
LOG |
發生非嚴重錯誤時觸發。使用者無須採取任何行動,因為 SDK 會繼續因錯誤情況而繼續播放相同或下一次的廣告播放。 |
VOLUME_CHANGED (已調整) |
在音量改變時觸發。 |
VOLUME_MUTED |
廣告靜音時觸發。 |
互動 |
廣告觸發互動回呼時觸發。廣告互動包含廣告資料中的互動 ID 字串。 |
方法
getAd
getAd() 傳回廣告
取得目前正在播放或剛播放的廣告。
- 傳回
-
nullable Ad
與事件相關聯的廣告;如果沒有相關廣告,則會傳回空值。
getAdData
getAdData() 傳回物件
可允許從廣告傳遞額外資料。
範例:
if (event.type == google.ima.AdEvent.Type.LOG) {
let adData = event.getAdData();
if (adData['adError']) {
console.log('Non-fatal error occurred: ' +
adData['adError'].getMessage());
}
}
- 傳回
-
nullable Object
活動的額外資料。因發生錯誤而引發的記錄事件包含 google.ima.AdError 類型的物件,可使用「adError」鍵存取。