google.
O namespace google.ima fornece acesso às classes, interfaces, enumerações e propriedades do SDK.
Classes
Anúncio
Uma classe de anúncio que é estendida por classes que representam diferentes tipos de anúncio.
AdCuePoints (em inglês)
A lista de pontos de inserção representa uma programação de intervalos de anúncio. Os anúncios individuais no intervalo não estão incluídos na programação.
AdDisplayContainer
Esta classe representa um recipiente para exibir anúncios. O SDK criará automaticamente estruturas dentro do parâmetro containerElement para hospedar anúncios de vídeo e de sobreposição.
Quando uma instância dessa classe é criada, ela cria um IFRAME no containerElement e carrega o núcleo do SDK. Esse IFRAME precisa ser preservado para que o SDK funcione corretamente. Quando todos os anúncios forem reproduzidos
e o SDK não for mais necessário, use o método destroy()
para descarregar o SDK.
O parâmetro containerElement precisa ser um elemento que faz parte do DOM. É necessário posicionar corretamente o containerElement para que os anúncios sejam exibidos corretamente. É recomendável posicioná-lo acima do player de vídeo do conteúdo e dimensioná-lo para cobrir todo o player. Consulte a documentação do SDK para detalhes sobre implementações recomendadas.
Observação: é sempre necessário chamar o método initialize() no código que foi invocado diretamente por uma ação do usuário (como um clique ou um toque).
Erro de anúncio
O AdError expõe informações ao usuário caso tenha ocorrido uma falha durante o carregamento ou a reprodução do anúncio. O assistente de acesso errorType fornece informações indicando se o erro ocorreu durante o carregamento ou a reprodução do anúncio.
AdErrorEvent.
Este evento é gerado quando ocorre um erro ao carregar um anúncio dos servidores do Google ou da DoubleClick. Os tipos em que você pode se registrar para o evento são AdsLoader e AdsManager.
AdEvent.
Esse tipo de evento é gerado pelo anúncio como notificação quando o estado do anúncio muda e quando os usuários interagem com ele. Por exemplo, quando o anúncio começa a ser reproduzido, é clicado e muito mais. Você pode se registrar nos vários eventos de estado alterados no AdsManager.
AdMetadataEvent
Esta classe está obsoleta. Use a API AdsManager.getCuePoints(). Um evento de anúncio específico que carrega metadados.
AdPodInfo (em inglês)
Um anúncio pode fazer parte de um conjunto de anúncios. Esse objeto expõe metadados relacionados a esse conjunto, como o número de anúncios no conjunto e a posição do anúncio no conjunto.
A API getTotalAds contida nesse objeto geralmente está correta, mas, em determinados cenários, ela representa o melhor palpite do SDK. Consulte a documentação desse método para mais informações.
AdProgressData (em inglês)
Esse objeto expõe informações sobre o progresso atual durante a reprodução de um anúncio.
Google AdsLoader
O AdsLoader permite que os clientes solicitem anúncios de servidores de anúncios. Para isso, os usuários precisam se registrar no evento AdsManagerLoadedEvent e, em seguida, solicitar anúncios.
AdsManager
Fornece a API pública externa ao editor e se comunica com a instância interna do gerenciador de anúncios.
AdsManagerLoadedEvent
Este evento é gerado quando os anúncios são carregados nos servidores de anúncio do Google ou da DoubleClick por meio de um AdsLoader. Você pode se registrar nesse evento no AdsLoader.
AdsRenderingSettings
Define os parâmetros que controlam a renderização dos anúncios.
AdsRequest (em inglês)
Uma classe para especificar propriedades da solicitação de anúncio.
Anúncio complementar
Representa um anúncio complementar.
CompanionAdSelectionSettings
O objeto CompanionAdSelectionSettings é usado para definir os critérios de seleção ao chamar a função ima.Ad.getCompanionAds.
Configurações do ImaSdk
Esta classe contém configurações de SDK.
UniversalAdIdInfo
Esse objeto expõe informações sobre o ID do anúncio universal associado à peça criativa, incluindo o valor e o registro do ID do anúncio.
Enumerações
OmidAccessMode
string
Modos de acesso disponíveis para OMID para Web, que controlam quanto o script de verificação pode acessar.
Valor |
|
|---|---|
|
LIMITADA |
O script de verificação foi colocado no sandbox e não poderá acessar a página da peça criativa nem do editor. Além disso, ele não poderá confirmar diretamente em qual domínio de editor ele está. |
|
DOMAIN |
O script de verificação foi colocado no sandbox e não poderá acessar a página do criativo ou do editor. No entanto, o script é carregado de modo que possa confirmar diretamente em qual domínio de editor está. |
|
FULL |
O script de verificação tem acesso direto ao criativo e à página do editor. |
OmidVerificationVendor
number
Identifica um fornecedor de verificação OMID. Os fornecedores são listados em ordem alfabética.
Valor |
|
|---|---|
|
PONTUAÇÃO |
|
|
VERIFICAÇÃO DUPLA |
|
|
|
|
|
INTEGRAL_AD_SCIENCE |
|
|
MEETRICOS |
|
|
MOAT |
|
|
NIELSEN |
|
|
PIXAR |
|
|
OUTROS |
O fornecedor padrão a ser usado quando o URL do script não corresponder a outro fornecedor. |
Elementos do Ui
string
Enum que especifica diferentes elementos da IU que podem ser configurados para serem exibidos ou ocultos. Essas configurações podem ser ignoradas para anúncios do Google AdSense e do ADX.
Valor |
|
|---|---|
|
AD_ATTRIBUTION |
Exibe o texto "Anúncio" na IU do anúncio. Precisa estar presente para mostrar o timer de contagem regressiva. |
|
COUNTDOWN |
A atribuição de anúncios é necessária para que um timer de contagem regressiva seja exibido. Tanto |
Modo de visualização
string
Enum que especifica diferentes modos de visualização de VPAID para anúncios.
Valor |
|
|---|---|
|
NORMAL |
Modo de visualização normal do anúncio. |
|
TELA CHEIA |
Modo de visualização do anúncio em tela cheia. Indica ao gerenciador de anúncios que o editor considera a disposição atual do AdDisplayContainer como tela cheia (por exemplo, simulação de tela cheia). Isso não faz com que o gerenciador de anúncios entre em tela cheia. |
- Descontinuado
Propriedades
OmidAccessMode
string
Modos de acesso disponíveis para OMID para Web, que controlam quanto o script de verificação pode acessar.
Valor |
|
|---|---|
|
LIMITADA |
O script de verificação foi colocado no sandbox e não poderá acessar a página da peça criativa nem do editor. Além disso, ele não poderá confirmar diretamente em qual domínio de editor ele está. |
|
DOMAIN |
O script de verificação foi colocado no sandbox e não poderá acessar a página do criativo ou do editor. No entanto, o script é carregado de modo que possa confirmar diretamente em qual domínio de editor está. |
|
FULL |
O script de verificação tem acesso direto ao criativo e à página do editor. |
OmidVerificationVendor
number
Identifica um fornecedor de verificação OMID. Os fornecedores são listados em ordem alfabética.
Valor |
|
|---|---|
|
PONTUAÇÃO |
|
|
VERIFICAÇÃO DUPLA |
|
|
|
|
|
INTEGRAL_AD_SCIENCE |
|
|
MEETRICOS |
|
|
MOAT |
|
|
NIELSEN |
|
|
PIXAR |
|
|
OUTROS |
O fornecedor padrão a ser usado quando o URL do script não corresponder a outro fornecedor. |
Elementos do Ui
string
Enum que especifica diferentes elementos da IU que podem ser configurados para serem exibidos ou ocultos. Essas configurações podem ser ignoradas para anúncios do Google AdSense e do ADX.
Valor |
|
|---|---|
|
AD_ATTRIBUTION |
Exibe o texto "Anúncio" na IU do anúncio. Precisa estar presente para mostrar o timer de contagem regressiva. |
|
COUNTDOWN |
A atribuição de anúncios é necessária para que um timer de contagem regressiva seja exibido. Tanto |
Modo de visualização
string
Enum que especifica diferentes modos de visualização de VPAID para anúncios.
Valor |
|
|---|---|
|
NORMAL |
Modo de visualização normal do anúncio. |
|
TELA CHEIA |
Modo de visualização do anúncio em tela cheia. Indica ao gerenciador de anúncios que o editor considera a disposição atual do AdDisplayContainer como tela cheia (por exemplo, simulação de tela cheia). Isso não faz com que o gerenciador de anúncios entre em tela cheia. |
- Descontinuado
configurações
ImaSdkSettings não nulas
A instância global de configurações do singleton.