Lecture d'annonces audio en arrière-plan

Ce guide est destiné aux éditeurs qui souhaitent charger des annonces audio dans leurs applications Android.

Important : Nous vous déconseillons de diffuser des annonces vidéo en arrière-plan.

Prérequis

• SDK Android IMA 3.16.1 ou version ultérieure

Si vous ne disposez pas actuellement d'application de lecteur audio, nous vous recommandons de commencer par l'exemple de lecteur audio sur GitHub. Cet exemple utilise ExoPlayer comme lecteur de premier plan. Le reste de ce guide décrit les fonctionnalités nécessaires pour la lecture audio en arrière-plan des annonces IMA.

Important :L'exemple de base implémente l'extension Exoplayer-IMA qui gère la majorité de la configuration du SDK IMA. Pour cette raison, l'exemple de base ne peut pas être utilisé comme point de départ de ce guide.

Activer la lecture des annonces en arrière-plan dans votre application

Pour que la lecture de musique et d'annonces audio se poursuive lorsque l'application est en mode arrière-plan, vous pouvez créer un composant Service contenant un lecteur audio personnalisé et un chargeur d'annonces.

Si votre application comporte un MainActivity et un AudioPlayerService pour la lecture audio, vous pouvez modifier votre fichier AndroidManifest.xml comme indiqué ci-dessous :

<?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>

Dans le service, vous pouvez créer un lecteur audio personnalisé, qui peut être n'importe quel lecteur multimédia tant qu'il implémente également l'interface VideoAdPlayer pour interagir avec le SDK IMA.

Le SDK IMA version 3.16.1 a ajouté une nouvelle fonction, createAudioAdDisplayContainer, afin de créer un conteneur spécialisé pour qu'un chargeur d'annonces puisse demander des annonces audio.

L'extrait de code suivant présente un exemple de AudioPlayerService pour l'initialisation et l'envoi de demandes d'annonces audio.

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);
  }
  ...
}

Utilisation d'annonces avec des espaces publicitaires associés

Vous pouvez initialiser des annonces avec ou sans espaces publicitaires associés. Si vous choisissez d'afficher des annonces associées, vous devez fournir l'accès de AudioPlayerService à la classe MainActivity via un lien de service, comme indiqué ci-dessous:

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;
    }
  }
}

Vous pouvez appeler la fonction addCompanionAdSlot() et transmettre un conteneur d'interface utilisateur pour afficher les bannières associées lorsque vous initialisez les annonces à partir de la 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);
  }
  ...
}

En cas de problème, vous pouvez comparer votre implémentation à l'exemple de lecteur audio. Pour toute question supplémentaire sur la lecture d'annonces audio en arrière-plan, veuillez contacter l'assistance sur le forum du SDK IMA.