Configurer des annonces interstitielles

Sélectionnez une plate-forme : Android iOS Unity Flutter Android (Legacy)

Les annonces interstitielles sont des annonces en plein écran qui couvrent l'interface de l'application. Vous les diffusez à des moments de transition naturels dans votre application, par exemple entre deux activités ou pendant les pauses entre les niveaux d'un jeu.

Lorsqu'une annonce interstitielle s'affiche dans votre application, les utilisateurs peuvent appuyer dessus et continuer, ou la fermer et revenir à l'application. Consultez cette étude de cas.

Ce guide explique comment intégrer des annonces interstitielles dans une application Android.

Avant de commencer

Avant de continuer, procédez comme suit :

  • Configurer GMA Next-Gen SDK.
  • Utilisez l'ID de bloc d'annonces interstitielles test ca-app-pub-3940256099942544/1033173712.
    • Lorsque vous créez et testez votre application, assurez-vous d'utiliser des annonces tests plutôt que des annonces de production. Si vous n'utilisez pas l'ID de bloc d'annonces test, Google peut suspendre votre compte.
    • Avant de publier votre application, remplacez cet ID par l'ID de votre bloc d'annonces.
    • Pour en savoir plus sur les annonces tests GMA Next-Gen SDK, consultez Activer les annonces tests.

Comprendre le préchargement des annonces (bêta)

Le préchargement des annonces dans GMA Next-Gen SDK automatise le chargement et la mise en cache des annonces.

Le préchargement des annonces présente les avantages suivants :

  • Gestion des références : conserve les références jusqu'à ce que les annonces soient diffusées.
  • Rechargement automatique : charge une nouvelle annonce lorsqu'une annonce est récupérée à partir du cache.
  • Nouvelles tentatives gérées : charge une nouvelle annonce lorsqu'une annonce ne parvient pas à se charger.
  • Gestion de l'expiration : actualise les annonces avant qu'elles n'expirent.
  • Optimisation du cache : optimise l'ordre du cache pour diffuser l'annonce la plus prioritaire.

Démarrer le préchargement des annonces

Pour commencer à précharger des annonces, appelez la méthode start une seule fois lorsque vous initialisez GMA Next-Gen SDK. Une fois que vous avez appelé la start méthode, GMA Next-Gen SDK précharge automatiquement les annonces et retente les requêtes ayant échoué pour les configurations préchargées.

L'exemple suivant montre comment commencer à précharger des annonces :

Kotlin

private fun startPreloading(adUnitId: String) {
  // Call start() once after SDK initialization.
  // Preload only one ad unit per format to optimize performance.
  val adRequest = AdRequest.Builder(adUnitId).build()
  val preloadConfig = PreloadConfiguration(adRequest)
  InterstitialAdPreloader.start(adUnitId, preloadConfig)
}

Java

private void startPreloading(String adUnitId) {
  // Call start() once after SDK initialization.
  // Preload only one ad unit per format to optimize performance.
  AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
  PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
  InterstitialAdPreloader.start(adUnitId, preloadConfig);
}

Remplacez AD_UNIT_ID par l'ID de votre bloc d'annonces.

L'exemple précédent montre comment utiliser l'ID du bloc d'annonces comme ID de préchargement. Un ID de préchargement est un identifiant de chaîne que vous créez pour identifier une configuration de préchargement des annonces. Si votre application nécessite plusieurs configurations de ciblage pour le même ID de bloc d'annonces, transmettez un identifiant de chaîne personnalisé.

Le préchargement des annonces n'est pas compatible avec la modification des paramètres de ciblage ni des demandes d'annonces. Si vous devez modifier les paramètres de ciblage entre les requêtes, utilisez le chargement unique.

Obtenir et afficher l'annonce préchargée

Avant de diffuser l'annonce, appelez la méthode pollAd. Ne stockez pas l'objet d'annonce préchargé. Lorsque vous appelez la pollAd méthode, GMA Next-Gen SDK récupère une annonce disponible et précharge automatiquement l'annonce suivante en arrière-plan. Si aucune annonce n'est disponible, GMA Next-Gen SDK n'en renvoie aucune.

Lorsque vous disposez d'un objet d'annonce disponible, appelez la méthode show pour diffuser l'annonce. L'exemple suivant montre comment récupérer et diffuser une annonce préchargée :

Kotlin

private fun pollAndShowAd(activity: Activity, adUnitId: String) {
  // Polling returns the next available ad and loads another ad in the background.
  val ad = InterstitialAdPreloader.pollAd(adUnitId)
  if (ad == null) {
    Log.e(TAG, "Interstitial ad is not available.")
    return
  }

  // Interact with the ad object as needed.
  Log.d(TAG, "Interstitial ad response info: ${ad.getResponseInfo()}")
  ad.adEventCallback =
    object : InterstitialAdEventCallback {
      override fun onAdImpression() {
        Log.d(TAG, "Interstitial ad recorded an impression.")
      }
    }
  ad.show(activity)
}

Java

private void pollAndShowAd(Activity activity, String adUnitId) {
  // Polling returns the next available ad and loads another ad in the background.
  final InterstitialAd ad = InterstitialAdPreloader.pollAd(adUnitId);

  // Interact with the ad object as needed.
  if (ad == null) {
    Log.e(TAG, "Interstitial ad is not available.");
    return;
  }

  Log.d(TAG, "Interstitial ad response info: " + ad.getResponseInfo());
  ad.setAdEventCallback(
      new InterstitialAdEventCallback() {
        @Override
        public void onAdImpression() {
          Log.d(TAG, "Interstitial ad recorded an impression.");
        }
      });

  // Show the ad.
  ad.show(activity);
}

Lorsque votre application atteint un emplacement d'annonce et peut appeler la méthode show, appelez la méthode pollAd. N'appelez pas la méthode pollAd dans les rappels de préchargement ni après avoir vérifié la méthode isAdAvailable pour conserver une annonce. Si vous devez inspecter les métadonnées de l'annonce avant de la diffuser, lisez les informations de réponse sans supprimer l'annonce du cache.

Écouter les événements d'annonce

Avant de diffuser l'annonce, écoutez les événements d'annonce. L'exemple suivant enregistre les rappels pour les événements d'annonce :

Kotlin

// Listen for ad events.
val ad = interstitialAd
if (ad == null) {
  Log.e(TAG, "Interstitial ad is not ready yet.")
  return
}

ad.adEventCallback =
  object : InterstitialAdEventCallback {
    override fun onAdShowedFullScreenContent() {
      // Interstitial ad did show.
    }

    override fun onAdDismissedFullScreenContent() {
      // Interstitial ad did dismiss.
      interstitialAd = null
    }

    override fun onAdFailedToShowFullScreenContent(
      fullScreenContentError: FullScreenContentError
    ) {
      // Interstitial ad failed to show.
      Log.e(TAG, "Interstitial ad failed to show: ${fullScreenContentError.message}")
    }

    override fun onAdImpression() {
      // Interstitial ad did record an impression.
    }

    override fun onAdClicked() {
      // Interstitial ad did record a click.
    }
  }

Java

// Listen for ad events.
if (interstitialAd == null) {
  Log.e(TAG, "Interstitial ad is not ready yet.");
  return;
}

interstitialAd.setAdEventCallback(
    new InterstitialAdEventCallback() {
      @Override
      public void onAdShowedFullScreenContent() {
        // Interstitial ad did show.
      }

      @Override
      public void onAdDismissedFullScreenContent() {
        // Interstitial ad did dismiss.
        interstitialAd = null;
      }

      @Override
      public void onAdFailedToShowFullScreenContent(
          @NonNull FullScreenContentError fullScreenContentError) {
        // Interstitial ad failed to show.
        Log.e(TAG, "Interstitial ad failed to show: " + fullScreenContentError.getMessage());
      }

      @Override
      public void onAdImpression() {
        // Interstitial ad did record an impression.
      }

      @Override
      public void onAdClicked() {
        // Interstitial ad did record a click.
      }
    });

Facultatif : Écouter les événements de préchargement

Lorsque vous commencez à précharger des annonces, enregistrez-vous pour les événements de préchargement afin d'être averti lorsque les annonces sont préchargées, ne parviennent pas à être préchargées ou lorsque le cache d'annonces est épuisé.

L'exemple suivant montre comment s'enregistrer pour les événements de préchargement d'annonces :

Kotlin

val preloadCallback =
  // [Important] Don't call ad preloader start() or pollAd() within the PreloadCallback.
  object : PreloadCallback {
    override fun onAdFailedToPreload(preloadId: String, adError: LoadAdError) {
      Log.d(
        TAG,
        ("Interstitial preload ad $preloadId failed to load with error: ${adError.message}"),
      )
    }

    override fun onAdsExhausted(preloadId: String) {
      Log.i(TAG, "Interstitial preload ad $preloadId is not available")
      // [Important] Don't call ad preloader start() or pollAd() from onAdsExhausted.
    }

    override fun onAdPreloaded(preloadId: String, responseInfo: ResponseInfo) {
      Log.i(TAG, "Interstitial preload ad $preloadId is available")
    }
  }
val adRequest = AdRequest.Builder(adUnitId).build()
val preloadConfig = PreloadConfiguration(adRequest)
InterstitialAdPreloader.start(adUnitId, preloadConfig, preloadCallback)

Java

PreloadCallback preloadCallback =
    // [Important] Don't call ad preloader start() or pollAd() within the PreloadCallback.
    new PreloadCallback() {
      @Override
      public void onAdFailedToPreload(@NonNull String preloadId, @NonNull LoadAdError adError) {
        Log.d(
            TAG,
            String.format(
                "Interstitial preload ad %s failed to load with error: %s",
                preloadId, adError.getMessage()));
        // [Optional] Get the error response info for additional details.
        // ResponseInfo responseInfo = adError.getResponseInfo();
      }

      @Override
      public void onAdsExhausted(@NonNull String preloadId) {
        Log.i(TAG, "Interstitial preload ad " + preloadId + " is not available");
        // [Important] Don't call ad preloader start() or pollAd() from onAdsExhausted.
      }

      @Override
      public void onAdPreloaded(@NonNull String preloadId, @NonNull ResponseInfo responseInfo) {
        Log.i(TAG, "Interstitial preload ad " + preloadId + " is available");
      }
    };

AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
InterstitialAdPreloader.start(adUnitId, preloadConfig, preloadCallback);

Lorsqu'une annonce ne parvient pas à se charger, GMA Next-Gen SDK précharge automatiquement les annonces et retente les requêtes ayant échoué pour les configurations préchargées. N'appelez pas de requêtes de chargement manuel dans les rappels d'échec. Dans les méthodes de rappel d'événements de préchargement, n'appelez pas les méthodes pollAd, destroy ni start. L'appel de ces méthodes dans les rappels peut entraîner des boucles de chargement récursives.

Facultatif : Vérifier la disponibilité des annonces

Si vous devez savoir si une annonce est disponible, vérifiez sa disponibilité. L'exemple suivant vérifie si une annonce préchargée est disponible :

Kotlin

private fun isAdAvailable(adUnitId: String): Boolean {
  return InterstitialAdPreloader.isAdAvailable(adUnitId)
}

Java

private boolean isAdAvailable(String adUnitId) {
  return InterstitialAdPreloader.isAdAvailable(adUnitId);
}

Facultatif : Définir la taille de la mémoire tampon

La taille de la mémoire tampon contrôle le nombre d'annonces préchargées conservées en mémoire. Par défaut, Google optimise la taille de la mémoire tampon pour équilibrer la consommation de mémoire et la latence de diffusion des annonces. Vous pouvez définir une taille de mémoire tampon personnalisée pour augmenter ou diminuer le nombre d'annonces conservées en mémoire. Nous vous recommandons une taille de la mémoire tampon de deux annonces préchargées. Si la majeure partie de votre trafic provient d'appareils à faible mémoire, réduisez la taille de la mémoire tampon.

L'exemple suivant montre comment définir une taille de mémoire tampon :

Kotlin

private fun setBufferSize(adUnitId: String) {
  val adRequest = AdRequest.Builder(adUnitId).build()
  // Define a PreloadConfiguration and set the buffer size to 2 preloaded ads.
  val preloadConfig = PreloadConfiguration(adRequest, bufferSize = 2)
  InterstitialAdPreloader.start(adUnitId, preloadConfig)
}

Java

private void setBufferSize(String adUnitId) {
  AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
  // Define a PreloadConfiguration and set the buffer size to 2 preloaded ads.
  PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest, 2);
  InterstitialAdPreloader.start(adUnitId, preloadConfig);
}

Limites du cache de préchargement

GMA Next-Gen SDK applique une limite à l'échelle de l'application sur le nombre total d'annonces préchargées pour tous les blocs d'annonces et tous les ID de préchargement :

  • Limite par défaut : Google conserve un maximum de six annonces préchargées en mémoire. Cette limite est partagée entre tous les formats et tous les ID de préchargement.
  • Nous vous recommandons de conserver une taille de mémoire tampon de deux pour chaque ID de préchargement.

Facultatif : Arrêter le préchargement des annonces

Maintenez le préchargement actif pendant que votre application diffuse des annonces. Pendant ce temps, n'utilisez pas la méthode destroy. Si vous n'avez plus besoin de diffuser d'annonces pour un ID de préchargement spécifique dans la session, vous pouvez arrêter le préchargement des annonces. Pour arrêter le chargement d'annonces pour un ID de préchargement spécifique, appelez la méthode destroy avec un ID de préchargement. L'appel de la méthode destroy supprime du cache toutes les annonces préchargées associées à l'ID de préchargement.

L'exemple suivant montre comment arrêter le préchargement des annonces :

Kotlin

private fun stopPreloading(adUnitId: String) {
  // Stops the preloading and destroy preloaded ads.
  InterstitialAdPreloader.destroy(adUnitId)
}

Java

private void stopPreloading(String adUnitId) {
  // Stops the preloading and destroy preloaded ads.
  InterstitialAdPreloader.destroy(adUnitId);
}

Facultatif : Lire les informations de réponse

Lisez les informations de réponse de la prochaine annonce préchargée sans supprimer l'annonce du cache. Si vous devez inspecter les métadonnées de l'annonce avant de la diffuser, lisez les informations de réponse au lieu d'appeler la méthode pollAd.

L'exemple suivant montre comment lire les informations de réponse de la prochaine annonce préchargée :

Kotlin

val responseInfo = InterstitialAdPreloader.peekAdResponseInfo(preloadId)
if (responseInfo == null) {
  Log.e(TAG, "Failed to peek ad response info.")
  return
}

Log.d(TAG, "Peeked ad response ID: ${responseInfo.responseId}")

Java

ResponseInfo responseInfo = InterstitialAdPreloader.peekAdResponseInfo(preloadId);
if (responseInfo == null) {
  Log.e(TAG, "Failed to peek ad response info.");
  return;
}

Log.d(TAG, "Peeked ad response ID: " + responseInfo.getResponseId());