Solicitar anúncios em conteúdo somente de áudio

O SDK HTML5 do IMA é compatível com anúncios em áudio com uma configuração semelhante à dos anúncios em vídeo, mas com algumas diferenças importantes. Para qualquer parte da configuração da IMA não abordada neste guia, consulte o Guia para iniciantes em HTML5.

Uso de uma tag <audio> para reprodução de conteúdo

O construtor de AdDisplayContainer usa um segundo argumento chamado videoElement, que a IMA rastreia como o player de conteúdo. Esse argumento aceita uma tag <video> ou <audio>. Para conteúdo e anúncios de áudio, este guia recomenda usar uma tag <audio> para criar um AdDisplayContainer. Se você tiver conteúdo de vídeo, use uma tag <video> para mostrar uma combinação de anúncios em áudio e vídeo:

index.html

<audio id="audio-player"></audio>
<div class="ad-container"></div>

ads.js

audioPlayer = document.getElementById('audio-player');
adContainer = document.getElementById('ad-container');
adDisplayContainer = new google.ima.AdDisplayContainer(adContainer,
audioPlayer);

Ocultar o AdDisplayContainer

O SDK HTML5 do IMA ainda exige um AdDisplayContainer, mesmo que não haja uma parte de exibição nos anúncios ou no conteúdo. Por isso, recomendamos ocultar o AdDisplayContainer. Confira um exemplo de como ocultar o elemento:

style.css

.ad-container {
  display: none;
}

Controles personalizados

Como o AdDisplayContainer fica oculto, são necessários controles personalizados para lidar com a reprodução durante os intervalos comerciais. O AdsManager tem métodos que podem ser usados para implementar esses controles personalizados:

Processar anúncios puláveis

Como não há um AdDisplayContainer visível, o SDK do IMA não pode mostrar um botão Pular anúncio. Para processar anúncios puláveis, implemente os seguintes métodos da IMA:

O exemplo de código a seguir mostra como fazer isso.

ads.js

É possível configurar uma função updateSkippable para determinar se e quando um anúncio pode ser pulado. Essa função precisa ser chamada em cada evento AD_PROGRESS da IMA. Consulte o Guia de primeiros passos para saber como configurar listeners para eventos da IMA.

function onAdsManagerLoaded(adsManagerLoadedEvent) {
  adsManager = adsManagerLoadedEvent.getAdsManager(
    audioPlayer);

  ...

  adsManager.addEventListener(
    google.ima.AdEvent.Type.AD_PROGRESS,
    onAdEvent);

  ...

}

function onAdEvent(adEvent) {
  const ad = adEvent.getAd();
  if (ad) {
    currentAd = ad; // currentAd is defined outside of this functions scope.
  }
  switch (adEvent.type) {

    ...

    case google.ima.AdEvent.Type.AD_PROGRESS:
      // See https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.AdProgressData
      const adProgressData = adEvent.getAdData();

      updateSkippable(
        adProgressData.currentTime,
        currentAd.getSkipTimeOffset()
      );
      break;
    ...

  }
}

/**
   * Called when there may be a change in the skippable state.
   * @param {number} currentTime The current time of the
   * currently playing ad.
   * @param {number} skipTimeOffset The number of seconds of playback
   * before the ad becomes skippable. -1 is returned for non skippable
   * ads or if this is unavailable.
   */
  updateSkippable(currentTime, skipTimeOffset) {
    const isAdSkippable = skipTimeOffset !== -1;
    const isSkipCurrentlyAllowed = adsManager.getAdSkippableState();
    const timeTillSkipInSeconds = Math.ceil(skipTimeOffset - currentTime);
    updateSkipUI(
        isAdSkippable, isSkipCurrentlyAllowed, timeTillSkipInSeconds);
  }

Ao contrário dos anúncios em vídeo, a IMA não pode fornecer um botão para pular anúncios de áudio. Os desenvolvedores precisam adicionar uma interface personalizada para anúncios puláveis, o que pode ser feito com uma tag <button> simples. Essa função updateSkipUI atualiza o botão "Pular" com base em se o anúncio é pulável, se ele está pulável no momento e quanto tempo falta para que ele possa ser pulado. Ele usa a classe '.hidden', que não é fornecida pela IMA. A classe .hidden adiciona display: none; ao <button>.

/**
 * Updates the skip button UI.
 * @param {boolean} isAdSkippable if the current ad is a skippable ad.
 * @param {boolean} isSkipCurrentlyAllowed if the ad can be skipped now.
 * @param {number} timeTillSkipInSeconds time until the ad can be skipped in
 * seconds.
 */
updateSkipUI(isAdSkippable, isSkipCurrentlyAllowed, timeTillSkipInSeconds) {
  if (isAdSkippable) {
    skipButton.classList.remove('hidden');
    if (isSkipCurrentlyAllowed) {
      skipButton.textContent = 'Skip ad';
      skipButton.disabled = false;
    } else {
      skipButton.textContent = `Skip in ${timeTillSkipInSeconds} seconds`;
      skipButton.disabled = true;
    }
  } else {
    skipButton.classList.add('hidden');
  }
}

Por fim, defina um listener para cliques do usuário no botão de pular personalizado. Para pular anúncios, chame a função adsManager.skip().

skipButton.addEventListener('click', () => {
  adsManager.skip();
});

Estas são as principais mudanças necessárias para configurar o SDK do IMA com anúncios de áudio. Para receber ajuda com problemas de implementação, entre em contato pela Central de Ajuda do Ad Manager.