google.
google.ima 命名空間可讓您存取 SDK 的類別、介面、列舉和屬性。
類別
廣告
由代表不同廣告類型的類別而擴充的廣告類別。
AdCuePoints
提示點清單代表廣告插播的時間表。請注意，廣告插播中的個別廣告不會包含在時間表中。
AdDisplayContainer
這個類別代表用於顯示廣告的容器。SDK 會自動在 containerElement 參數內建立結構來存放影片和重疊廣告。
這個類別的執行個體建立後，會在 containerElement 內建立一個 IFRAME，並載入 SDK 核心。您必須保留這個 IFrame，以便 SDK 正常運作。所有廣告播放完畢，且不再需要 SDK 後，請使用 destroy() 方法卸載 SDK。
containerElement 參數必須是屬於 DOM 的元素。您必須正確調整 containerElement 的位置，廣告才能正確顯示。建議將其置於內容影片播放器上方，並調整大小以覆蓋整個影片播放器。 如要進一步瞭解建議的導入方式，請參閱 SDK 說明文件。
注意：一律是由使用者動作 (例如點擊或輕觸) 直接叫用的程式碼中呼叫 initialize() 方法。
AdError
AdError 會向使用者顯示資訊，以指出廣告載入或播放期間是否發生錯誤。errorType 存取子提供相關資訊，讓您瞭解廣告載入或播放期間是否發生錯誤。
AdErrorEvent
從 Google 或 DoubleClick 伺服器載入廣告時發生錯誤時，會引發這個事件。您可以針對事件註冊的類型是 AdsLoader 和 AVD。
AdEvent
當廣告狀態變更或使用者與廣告互動時，廣告會做為此事件類型的通知。例如廣告開始播放、點擊等。您可以在 Fragment 上註冊各種狀態變更事件。
AdMetadataEvent
這個類別已淘汰。使用 Animation.getCuePoints() API。 包含中繼資料的特定廣告事件。
AdPodInfo
廣告可能會包含在廣告連播中。這個物件會公開與該 Pod 相關的中繼資料，例如廣告連播中的廣告數量，以及廣告連播中的廣告位置。
這個物件中包含的 getTotalAds API 通常正確，但在特定情況下，這代表 SDK 的最佳猜測結果。詳情請參閱該方法的說明文件。
AdProgressData
這個物件會在廣告播放時公開目前進度的相關資訊。
AdsLoader
AdsLoader 可讓用戶端向廣告伺服器請求廣告。若要這麼做，使用者必須註冊 VASTLoadedEvent 事件，然後請求廣告。
回呼
為發布者提供外部公用 API，並與 Ad Manager 的內部執行個體進行通訊。
回呼載入事件
當廣告透過 AdsLoader 從 Google 或 DoubleClick 廣告伺服器成功載入時，就會觸發這個事件。您可以在 AdsLoader 上註冊這個事件。
AdsRenderingSettings
定義可控制廣告顯示方式的參數。
AdsRequest
指定廣告請求屬性的類別。
隨播廣告
代表隨播廣告。
CompanionAdSelectionSettings
夥伴物件用於呼叫 ima.Ad.getCompanionAds 函式時，用來定義選取條件。
ImaSdkSettings
這個類別包含 SDK 設定。
UniversalAdIdInfo
這個物件會顯示與廣告素材相關聯的通用廣告 ID 相關資訊，包括廣告 ID 值和廣告 ID 註冊資料庫。
列舉
OmidAccessMode
字串
網頁適用的 OMID 存取模式，可控管驗證指令碼可存取的內容。
值 |
|
|---|---|
|
受限 |
驗證指令碼採用沙箱機制，無法存取廣告素材或發布商網頁，也無法直接確認目前所在的發布商網域。 |
|
網域 |
驗證指令碼採用沙箱機制，無法存取廣告素材或發布商網頁。但是，載入指令碼的方式是直接載入確認的發布商網域。 |
|
滿袋 |
驗證指令碼可直接存取廣告素材和發布商頁面。 |
OmidVerificationVendor
數字
識別 OMID 驗證服務供應商。供應商會依字母順序排列。
值 |
|
|---|---|
|
比較 |
|
|
維度 |
|
|
|
|
|
INTEGRAL_AD_SCIENCE |
|
|
機制 |
|
|
MOAT |
|
|
深夜 |
|
|
Pixel |
|
|
其他 |
指令碼網址不符合任何其他廠商時，要使用的預設供應商。 |
UiElements
字串
指定可指定或隱藏的不同 UI 元素。AdSense 和 ADX 廣告可能會忽略這些設定。
值 |
|
|---|---|
|
廣告放送 |
在廣告使用者介面中顯示「廣告」文字。必須存在，才能顯示倒數計時器。 |
|
COUNTDOWN |
廣告標示功能必須顯示倒數計時器才能顯示。 |
ViewMode
字串
指定廣告的不同 VPAID 檢視模式。
值 |
|
|---|---|
|
一般 |
一般廣告檢視模式。 |
|
全螢幕 |
全螢幕廣告模式。表示廣告管理員會將目前的 AdDisplayContainer 排列方式視為全螢幕 (例如模擬的全螢幕)。這不會導致廣告管理員進入全螢幕模式。 |
- 已淘汰
屬性
OmidAccessMode
字串
網頁適用的 OMID 存取模式，可控管驗證指令碼可存取的內容。
值 |
|
|---|---|
|
受限 |
驗證指令碼採用沙箱機制，無法存取廣告素材或發布商網頁，也無法直接確認目前所在的發布商網域。 |
|
網域 |
驗證指令碼採用沙箱機制，無法存取廣告素材或發布商網頁。但是，載入指令碼的方式是直接載入確認的發布商網域。 |
|
滿袋 |
驗證指令碼可直接存取廣告素材和發布商頁面。 |
OmidVerificationVendor
數字
識別 OMID 驗證服務供應商。供應商會依字母順序排列。
值 |
|
|---|---|
|
比較 |
|
|
維度 |
|
|
|
|
|
INTEGRAL_AD_SCIENCE |
|
|
機制 |
|
|
MOAT |
|
|
深夜 |
|
|
Pixel |
|
|
其他 |
指令碼網址不符合任何其他廠商時，要使用的預設供應商。 |
UiElements
字串
指定可指定或隱藏的不同 UI 元素。AdSense 和 ADX 廣告可能會忽略這些設定。
值 |
|
|---|---|
|
廣告放送 |
在廣告使用者介面中顯示「廣告」文字。必須存在，才能顯示倒數計時器。 |
|
COUNTDOWN |
廣告標示功能必須顯示倒數計時器才能顯示。 |
ViewMode
字串
指定廣告的不同 VPAID 檢視模式。
值 |
|
|---|---|
|
一般 |
一般廣告檢視模式。 |
|
全螢幕 |
全螢幕廣告模式。表示廣告管理員會將目前的 AdDisplayContainer 排列方式視為全螢幕 (例如模擬的全螢幕)。這不會導致廣告管理員進入全螢幕模式。 |
- 已淘汰
設定
非空值 ImaSdkSettings
全域單例模式設定執行個體。