google. ima. AdDisplayContainer
Esta classe representa um contêiner para a exibição de anúncios. O SDK criará estruturas automaticamente 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. Recomendamos 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 mais detalhes sobre as 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 toque.
Construtor
Contêiner do AdDisplay
novo AdDisplayContainer(containerElement, videoElement, clickTrackingElement)
Parâmetro |
|
---|---|
Elementodocontêiner |
O elemento no qual os anúncios serão exibidos. O elemento precisa ser inserido no DOM antes de criar o AdDisplayContainer. O valor não pode ser nulo. |
videoElement |
Opcional Especifica o elemento de reprodução do anúncio em vídeo alternativo. Recomendamos sempre transmitir o player de vídeo do conteúdo. O valor não pode ser nulo. |
Elemento de acompanhamento de cliques |
Opcional Especifica o elemento de clique do anúncio de vídeo alternativo. Deixe este valor nulo para permitir que o SDK processe os cliques. Mesmo que seja fornecido, o SDK usará o elemento de rastreamento de cliques personalizado somente quando os criativos não Google AdSense/AdX forem exibidos em ambientes que não oferecem suporte a elementos da IU sobrepostos a um player de vídeo (por exemplo, iPhone ou Android anteriores à versão 4.0). O elemento de rastreamento de cliques personalizado nunca deve ser renderizado no player de vídeo porque pode interceptar cliques em elementos da IU renderizados pelo SDK. Além disso, o SDK não modificará a visibilidade do elemento de rastreamento de cliques personalizado. Isso significa que, se um elemento de rastreamento de cliques personalizado for fornecido, ele precisará ser exibido corretamente quando o anúncio linear for reproduzido. Você poderá verificar ima.StorageClass.isCustomClickTrackingUsed quando o evento ima.AdEvent.Type.STARTED for disparado para determinar se o elemento de rastreamento de cliques personalizado será exibido ou não. Se apropriado para a IU, você deve ocultar o elemento de rastreamento de cliques quando o evento ima.AdEvent.Type.CONTENT_RESUME_REQUESTED é disparado. O valor não pode ser nulo. |
Métodos
destruir
destroy()
Destrói o estado interno e os elementos DOM criados anteriormente. O SDK do IMA será descarregado e nenhuma outra chamada a APIs será feita.
initialize
inicialize()
Inicializa os elementos de vídeo internos para reprodução. Esse método precisa ser chamado como resultado direto de uma ação do usuário, para que o navegador possa marcar o elemento de vídeo como iniciado pelo usuário.
Alguns navegadores vão permitir a reprodução de vídeos sem interações do usuário se o
som do vídeo for desativado. Para esse comportamento, use AdsRequest.setAdWillPlayMuted(true)
e chame esse método antes de AdsManager.start()
.