Implémentation native d'APR pour Android

Le SDK Google Mobile Ads accepte également les styles de recherche personnalisés. Si votre application utilise déjà le SDK Google Mobile Ads, nous vous recommandons d'utiliser plutôt la version du SDK AFSMA.

Si vous passez à la version 19.0.0 (ou à une version ultérieure) depuis la version 18.1.0 (ou une version antérieure), veuillez consulter notre guide de migration.

Prérequis

Dans ce guide d'implémentation, nous partons du principe que vous connaissez bien les éléments suivants:

Importer le SDK natif APR

Ajouter le SDK

Pour ajouter le SDK natif APR à votre application, procédez comme suit:

Ouvrez le fichier build.gradle dans le répertoire du module de votre application. Ajoutez une règle de compilation sous dependencies pour la dernière version du SDK:

dependencies {
  implementation 'com.google.android.gms:play-services-afs-native:19.0.3'
}

Assurez-vous que votre build.gradle de premier niveau contient une référence au dépôt google() ou à maven { url "https://maven.google.com" }.

Suivez ces instructions pour inclure le plug-in de mise en correspondance des versions autonomes de Google Play dans votre projet. L'application de ce plug-in génère une erreur de compilation Gradle lorsque le SDK natif AFS est utilisé avec une version incompatible des services Google Play au lieu d'autoriser la compilation de l'application, mais qui peut entraîner des plantages au moment de l'exécution. Vous pouvez également appliquer la stratégie failOnVersionConflict() ResolutionStrategy à votre projet pour provoquer une erreur de compilation lorsque des versions incompatibles des services Google Play sont utilisées dans votre projet. Enregistrez les modifications, puis cliquez sur Sync Project with Gradle Files (Synchroniser le projet avec les fichiers Gradle) dans la barre d'outils.

Utiliser AndroidX au lieu des bibliothèques Android Support

À partir de la version 17.0.0 du SDK, votre application doit utiliser les bibliothèques Jetpack (AndroidX) au lieu des bibliothèques Android Support. Configuration requise:

  • Définissez com.android.tools.build:gradle sur v3.2.1 ou une version ultérieure.
  • Définissez compileSdkVersion sur 28 ou une valeur ultérieure.
  • Mettez à jour votre application pour utiliser Jetpack (AndroidX). Suivez les instructions de la section Migrer vers AndroidX.

Classes

Pour diffuser des annonces natives APR dans votre application, ajoutez les classes suivantes:

SearchAdController

  • Cette classe est responsable des demandes d'annonces asynchrones, de la mise en cache et de la récupération des annonces, ainsi que de l'affichage des annonces.
  • Chaque contexte d'annonce nécessite un élément SearchAdController distinct. Par exemple, si vous avez un écran qui affiche des annonces à côté d'une liste de résultats de recherche et un autre qui affiche des annonces à côté des détails d'un produit spécifique, vous devez créer deux instances distinctes de SearchAdController, une pour chaque cas.
  • Vous devez fournir au constructeur votre code de propriété Web (référence éditeur), votre ID de style à appliquer aux annonces renvoyées et votre SearchAdOptions. Le Context fourni dans le constructeur doit être Activity, qui contient le SearchAdController et où vous placerez l'annonce View.
  • Appelez loadAds pour indiquer une recherche d'un nouvel utilisateur et lancer une demande d'annonce asynchrone. Toutes les annonces chargées à partir des appels précédents à loadAds sont effacées du cache publicitaire interne lors d'un nouvel appel.
  • Créez un View avec createAdView pour afficher des créations.
  • Une fois les annonces chargées, appelez populateAdView avec un View précédemment généré avec createAdView pour afficher une annonce mise en cache dans ce View. En plus du View à renseigner, fournissez un adKey, une chaîne arbitraire permettant d'identifier de manière unique l'annonce. Cela associe la création publicitaire spécifique renvoyée par le cache à ce adKey. Ainsi, lorsque le même adKey est transmis à un prochain appel de populateAdView, la même annonce est renvoyée. Par exemple, si populateAdView est appelé pour la première fois avec adKey="keyA" et affiche une annonce pour des chaussures de randonnée, chaque appel ultérieur à populateAdView avec adKey="keyA" générera la même annonce pour des chaussures de randonnée. Si vous appelez loadAds, toutes les annonces mises en cache et les clés d'annonce associées seront effacées.

SearchAdOptions

  • Transmettez cet objet au constructeur SearchAdController pour personnaliser la façon dont les annonces sont demandées et affichées. Appelez build() sur un SearchAdOptions.Builder pour créer un objet SearchAdOptions.

View

  • Créez un objet View pour stocker les annonces en appelant createAdView() sur SearchAdController. Affiche au maximum une annonce à la fois, mais le même View peut être recyclé pour afficher différentes annonces au fil du temps.

SearchAdRequest

  • Appelez la méthode loadAds sur SearchAdController avec un SearchAdRequest pour lancer une demande d'annonce asynchrone. Appelez build() sur un SearchAdRequest.Builder pour créer un objet SearchAdRequest.

AdListener

  • Implémentez cette interface et transmettez-la au constructeur SearchAdController afin d'enregistrer des rappels pour plusieurs états.
  • Remarque: Les rappels AdListener ne seront pas appelés lors d'une requête annulée (un appel à loadAds qui a été préempté par un autre appel à loadAds avant la résolution du premier appel).

Exemple d'implémentation

L'exemple ci-dessous illustre la création d'un SearchAdController dans un exemple de Activity.

//  MainActivity.java implementation
//  (MainActivity is a subclass of Activity)

SearchAdController adController;
// adContainer where we will place our ads in this example.
ViewGroup adContainer;

protected void onCreate(Bundle bundle){
  super.onCreate(bundle);
  adContainer = (ViewGroup) findViewById(...);
  // Specify ad options (not required).
  SearchAdOptions.Builder adOptionsBuilder = new SearchAdOptions.Builder();
  adOptionsBuilder.setAdType(SearchAdOptions.AD_TYPE_TEXT);
  adOptionsBuilder.setPrefetch(true);
  adOptionsBuilder.setNumAdsRequested(3);
  // Provide a callback to trigger when ads are loaded.
  AdListener adListener = new AdListener() {
    public void onAdLoaded() {
      createAndShowAd();
    }
  };
  // Instantiate the SearchAdController.
  adController = new SearchAdController(this, "your-client-id", "your-style-id",
                                        adOptionsBuilder.build(), adListener);
}

Lorsque l'utilisateur lance une requête, créez un SearchAdRequest et appelez loadAds sur l'SearchAdController pour lancer une demande d'annonce asynchrone.

// Create the request.
SearchAdRequest.Builder requestBuilder = new SearchAdRequest.Builder();
requestBuilder.setQuery("user query here");
// Load the ads.
adController.loadAds(requestBuilder.build());

Implémentez votre rappel onAdLoaded pour insérer une annonce chargée dans un visionnage d'annonce.

private void createAndShowAd() {
  // Create a new view that will contain the ad.
  View adView = adController.createAdView();
  // Attach the new view to the view hierarchy.
  adContainer.addView(adView);
  // Display the ad inside the adView. We need to provide an adKey to
  // indicate which ad is to be displayed in the adView. In this example, 
  // since we only have one ad, we can provide any constant string. However, 
  // if you intend to display multiple ads, each ad you wish to display
  // should be given a unique adKey of your choosing.
  adController.populateAdView(adView, "demoAd");
}

Une annonce en rapport avec la requête donnée s'affichera alors dans la adView.

Examiner les erreurs

SearchAdController nécessite un objet AdListener avec la méthode onAdLoaded() pour avertir votre application que les annonces sont prêtes à être diffusées. Vous devez également implémenter la méthode onAdFailedToLoad() afin de pouvoir détecter et corriger les erreurs. Par exemple, vous pouvez utiliser le AdListener suivant pour déboguer votre implémentation:

AdListener adListener = new AdListener() {
    public void onAdLoaded() {
        // Called when an ad is loaded.
        Toast.makeText(MainActivity.this, "Ad Loaded",
                Toast.LENGTH_SHORT).show();
        Log.d(MainActivity.class.getSimpleName(), "Ad Loaded");
    }

    public void onAdLeftApplication() {
        // Called when an ad leaves the application
        // (to go to the browser for example).
        Toast.makeText(MainActivity.this, "Ad Left Application",
                Toast.LENGTH_SHORT).show();
        Log.d(MainActivity.class.getSimpleName(), "Ad Left Application");
    }

    @Override
    public void onAdFailedToLoad(int errorCode) {
        // Called when an ad request failed.
        Toast.makeText(MainActivity.this, "Ad Failed to Load: " + errorCode,
                Toast.LENGTH_SHORT).show();
        Log.e(MainActivity.class.getSimpleName(), "Ad Failed to Load: " +
                errorCode);
    }
};

Les constantes utilisées dans la méthode de rappel onAdFailedToLoad() sont définies dans AdListener.