类：ImaSdkSettings

google.ima.ImaSdkSettings

class public static

此类包含 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();

价值

始终激活

已启用主广告

VPAID 模式

常量 静态

number

用于启用 VPAID 功能的一组常量。

价值

已停用

VPAID 广告将无法播放，并且系统将返回错误。

已启用

VPAID 广告是使用跨网域 iframe 启用的。VPAID 广告无法访问网站。依赖于易用型 iframe 访问的 VPAID 广告可能会出错。 这是默认值。

不安全

VPAID 广告是使用友好型 iframe 启用的。这样就允许广告通过 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();

价值

始终激活

已启用主广告

VPAID 模式

常量 静态

number

用于启用 VPAID 功能的一组常量。

价值

已停用

VPAID 广告将无法播放，并且系统将返回错误。

已启用

VPAID 广告是使用跨网域 iframe 启用的。VPAID 广告无法访问网站。依赖于易用型 iframe 访问的 VPAID 广告可能会出错。 这是默认值。

不安全

VPAID 广告是使用友好型 iframe 启用的。这样就允许广告通过 JavaScript 访问网站。

方法

getCompanionBackfill

getCompanionBackfill() 返回 CompanionBackfillMode

返回当前的随播补余广告模式。

返回

non-null CompanionBackfillMode：当前值。

getdisableCustomPlaybackForIOS10Plus

getdisableCustomPlaybackForIOS10Plus() 返回布尔值

获取是否在 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() 返回（null 或字符串）

返回发布商提供的 ID。

返回

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

isCookiesEnabled

isCookiesEnabled() 返回布尔值

返回

boolean发布商是否允许使用 Cookie。

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) 返回空

设置是否自动播放 VMAP 和广告规则广告插播

参数

autoPlayAdBreaks

boolean

是否自动播放广告插播时间点。
返回

void 

setCompanionBackfill

setCompanionBackfill(mode) return void

设置随播补余广告模式。请参阅 ImaSdkSettings.CompanionBackfillMode 中提供的各种模式。

默认模式为 ImaSdkSettings.CompanionBackfillMode.ALWAYS。

参数

模式

伙伴回填模式

所选的随播补余广告模式。

值不能为 null。
返回

void 

setCookiesEnabled

setCookiesEnabled(cookiesEnabled) 返回空

该 SDK 是否应将 Google Ad Manager Cookie（GFP Cookie）作为第一方 Cookie 存储在发布商网域上。这样一来，无需使用第三方 Cookie，即可在对同一网域的多次访问中保留数据。默认值为 true。

此设置不会影响可能由其他方或出于其他目的而设置的其他 Cookie。用户也选择停用和停用 Cookie 也可能会停用第一方 Cookie。如果发布商在同一框架中采用与 IAB 标准的意见征求管理提供程序，那么这些参数将用作参数。

参数

Cookie 已启用

boolean
返回

void 

setDisabledCustomPlaybackForIOS10Plus

setdisableCustomPlaybackForIOS10Plus(disable) 返回 void

设置是否在 iOS 10+ 浏览器上停用自定义播放功能。如果为 true，则如果内容视频是内嵌视频，则广告会内嵌播放。这样可以启用 TrueView 可跳过广告。不过，该广告将保持内嵌状态，并且不支持 iOS 的原生全屏广告。如果为 false，则广告将与您的内容在同一播放器中播放。创建 AdDisplayContainer 时设置的值用于容器的整个生命周期。默认值为 false。

参数

停用

boolean

是否停用自定义播放。
返回

void 

setFeatureFlags

setFeatureFlags(featureFlags) 返回空

设置任何特征标志的值。应在请求广告之前尽早设置。在下一个广告请求发出之前，这些设置将保持不变。再次调用此方法将重置下一个广告请求的所有功能标志。

参数

功能标志

具有任何类型属性的对象

值不能为 null。
返回

void 

setLocale

setLocale(locale) 返回空值

设置出版商提供的语言区域。必须在创建 AdsLoader 或 AdDisplayContainer 之前调用。语言区域会指定界面元素的显示语言。您可以在语言和语言区域的本地化中找到受支持的代码。

参数

语言区域

字符串

出版商提供的语言区域。
返回

void 

setNumRedirects

setNumRedirects(numRedirects) 返回空

指定重定向数上限，超过此上限后，后续重定向将被拒绝，且广告加载将会中止。重定向次数会直接影响延迟时间，从而影响用户体验。这适用于所有 VAST 封装容器广告。

参数

重定向次数

number

重定向次数上限。
返回

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');

参数

playerVersion

字符串

合作伙伴播放器的版本。
返回

void 

setPpid

setPpid(ppid) 返回 null

设置发布商提供的 ID。

参数

每单位费用

字符串

发布商提供的 ID。
返回

void 

setSessionId

setSessionId(sessionId) 返回空

会话 ID 是临时随机 ID。它只能用于设置频次上限。会话 ID 必须是 UUID。

参数

sessionId

字符串

用于设置频次上限的临时 UUID。
返回

void 

setVpaidAllowed

setVpaidAllowed(allowVpaid) 返回 null

已弃用。使用 setVpaidMode。 设置是否允许 VPAID 广告素材。

参数

allowVpaid

boolean

是否允许 VPAID 广告素材。
返回

void 

setVpaidMode

setVpaidMode(vpaidMode) 返回空值

设置 VPAID 播放模式。

参数

vpaidMode

VPAID 模式

设置 VPAID 广告的播放方式。默认为安全模式。

值不能为 null。
返回

void