類別：IIaSdkSettings

google.ima.ImaSdkSettings

class public 靜態

這個類別包含全 SDK 設定。

列舉

夥伴候補廣告

常數 靜態

字串

定義隨播廣告候補廣告設定的一組常數。這項設定會指明是否應該在各種情況下使用隨播廣告。

如為 ALWAYS，則即使沒有傳回主廣告，系統仍會嘗試隨播廣告隨播廣告。

如果值為 ON_MASTER_AD，如果主廣告的隨播廣告數量少於隨播廣告版位數量，則系統會嘗試隨播廣告隨播廣告。系統會將缺少的隨播廣告補回。

預設值為 ALWAYS。

請注意，用戶端隨播廣告補充作業必須使用 Google 發布商廣告代碼 (GPT) 正確加上隨播廣告標記。 如要啟用候補廣告，您必須對標準 GPT 設定進行以下變更： 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
針對自動播放影片，建議您進行下列額外變更，以免隨播廣告版位預先載入並立即取代隨播廣告。 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

值

一律

ON_MASTER_AD

VPAID

常數 靜態

數字

啟用 VPAID 功能的一組常數。

值

已停用

VPAID 廣告不會播放，並且會傳回錯誤。

已啟用

使用跨網域 iframe 啟用 VPAID 廣告。VPAID 廣告無法存取網站。如果 VPAID 廣告仰賴同網域的 iframe 存取權，可能會發生錯誤。 此為預設值。

不安全

使用同網域 iframe 啟用 VPAID 廣告。這麼做可讓廣告透過 JavaScript 存取網站。

屬性

夥伴候補廣告

常數 靜態

字串

定義隨播廣告候補廣告設定的一組常數。這項設定會指明是否應該在各種情況下使用隨播廣告。

如為 ALWAYS，則即使沒有傳回主廣告，系統仍會嘗試隨播廣告隨播廣告。

如果值為 ON_MASTER_AD，如果主廣告的隨播廣告數量少於隨播廣告版位數量，則系統會嘗試隨播廣告隨播廣告。系統會將缺少的隨播廣告補回。

預設值為 ALWAYS。

請注意，用戶端隨播廣告補充作業必須使用 Google 發布商廣告代碼 (GPT) 正確加上隨播廣告標記。 如要啟用候補廣告，您必須對標準 GPT 設定進行以下變更： 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
針對自動播放影片，建議您進行下列額外變更，以免隨播廣告版位預先載入並立即取代隨播廣告。 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

值

一律

ON_MASTER_AD

VPAID

常數 靜態

數字

啟用 VPAID 功能的一組常數。

值

已停用

VPAID 廣告不會播放，並且會傳回錯誤。

已啟用

使用跨網域 iframe 啟用 VPAID 廣告。VPAID 廣告無法存取網站。如果 VPAID 廣告仰賴同網域的 iframe 存取權，可能會發生錯誤。 此為預設值。

不安全

使用同網域 iframe 啟用 VPAID 廣告。這麼做可讓廣告透過 JavaScript 存取網站。

方法

getCompanionBackfill

getCompanionBackfill() 傳回 CompanionBackfillMode

傳回目前的隨播廣告候補模式。

傳回

non-null CompanionBackfillMode 目前的值。

getDisableCustomplayForIOS10Plus

getDisableCustomplayForIOS10Plus() 會傳回布林值

決定是否要在 iOS 10 以上版本瀏覽器中停用自訂播放功能。 預設值為 false。

傳回

boolean 

getFeatureFlags

getFeatureFlags() 會傳回具有任何類型屬性的物件

傳回具有索引鍵標記並做為目前狀態值的物件。

傳回

non-null Object with any type properties 

getLocale

getLocale() 傳回字串

傳回發布商提供的語言代碼。

傳回

string 發布商提供的語言代碼。

getNumRedirects

getNumRedirects() 傳回數字

會傳回後續重新導向的重新導向數量上限。

傳回

number 重新導向的次數上限。

getPlayerType

getPlayerType() 傳回字串

傳回合作夥伴提供的播放器類型。

傳回

string 夥伴播放器類型。

getPlayerVersion

getPlayerVersion() 傳回字串

傳回合作夥伴提供的播放器版本。

傳回

string 夥伴播放器版本。

getPpid

getPpid() 傳回 (空值或字串)

傳回發布商提供的 ID。

傳回

(null or string) 個發布商提供的 ID。

isCookiesEnabled

isCookiesEnabled() 會傳回布林值

傳回

boolean 表示發布商是否允許使用 Cookie。

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) 傳回

設定是否自動播放 VMAP 和廣告規則廣告插播

參數

autoPlayAdBreaks

布林值

是否自動播放廣告插播。
傳回

void 

setCompanionBackfill

setCompanionBackfill(mode) 傳回 void

設定隨播廣告候補模式。查看 ImaSdkSettings.CompanionBackfillMode 中提供的各種模式。

預設模式為 ImaSdkSettings.CompanionBackfillMode.ALWAYS。

參數

模式

夥伴候補廣告

所選隨播廣告候補模式。

值不得為空值。
傳回

void 

setCookiesEnabled

setCookiesEnabled(cookiesEnabled) 傳回 void

該 SDK 是否應將 Google Ad Manager Cookie (GFP Cookie) 儲存為發布商網域，做為第一方 Cookie。這樣就能讓多次造訪同一個網域時不需要持續使用第三方 Cookie。預設為 true。

這項設定不會影響其他可能由他人設定或用於其他用途的 Cookie。使用者同意聲明及選擇停用也可能會停用第一方 Cookie 的使用情況。如果發布商在同一個頁框中採用符合 IAB 規範的同意聲明管理供應商，他們就會選擇這些 Cookie。

參數

Cookie 已啟用

布林值
傳回

void 

setDisableCustomplayForIOS10Plus

setDisableCustomplayForIOS10Plus(disable) 傳回 void

設定是否停用 iOS 10 以上版本瀏覽器的自訂播放功能。如果為 true，如果內容影片為內嵌影片，廣告就會以內嵌方式播放。這樣就能啟用 TrueView 可略過廣告。但廣告會保持內嵌，且不支援 iOS 的原生全螢幕功能。如果為 false，廣告將會與您的內容在同一個播放器中播放。這裡在建立 AdDisplayContainer 時設定的值會用於容器的生命週期。預設值為 false。

參數

停用

布林值

是否停用自訂播放。
傳回

void 

setFeatureFlags

setFeatureFlags(featureFlags) 傳回 void

設定任何功能旗標的值。請盡早完成相關設定，然後再發出廣告請求。在下一次廣告請求之前，設定會保持不變。再次呼叫此方法將會重設下一個廣告請求的任何功能旗標。

參數

featureFlags

含有任何類型屬性的物件

值不得為空值。
傳回

void 

設定語言代碼

setLocale(locale) 會傳回 void

設定發布商提供的語言代碼。必須先呼叫，才能建立 AdsLoader 或 AdDisplayContainer。語言代碼會指定要顯示 UI 元素的語言。如需支援的語言代碼，請參閱本地化語言與語言代碼一文。

參數

語言代碼

字串

發布商提供的語言代碼。
傳回

void 

setNumRedirects

setNumRedirects(numRedirects) 傳回 void

指定重新導向的後續重新導向數量上限。系統會拒絕後續的重新導向，並停止廣告載入。重新導向的數量會直接影響延遲時間，進而影響使用者體驗。這項規定適用於所有 VAST 包裝函式廣告。

參數

num 重新導向

數字

重新導向數量上限。
傳回

void 

setPlayerType

setPlayerType(playerType) 傳回 void

設定合作夥伴提供的播放器類型。這個設定應用來指定與 SDK 整合的玩家名稱。長度超過 20 個字元的播放器類型會遭到截斷。指定的玩家類型應簡短有力。這是選擇性的設定，可追蹤播放器類型以改善 SDK 可用性。

範例： 


settings.setPlayerType('google/gmf-player');

參數

播放器類型

字串

合作夥伴播放器的類型。
傳回

void 

setPlayerVersion

setPlayerVersion(playerVersion) 傳回 void

設定合作夥伴提供的播放器版本。這項設定應用於指定與 SDK 整合的合作夥伴播放器版本。長度超過 20 個字元的播放器版本會遭到截斷。這是選用設定，可用來追蹤玩家版本以提升 SDK 可用性。

範例： 


settings.setPlayerVersion('1.0.0');

參數

播放器版本

字串

合作夥伴播放器的版本。
傳回

void 

setPpid

setPpid(ppid) 傳回 void

設定發布商提供的 ID。

參數

ppiD

字串

發布商提供的 ID。
傳回

void 

setSessionId

setSessionId(sessionId) 會傳回 void

工作階段 ID 是臨時隨機 ID。這個展示頻率上限只能用於展示頻率上限。工作階段 ID 必須是 UUID。

參數

工作階段編號

字串

用於展示頻率上限的暫時 UUID。
傳回

void 

setVpaidAllowed

setVpaidAllowed(allowVpaid) 傳回

已淘汰，使用 setVpaidMode。 設定是否允許 VPAID 廣告素材。

參數

allowVpaid

布林值

是否允許 VPAID 廣告素材。
傳回

void 

setVpaidMode

setVpaidMode(vpaidMode) 傳回 void

設定 VPAID 播放模式。

參數

vpaidMode

VPAID

設定 VPAID 廣告的播放方式。預設值為安全模式。

值不得為空值。
傳回

void