類別：廣告

google.ima。廣告

class   static

由代表不同廣告類型的類別而擴充的廣告類別。

方法

getAdId

getAdId() 傳回字串

廣告 ID 可用來同步處理主要廣告和隨播廣告。

傳回

string廣告 ID。如果沒有這項資訊，則為空白字串。

getAdPodInfo

getAdPodInfo() 傳回 AdPodInfo

傳回廣告的廣告連播資訊。

傳回

non-null AdPodInfo 廣告連播的廣告連播資訊。

getAdSystem

getAdSystem() 傳回字串

廣告回應中包含的來源廣告伺服器資訊。

傳回

string 廣告的來源廣告伺服器。如果無法提供這項資訊，則為空白字串。

取得廣告客戶名稱

getAdvertiserName() 傳回字串

廣告放送服務中定義的廣告客戶名稱。

傳回

string 廣告客戶名稱，如果系統無法提供這項資訊，則為空白字串。

getApiFramework

getApiFramework() 傳回字串

識別放送廣告所需的 API。這與 VAST 中指定的 apiFramework 相符。

傳回

nullable string API 架構必須執行廣告，如果無法取得這項資訊，則會傳回空值。

getCompanionAds

getCompanionAds(adSlotWidth、adSlotHeight、settings) 會傳回非空值 CompanionAd 的陣列

根據隨播廣告版位大小，取得這則廣告的隨播廣告。(選用) 接受進階選取設定。 請注意，此方法只會傳回在 ADED 事件之後或之後所取得的廣告例項非空值陣列。具體來說，來自 LOADED 事件的廣告會傳回空白陣列。

參數
廣告版位寬度	數字 隨播廣告版位寬度。
廣告版位高度	數字 隨播廣告版位高度。
設定	選用 CompanionAdSelectionSettings 隨播廣告的選取設定。 值不得為空值。

傳回

non-null Array of non-null CompanionAd 與設定和版位大小相符的隨播廣告陣列。

getContentType

getContentType() 傳回字串

傳回目前所選取廣告素材的內容類型；如果未選取任何廣告素材或內容類型，則傳回空白字串。對於線性廣告，必須先選取媒體檔案，才能在 {1}START 事件之後取得內容類型。

傳回

string 內容類型，如果未提供內容，則為空白字串。

getCreativeAdId

getCreativeAdId() 傳回字串

傳回廣告的 ISCI (業界標準商業識別碼) 代碼；如果程式碼無法使用，則會傳回空白字串。這是 VAST 回應中廣告素材的廣告 ID。

傳回

string 

getCreativeId

getCreativeId() 傳回字串

擷取廣告所選廣告素材的 ID。

傳回

string 廣告的所選廣告素材 ID；如果沒有這項資訊，則為空白字串。

getDealId

getDealId() 傳回字串

傳回目前廣告包裝函式鏈結的第一個交易 ID (從頂端開始)。如果無法使用，則傳回空字串。

傳回

string 

getDescription

getDescription() 傳回字串

從 VAST 回應傳回這個廣告的說明。

傳回

string說明。如果未指定，則為空白。

getDuration

getDuration() 會傳回數字

傳回所選廣告素材的持續時間，如果是非線性廣告素材，則傳回 -1。

傳回

number 所選廣告素材的時間長度 (以秒為單位)，如果是非線性，則為 -1。

getHeight

getHeight() 會傳回數字

傳回所選非線性廣告素材的高度。

傳回

number 所選非線性廣告素材的高度，或為線性廣告素材的 0。

getMediaUrl

getMediaUrl() 傳回字串

根據目前使用的媒體選擇設定，傳回廣告選擇的媒體檔案網址。如果無法提供這項資訊，則傳回空值。適用於 STARTED 活動。

傳回

nullable string 

getMinSuggestedDuration

getMinSuggestedDuration() 傳回數字

傳回應顯示非線性廣告素材的最小建議時間長度 (以秒為單位)。如果最小建議持續時間不明，則傳回 -2。對於線性廣告素材，廣告會傳回整個廣告期間。

傳回

number 廣告素材應至少顯示的時間長度下限 (秒)。

getSkipTimeOffset

getSkipTimeOffset() 會傳回數字

廣告開始播放前，播放秒數。如果不是可略過的廣告，則會傳回 -1。

傳回

number 秒 (以秒為單位) 或 -1。

getSurveyUrl

getSurveyUrl() 傳回字串

傳回與指定廣告的問卷調查相關聯的網址。如果無法提供，則傳回空值。

傳回

nullable string 

getTitle

getTitle() 傳回字串

傳回此 VAST 回應中這則廣告的標題。

傳回

string 標題。如果未指定，則為空白。

getTraffickingParameters

getTraffickingParameters() 傳回含有字串屬性的物件

取得廣告投放時與廣告相關聯的自訂參數。

傳回

non-null Object with string properties 將鍵對應至鍵的值；如果沒有這項資訊，則為空白物件。

getTraffickingParametersString

getTraffickingParametersString() 傳回字串

取得廣告投放時與廣告相關聯的自訂參數。從 getTraffickingParameters 傳回原始字串版本的已剖析參數。

傳回

string 投放參數；如果沒有這項資訊，則為空白字串。

getUiElements

getUiElements() 傳回字串陣列

傳回此廣告播放時要顯示的 UI 元素。 請參閱 UiElements 以瞭解傳回的陣列可能的元素。

傳回

non-null Array of string 顯示的 UI 元素。

getUniversalAdIdRegistry

getUniversalAdIdRegistry() 傳回字串

與這則廣告所選取廣告素材通用 AdId 相關的目錄。

已淘汰

請改用 ad.getUniversalAdIds()

傳回

string 傳回登錄值，否則傳回「unknown」。

getUniversalAdIdValue

getUniversalAdIdValue() 傳回字串

廣告所選廣告素材的 UniversalAdId。

已淘汰

請改用 ad.getUniversalAdIds()

傳回

string 傳回 ID 值，如果無法使用，則傳回「unknown」。

getUniversalAdIds

getUniversalAdIds() 傳回非空值 UniversalAdIdInfo 的陣列

廣告所選廣告素材的 UniversalAdId 清單。

傳回

non-null Array of non-null UniversalAdIdInfo 傳回適用於這則廣告的通用廣告 ID 資訊清單。

getVastMediaBitrate

getVastMediaBitrate() 會傳回數字

SDK 同時選取廣告素材和媒體檔案後，就會傳回 VAST 回應中列出的媒體檔案位元率。

傳回

number 所選媒體檔案的位元率或 0。

getVastMediaHeight

getVastMediaHeight() 傳回數字

傳回所選廣告素材的 VAST 媒體高度。

傳回

number 所選廣告素材的 VAST 媒體高度。如未選取，則為 0。

getVastMediaWidth

getVastMediaWidth() 會傳回數字

傳回所選廣告素材的 VAST 媒體寬度。

傳回

number 所選廣告素材的 VAST 媒體寬度；如未選取，則為 0。

getWidth

getWidth() 傳回數字

傳回所選廣告素材的寬度。

傳回

number 所選非線性廣告素材的寬度，或為 0 代表線性廣告素材的寬度。

getWrapperAdIds

getWrapperAdIds() 傳回字串陣列

用於包裝函式廣告的廣告 ID。傳回的 ID 會在內嵌廣告 (最內) 開始，並傳遞至最外包裝函式廣告。如果沒有包裝函式廣告，系統會傳回空白陣列。

傳回

non-null Array of string廣告 ID (從內嵌廣告開始)，如果沒有任何包裝函式廣告，則為空白陣列。

getWrapperAdSystems

getWrapperAdSystems() 傳回字串陣列

用於包裝函式廣告的廣告系統。回傳的系統會從內嵌廣告開始，然後掃到最外的包裝函式廣告。如果沒有包裝函式廣告，系統會傳回空白陣列。

傳回

non-null Array of string 廣告的系統 (從內嵌廣告開始)，如果沒有任何包裝函式廣告，則為空白陣列。

getWrapperCreativeIds

getWrapperCreativeIds() 傳回字串陣列

用於包裝函式廣告的廣告素材 ID。傳回的廣告素材 ID 會從內嵌廣告開始播放，並輪轉至最外層的包裝函式廣告。如果沒有包裝函式廣告，系統會傳回空白陣列。

傳回

non-null Array of string廣告廣告素材的 ID，從內嵌廣告開始；如果沒有可用的包裝函式廣告，則為空白陣列。

線性

isLinear() 傳回布林值

指出廣告目前的作業模式為線性或非線性。如果值為 true，則代表廣告為線性播放模式。如果為 false，表示非線性模式。播放器會檢查線性屬性，並依據廣告刊登位置的詳細資料更新狀態。廣告處於線性模式時，播放器會暫停播放內容影片。如果線性為 true，且廣告為片頭廣告 (外部定義)，播放器可能會選擇延後載入內容影片，直到廣告播放結束為止。

傳回

boolean如果是線性廣告，則為 True，否則傳回 false。