Reprodução de anúncios de áudio em segundo plano

Este guia é destinado a editores interessados em carregar anúncios em áudio nos apps Android.

Importante :não recomendamos a reprodução de anúncios em vídeo no modo de segundo plano.

Pré-requisitos

• SDK do IMA para Android v. 3.16.1 ou mais recente.

Recomendamos que os editores consultem o Exemplo de player de áudio (link em inglês) no GitHub como ponto de partida caso não tenham um app de reprodução de áudio no momento. Este exemplo usa o ExoPlayer como player em primeiro plano. O restante deste guia descreve os recursos necessários para a reprodução de áudio em segundo plano de anúncios do IMA.

Importante :o exemplo básico (link em inglês) implementa a extensão Exoplayer-IMA, que processa a maior parte da configuração do SDK do IMA. Por isso, o exemplo básico não pode ser usado como ponto de partida para este guia.

Como adicionar a reprodução de anúncios em segundo plano ao seu app

Para que a reprodução de anúncios em áudio e música continue quando o app estiver no modo de segundo plano, você pode criar um componente Service que contenha um player de áudio personalizado e um carregador de anúncios.

Caso seu app tenha um MainActivity e um AudioPlayerService para reprodução de áudio, você pode modificar o arquivo AndroidManifest.xml, conforme mostrado abaixo.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="…">
  <uses-permission android:name="android.permission.INTERNET"/>
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
  <application … >
    <activity android:name=".MainActivity" android:exported="true">
      <intent-filter>
        <action android:name="android.intent.action.MAIN"/>
        <category android:name="android.intent.category.LAUNCHER"/>
      </intent-filter>
    </activity>
    <service android:name=".AudioPlayerService"
             android:exported="false"/>
  </application>
</manifest>

No serviço, você pode criar um player de áudio personalizado, que pode ser qualquer player de mídia, desde que ele também implemente a interface VideoAdPlayer para interagir com o SDK do IMA.

O SDK do IMA v. 3.16.1 adicionou uma nova função, createAudioAdDisplayContainer, para criar um contêiner especializado para um carregador de anúncios solicitar anúncios em áudio.

O snippet de código a seguir mostra um exemplo do AudioPlayerService para inicializar e fazer solicitações de anúncios em áudio.

import android.app.Service;

import com.google.ads.interactivemedia.v3.api.AdDisplayContainer;
import com.google.ads.interactivemedia.v3.api.AdsLoader;
import com.google.ads.interactivemedia.v3.api.AdsRequest;
import com.google.ads.interactivemedia.v3.api.CompanionAdSlot;
import com.google.ads.interactivemedia.v3.api.ImaSdkFactory;
import com.google.ads.interactivemedia.v3.api.ImaSdkSettings;
import com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer;

import com.google.common.collect.ImmutableList;

/** Plays music and ads even when the app enters background mode. */
public class AudioPlayerService extends Service {

  /**
   * A custom audio player that implements the `VideoAdPlayer` interface.
   */
  private VideoAdPlayer audioPlayer;

  /**
   * An object to create other SDK objects: `AdDisplayContainer`, `AdsLoader` and `AdRequest`.
   */
  private ImaSdkFactory sdkFactory;

  /**
   * An object to make ad requests that would return an `AdsManager`.
   */
  private AdsLoader adsLoader;

  /**
   * An optional list of ViewGroup for rendering companion banners.
   */
  private ImmutableList<CompanionAdSlot> companionAdSlots;

  /**
   * Creates an AdsLoader for requesting ads and handling ad events.
   */
  public void initializeAds() {
    sdkFactory = ImaSdkFactory.getInstance();
    ImaSdkSettings imaSdkSettings = ImaSdkFactory.getInstance().createImaSdkSettings();
    AdDisplayContainer container = ImaSdkFactory.createAudioAdDisplayContainer(this, audioPlayer);
    if (companionAdSlots != null) {
      container.setCompanionSlots(companionAdSlots);
    }
    adsLoader = sdkFactory.createAdsLoader(this, imaSdkSettings, container);

    // Adds event handling logic for ads.
    // For more details, see
    // https://developers.google.com/interactive-media-ads/docs/sdks/android#create-an-adsloader
    adsLoader.addAdsLoadedListener(…);
    adsLoader.addAdErrorListener(…);
  }

  /**
   * Adds a companion ad slot. This slot is not required but can be set in ads initialization.
   *
   * @param companionAdSlot UI container for rendering companion banners.
   */
  public void addCompanionAdSlot(CompanionAdSlot companionAdSlot) {
    this.companionAdSlots = ImmutableList.of(companionAdSlot);
  }

  /**
   * Makes an audio ad request.
   *
   * @param adTagUrl Url to download an ad tag.
   */
  public void requestAd(String adTagUrl) {
    AdsRequest request = sdkFactory.createAdsRequest();
    request.setAdTagUrl(adTagUrl);
    adsLoader.requestAds(request);
  }
  ...
}

Uso de anúncios com espaços de anúncios complementares

Você pode inicializar anúncios com ou sem espaços de anúncios complementares. Se você optar por renderizar anúncios complementares, precisará fornecer acesso de AudioPlayerService à classe MainActivity usando um vinculador de serviço, conforme mostrado abaixo:

import android.app.Service;
import android.content.Intent;
import android.os.Binder;
import android.os.IBinder;

import androidx.annotation.Nullable;
...
/** Plays music and ads even when the app enters background mode. */
public class AudioPlayerService extends Service {
  ...
  @Nullable
  @Override
  public IBinder onBind(Intent intent) {
    return new ServiceBinder(this);
  }

  /**
   * Provides access to the `AudioPlayerService` instance after binding.
   */
  public class ServiceBinder extends Binder {
    private final AudioPlayerService boundService;

    /**
     * @param service The bound instance of the service
     */
    public ServiceBinder(AudioPlayerService service) {
      boundService = service;
    }

    public AudioPlayerService getBoundService() {
      return boundService;
    }
  }
}

É possível chamar a função addCompanionAdSlot() e transmitir um contêiner da interface para renderizar anúncios de banner complementar à medida que você inicializa anúncios da classe MainActivity.

import android.app.Activity;
import android.content.ComponentName;
import android.content.Context;
import android.content.ServiceConnection;
import android.os.Bundle;
import android.os.IBinder;
import android.view.ViewGroup;

import com.google.ads.interactivemedia.v3.api.CompanionAdSlot;
import com.google.ads.interactivemedia.v3.api.ImaSdkFactory;

public class MainActivity extends Activity {

  private AudioPlayerService boundService;
  private ServiceConnection connection;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.main_activity);

    ImaSdkFactory sdkFactory = ImaSdkFactory.getInstance();

    ViewGroup companionView = findViewById(R.id.companionAdSlotFrame);
    final CompanionAdSlot companionAdSlot = sdkFactory.createCompanionAdSlot();
    companionAdSlot.setContainer(companionView);
    companionAdSlot.setSize(640, 640);

    connection =
        new ServiceConnection() {
          @Override
          public void onServiceConnected(ComponentName name, IBinder binder) {
            boundService = ((AudioPlayerService.ServiceBinder) binder).getBoundService();
            boundService.addCompanionAdSlot(companionAdSlot);
            boundService.initializeAds();
          }
          ...
        };
    ...
    bindService(intent, connection, Context.BIND_AUTO_CREATE);
  }
  ...
}

Você pode comparar sua implementação com o Exemplo de player de áudio (link em inglês) se tiver problemas. Para mais informações sobre a reprodução de anúncios em áudio em segundo plano, entre em contato com o fórum do SDK do IMA para receber suporte.