Ativar criativos VPAID 2 JavaScript

O SDK HTML5 do IMA é compatível com criativos JavaScript VPAID 2. Ao ativar a compatibilidade, há duas diferenças principais entre a especificação VPAID 2 e a maneira como o SDK do IMA oferece suporte ao VPAID 2. Essas diferenças não afetam o player nem o código de implementação do SDK, mas são importantes para os autores de criativos JavaScript VPAID 2, já que os criativos podem gerar erros ou não funcionar como esperado quando renderizados pelo SDK HTML5 do IMA.

Pré-requisitos

Para acompanhar este guia, comece com um app que tenha o seguinte:

  • Player de vídeo HTML5 com o SDK HTML5 do IMA integrado. Se você não tiver uma, confira Configurar o SDK do IMA.
  • Um URL de tag de anúncio VAST que aponta para um criativo JavaScript VPAID 2.

Materiais de referência úteis

Ativar a compatibilidade com VPAID 2

Para ativar o suporte a JavaScript VPAID 2, chame o seguinte método antes de inicializar seu AdDisplayContainer:

google.ima.settings.setVpaidMode(google.ima.ImaSdkSettings.VpaidMode.ENABLED);
...
var adDisplayContainer = new google.ima.AdDisplayContainer(adContainerElement);
var adsLoader = new google.ima.AdsLoader(adDisplayContainer);
...

Os modos de VPAID disponíveis são os seguintes:

  • ENABLED - Permite anúncios VPAID com as configurações padrão.
  • INSECURE - Permite anúncios VPAID no modo não seguro. Para mais informações, consulte Segurança de iframe e Elemento proxy do player de vídeo.
  • DISABLED - Os anúncios VPAID não são veiculados. Se um anúncio solicitado retornar um criativo VPAID, um erro será gerado.

Para mais informações sobre os modos VPAID, consulte a documentação da API para ImaSdkSettings.VpaidMode.

Observações sobre a compatibilidade com VPAID 2

Segurança do iframe

Por padrão, o SDK do IMA usa um iframe seguro em vez de um iframe compatível (mesmo domínio) ou um script na página para renderizar criativos JavaScript VPAID 2. Isso significa que, se um criativo esperar acessar o DOM da página mãe, ele poderá causar um erro. Para renderizar seu anúncio em um iframe compatível, use ImaSdkSettings.setVpaidMode(...) da seguinte forma:

adsLoader.getSettings().setVpaidMode(google.ima.ImaSdkSettings.VpaidMode.INSECURE);

Elemento proxy do player de vídeo

Para segurança e funcionalidade móvel adequada, no modo ENABLED, o SDK do IMA HTML5 não fornece o elemento de vídeo real ao anúncio. Em vez disso, ele fornece um elemento proxy que imita grande parte da funcionalidade do elemento de vídeo normal. Para criativos de anúncio que chamam apenas métodos de API compatíveis, não deve haver mudanças no comportamento da renderização dos criativos. No modo VpaidMode.INSECURE, o SDK fornece o elemento do player de vídeo em vez do proxy.

Confira os métodos, listeners e atributos disponíveis no elemento proxy de vídeo:

Métodos

  • addEventListener
  • canPlayType
  • load
  • play
  • pause
  • setattribute

Tipos de eventos para addEventListener

  • abort
  • canplay
  • canplaythrough
  • click
  • durationchange
  • emptied
  • ended
  • error
  • loadeddata
  • loadedmetadata
  • loadstart
  • pause
  • play
  • playing
  • progress
  • ratechange
  • suspend
  • seeked
  • seeking
  • timeupdate
  • waiting

Atributos

  • currentTime
  • duration
  • ended
  • paused
  • playbackRate
  • src
  • type

Perguntas frequentes

Os criativos JavaScript VPAID 2 são compatíveis com os SDKs para iOS ou Android?
O SDK HTML5 do IMA é a única plataforma do SDK do IMA que oferece suporte a criativos JavaScript VPAID 2.
Isso ativa os criativos VPAID no SDK HTML5 do IMA?
Sim, o SDK HTML5 do IMA é compatível com criativos JavaScript VPAID 2.