google. ima. ImaSdkSettings
Esta classe contém configurações para todo o SDK.
Enumerações
CompanionBackfillMode
string
Define um conjunto de constantes para a configuração de preenchimento complementar. Essa configuração indica se os complementares precisam ser preenchidos em vários cenários.
Se o valor for ALWAYS
, o preenchimento
complementar será feito em todas as situações, mesmo quando nenhum
anúncio principal for retornado.
Se o valor for ON_MASTER_AD
, será feita uma tentativa de preenchimento
complementar se houver um anúncio principal com menos complementares
do que um espaço complementar. Os complementares ausentes serão preenchidos.
O valor padrão é ALWAYS
.
... let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div'); slot1.addService(googletag.companionAds()).addService(googletag.pubads()); ... googletag.companionAds().setRefreshUnfilledSlots(true); ... googletag.enableServices();Para vídeos de reprodução automática, a seguinte alteração é recomendada para evitar que os espaços complementares sejam pré-carregados e depois substituídos imediatamente por complementares.
googletag.pubads().disableInitialLoad(); ... googletag.enableServices();
Valor |
|
---|---|
SEMPRE |
|
ANÚNCIO_DE_MASTER |
ModoVpago
number
Um conjunto de constantes para ativar a funcionalidade VPAID.
Valor |
|
---|---|
DESATIVADO |
Os anúncios VPAID não serão reproduzidos, e um erro será retornado. |
ATIVADO |
Os anúncios VPAID são ativados usando um iframe de vários domínios. O anúncio VPAID não pode acessar o site. Os anúncios VPAID que dependem do acesso otimizado ao iframe podem apresentar um erro. Esse é o padrão. |
SEGURANÇA |
Os anúncios VPAID são ativados usando um iframe compatível. Isso permite que o anúncio acesse o site por JavaScript. |
Propriedades
CompanionBackfillMode
string
Define um conjunto de constantes para a configuração de preenchimento complementar. Essa configuração indica se os complementares precisam ser preenchidos em vários cenários.
Se o valor for ALWAYS
, o preenchimento
complementar será feito em todas as situações, mesmo quando nenhum
anúncio principal for retornado.
Se o valor for ON_MASTER_AD
, será feita uma tentativa de preenchimento
complementar se houver um anúncio principal com menos complementares
do que um espaço complementar. Os complementares ausentes serão preenchidos.
O valor padrão é ALWAYS
.
... let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div'); slot1.addService(googletag.companionAds()).addService(googletag.pubads()); ... googletag.companionAds().setRefreshUnfilledSlots(true); ... googletag.enableServices();Para vídeos de reprodução automática, a seguinte alteração é recomendada para evitar que os espaços complementares sejam pré-carregados e depois substituídos imediatamente por complementares.
googletag.pubads().disableInitialLoad(); ... googletag.enableServices();
Valor |
|
---|---|
SEMPRE |
|
ANÚNCIO_DE_MASTER |
ModoVpago
number
Um conjunto de constantes para ativar a funcionalidade VPAID.
Valor |
|
---|---|
DESATIVADO |
Os anúncios VPAID não serão reproduzidos, e um erro será retornado. |
ATIVADO |
Os anúncios VPAID são ativados usando um iframe de vários domínios. O anúncio VPAID não pode acessar o site. Os anúncios VPAID que dependem do acesso otimizado ao iframe podem apresentar um erro. Esse é o padrão. |
SEGURANÇA |
Os anúncios VPAID são ativados usando um iframe compatível. Isso permite que o anúncio acesse o site por JavaScript. |
Métodos
getCompanionBackfill
getCompanionBackfill() retorna CompanionBackfillMode
Retorna o modo de preenchimento complementar atual.
- Retorna
-
non-null CompanionBackfillMode
O valor atual.
getDisableCustomPlaybackForIOS10+
getDisableCustomPlaybackForIOS10Plus() retorna o booleano
Define se a reprodução personalizada será desativada nos navegadores iOS 10 ou superior. O valor padrão é falso.
- Retorna
-
boolean
getFeatureFlags
getFeatureFlags() retorna Object com qualquer tipo de propriedade
Retorna um objeto com chaves como sinalizações e valores de recurso como o estado atual.
- Retorna
-
non-null Object with any type properties
getLocale
getLocale() retorna a string
Retorna a localidade fornecida pelo editor.
- Retorna
-
string
Localidade fornecida pelo editor.
getNumRedirecionamentos
getNumRedirecionamentos() retorna um número.
Retorna o número máximo de redirecionamentos para redirecionamentos subsequentes que será negado.
- Retorna
-
number
é o número máximo de redirecionamentos.
getPlayerType
getPlayerType() retorna uma string.
Retorna o tipo de player fornecido pelo parceiro.
- Retorna
-
string
Tipo de jogador parceiro.
getPlayerVersion
getPlayerVersion() retorna a string
Retorna a versão do player fornecida pelo parceiro.
- Retorna
-
string
Versão do player do parceiro.
getPpid
getPpid() retorna (nulo ou string)
Retorna o ID fornecido pelo editor.
- Retorna
-
(null or string)
ID fornecido pelo editor.
isCookiesEnabled
isCookiesEnabled() retorna o booleano
- Retorna
-
boolean
: indica se o editor permite ou não o uso de cookies.
setAutoPlayAdBreaks
setAutoPlayAdBreaks(autoPlayAdBreaks) retorna nulo
Define se os intervalos de anúncio VMAP e regras de anúncio serão reproduzidos automaticamente
Parâmetro |
|
---|---|
Intervalos de anúncios automáticos no Google Play |
boolean Define se os intervalos de anúncio serão reproduzidos automaticamente. |
- Retorna
-
void
setCompanionBackfill
setCompanionBackfill(mode) retorna void
Define o modo de preenchimento complementar. Veja os vários modos disponíveis em ImaSdkSettings.CompanionBackfillMode.
O modo padrão é ImaSdkSettings.CompanionBackfillMode.ALWAYS.
Parâmetro |
|
---|---|
modo |
CompanionBackfillMode O modo de preenchimento complementar escolhido. O valor não pode ser nulo. |
- Retorna
-
void
setCookiesEnabled
setCookiesEnabled(cookiesEnabled) retorna nulo
Indica se o SDK deve armazenar um cookie do Google Ad Manager (cookie GFP) no domínio do editor como um cookie primário. Isso permite a persistência entre várias visitas no mesmo domínio sem usar cookies de terceiros. O padrão é verdadeiro (true).
Essa configuração não afeta outros cookies que possam ser definidos por outras partes ou para outras finalidades. O consentimento e a desativação de usuários também podem desativar o uso de cookies primários. Elas serão selecionadas pelo uso do provedor de um provedor de gerenciamento de consentimento compatível com o IAB, se estiverem no mesmo frame.
Parâmetro |
|
---|---|
cookiesEnabled |
boolean |
- Retorna
-
void
setDisableCustomPlaybackForIOS10+
setDisableCustomPlaybackForIOS10Plus(disable) retorna nulo
Define se a reprodução personalizada será desativada nos navegadores iOS 10 ou superior. Se verdadeiro, os anúncios serão exibidos inline se o vídeo de conteúdo estiver inline. Isso ativa os anúncios TrueView puláveis. No entanto, o anúncio permanecerá inline e não será compatível com a tela cheia nativa do iOS. Quando falso, os anúncios serão exibidos no mesmo player que seu conteúdo. O valor definido aqui quando um AdDisplayContainer é criado é usado durante o ciclo de vida do contêiner. O valor padrão é falso.
Parâmetro |
|
---|---|
desativar |
boolean Indica se a reprodução personalizada será desativada ou não. |
- Retorna
-
void
SetFeatureFlags
setFeatureFlags(featureFlags) retorna um valor nulo
Defina o valor de qualquer sinalização de recurso. Isso precisa ser definido o quanto antes antes de solicitar anúncios. As configurações vão permanecer constantes até a próxima solicitação de anúncio. Chamar esse método novamente redefinirá todas as sinalizações de recurso para a próxima solicitação de anúncio.
Parâmetro |
|
---|---|
Sinalizações de recursos |
Objeto com qualquer propriedade de tipo O valor não pode ser nulo. |
- Retorna
-
void
setLocale
setLocale(locale) retorna nulo
Define a localidade fornecida pelo editor. Precisa ser chamado antes da criação do AdsLoader ou AdDisplayContainer. A localidade especifica o idioma em que os elementos da IU serão exibidos. Os códigos compatíveis estão disponíveis em Localização para idioma e localidade.
Parâmetro |
|
---|---|
localidade |
string Localidade fornecida pelo editor. |
- Retorna
-
void
setNumRedirecionamentos
setNumRedirecionamentos(numRedirecionamentos) retorna nulo
Especifica o número máximo de redirecionamentos antes que os redirecionamentos subsequentes sejam negados e o carregamento do anúncio seja cancelado. O número de redirecionamentos afeta diretamente a latência e a experiência do usuário. Isso se aplica a todos os anúncios wrapper VAST.
Parâmetro |
|
---|---|
NumRedirecionamentos |
number o número máximo de redirecionamentos. |
- Retorna
-
void
TipoDePlayer Set
setPlayerType(playerType) retorna nulo
Define o tipo de player fornecido pelo parceiro. Essa configuração precisa ser usada para especificar o nome do player que está sendo integrado ao SDK. O tipo de jogador com mais de 20 caracteres será truncado. O tipo de player especificado precisa ser curto e exclusivo. Essa é uma configuração opcional usada para melhorar a usabilidade do SDK ao rastrear os tipos de jogador.
Exemplo:
settings.setPlayerType('google/gmf-player');
Parâmetro |
|
---|---|
Tipo de jogador |
string O tipo de player do parceiro. |
- Retorna
-
void
Versão do setPlayer
setPlayerVersion(playerVersion) retorna nulo
Define a versão do player fornecida pelo parceiro. Essa configuração precisa ser usada para especificar a versão do player do parceiro que está sendo integrado ao SDK. As versões do player com mais de 20 caracteres serão truncadas. Essa é uma configuração opcional usada para melhorar a usabilidade do SDK ao rastrear a versão do player.
Exemplo:
settings.setPlayerVersion('1.0.0');
Parâmetro |
|
---|---|
Versão do player |
string Versão do player do parceiro. |
- Retorna
-
void
setPpid
setPpid(ppid) retorna nulo
Define o ID fornecido pelo editor.
Parâmetro |
|
---|---|
ppid |
string ID fornecido pelo editor. |
- Retorna
-
void
ID da sessão
setSessionId(sessionId) retorna void.
O ID da sessão é um ID aleatório temporário. Ele é usado exclusivamente para limite de frequência. O ID da sessão precisa ser um UUID.
Parâmetro |
|
---|---|
sessionId |
string Um UUID temporário usado para limite de frequência. |
- Retorna
-
void
setVpaidAllowed
setVpaidAllowed(allowVpaid) retorna nulo
Obsoleto. Use setVpaidMode. Define se os criativos VPAID são permitidos.
Parâmetro |
|
---|---|
allowVpaid |
boolean Indica se os criativos VPAID são permitidos. |
- Retorna
-
void
setVpaidMode
setVpaidMode(vpaidMode) retorna nulo
Define o modo de reprodução VPAID.
Parâmetro |
|
---|---|
vpaidMode |
ModoVpago Define como os anúncios VPAID serão reproduzidos. O padrão é o modo seguro. O valor não pode ser nulo. |
- Retorna
-
void