Événements personnalisés pour les annonces natives

Sélectionnez une plate-forme : Android (bêta) Android iOS

Prérequis

Effectuez la configuration des événements personnalisés.

Demander une annonce native

Lorsque l'élément de campagne d'événement personnalisé est atteint dans la chaîne de médiation en cascade, la méthode loadNativeAd() est appelée sur le nom de classe que vous avez fourni lors de la création d'un événement personnalisé. Dans ce cas, cette méthode se trouve dans SampleCustomEvent, qui appelle ensuite la méthode loadNativeAd() dans SampleNativeCustomEventLoader.

Pour demander une annonce native, créez ou modifiez une classe qui étend Adapter pour implémenter loadNativeAd(). Si une classe qui étend Adapter existe déjà, implémentez loadNativeAd() à cet endroit. Créez également une classe pour implémenter UnifiedNativeAdMapper.

Dans notre exemple d'événement personnalisé, SampleCustomEvent étend la classe Adapter, puis délègue à SampleNativeCustomEventLoader.

Java

package com.google.ads.mediation.sample.customevent;

import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.MediationAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdLoadCallback;

import com.google.android.gms.ads.mediation.MediationNativeAdCallback;
...
public class SampleCustomEvent extends Adapter {
  private SampleNativeCustomEventLoader nativeLoader;

  @Override
  public void loadNativeAd(
      @NonNull MediationNativeAdConfiguration adConfiguration,
      @NonNull MediationAdLoadCallback<UnifiedNativeAdMapper, MediationNativeAdCallback> callback) {
    nativeLoader = new SampleNativeCustomEventLoader(adConfiguration, callback);
    nativeLoader.loadAd();
  }
}

SampleNativeCustomEventLoader est responsable des tâches suivantes :

• Chargement de l'annonce native.

• Implémentation de la classe UnifiedNativeAdMapper.

• Réception et signalement des rappels d'événements publicitaires à Google Mobile Ads SDK.

Le paramètre facultatif défini dans l'interface utilisateur Ad Manager est inclus dans la configuration de l'annonce. Vous pouvez accéder au paramètre via adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD). Ce paramètre est généralement un identifiant de bloc d'annonces requis par le SDK d'un réseau publicitaire lors de l'instanciation d'un objet publicitaire.

Java

package com.google.ads.mediation.sample.customevent;

import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.MediationNativeAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdLoadCallback;
import com.google.android.gms.ads.mediation.MediationNativeAdCallback;
...

public class SampleNativeCustomEventLoader extends SampleNativeAdListener {
  /** Configuration for requesting the native ad from the third-party network. */
  private final MediationNativeAdConfiguration mediationNativeAdConfiguration;

  /** Callback that fires on loading success or failure. */
  private final MediationAdLoadCallback<UnifiedNativeAdMapper, MediationNativeAdCallback>
      mediationAdLoadCallback;

  /** Callback for native ad events. */
  private MediationNativeAdCallback nativeAdCallback;

  /** Constructor */
  public SampleNativeCustomEventLoader(
      @NonNull MediationNativeAdConfiguration mediationNativeAdConfiguration,
      @NonNull MediationAdLoadCallback<MediationNativeAd, MediationNativeAdCallback>
              mediationAdLoadCallback) {
    this.mediationNativeAdConfiguration = mediationNativeAdConfiguration;
    this.mediationAdLoadCallback = mediationAdLoadCallback;
  }

  /** Loads the native ad from the third-party ad network. */
  public void loadAd() {
    // Create one of the Sample SDK's ad loaders to request ads.
    Log.i("NativeCustomEvent", "Begin loading native ad.");
    SampleNativeAdLoader loader =
        new SampleNativeAdLoader(mediationNativeAdConfiguration.getContext());

    // All custom events have a server parameter named "parameter" that returns
    // back the parameter entered into the UI when defining the custom event.
    String serverParameter = mediationNativeAdConfiguration
        .getServerParameters()
        .getString(MediationConfiguration
        .CUSTOM_EVENT_SERVER_PARAMETER_FIELD);
    Log.d("NativeCustomEvent", "Received server parameter.");

    loader.setAdUnit(serverParameter);

    // Create a native request to give to the SampleNativeAdLoader.
    SampleNativeAdRequest request = new SampleNativeAdRequest();
    NativeAdOptions options = mediationNativeAdConfiguration.getNativeAdOptions();
    if (options != null) {
      // If the NativeAdOptions' shouldReturnUrlsForImageAssets is true, the adapter should
      // send just the URLs for the images.
      request.setShouldDownloadImages(!options.shouldReturnUrlsForImageAssets());

      request.setShouldDownloadMultipleImages(options.shouldRequestMultipleImages());
      switch (options.getMediaAspectRatio()) {
        case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_LANDSCAPE:
          request.setPreferredImageOrientation(SampleNativeAdRequest.IMAGE_ORIENTATION_LANDSCAPE);
          break;
        case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_PORTRAIT:
          request.setPreferredImageOrientation(SampleNativeAdRequest.IMAGE_ORIENTATION_PORTRAIT);
          break;
        case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_SQUARE:
        case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_ANY:
        case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_UNKNOWN:
        default:
          request.setPreferredImageOrientation(SampleNativeAdRequest.IMAGE_ORIENTATION_ANY);
      }
    }

    loader.setNativeAdListener(this);

    // Begin a request.
    Log.i("NativeCustomEvent", "Start fetching native ad.");
    loader.fetchAd(request);
  }
}

Selon que l'annonce est récupérée ou qu'une erreur se produit, vous appelez soit onSuccess() soit onFailure(). onSuccess() est appelé en transmettant une instance de la classe qui implémente MediationNativeAd.

En règle générale, ces méthodes sont implémentées dans des rappels du SDK tiers implémenté par votre adaptateur. Dans cet exemple, le SDK d'exemple comporte un SampleAdListener avec des rappels pertinents :

Java

@Override
public void onNativeAdFetched(SampleNativeAd ad) {
  SampleUnifiedNativeAdMapper mapper = new SampleUnifiedNativeAdMapper(ad);
  mediationNativeAdCallback = mediationAdLoadCallback.onSuccess(mapper);
}

@Override
public void onAdFetchFailed(SampleErrorCode errorCode) {
  mediationAdLoadCallback.onFailure(SampleCustomEventError.createSampleSdkError(errorCode));
}

Mapper des annonces natives

Les SDK ont leurs propres formats uniques pour les annonces natives. Par exemple, l'un peut renvoyer des objets contenant un champ "title", tandis qu'un autre peut avoir "headline". De plus, les méthodes utilisées pour suivre les impressions et traiter les clics peuvent varier d'un SDK à l'autre.

Le UnifiedNativeAdMapper est chargé de concilier ces différences et d'adapter l'objet d'annonce native d'un SDK de médiation pour qu'il corresponde à l'interface attendue par Google Mobile Ads SDK. Les événements personnalisés doivent étendre cette classe pour créer leurs propres mappers spécifiques à leur SDK de médiation. Voici un exemple de mapper d'annonces issu de notre exemple de projet d'événement personnalisé :

Java

package com.google.ads.mediation.sample.customevent;

import com.google.android.gms.ads.mediation.UnifiedNativeAdMapper;
import com.google.android.gms.ads.nativead.NativeAd;
...

public class SampleUnifiedNativeAdMapper extends UnifiedNativeAdMapper {

  private final SampleNativeAd sampleAd;

  public SampleUnifiedNativeAdMapper(SampleNativeAd ad) {
    sampleAd = ad;
    setHeadline(sampleAd.getHeadline());
    setBody(sampleAd.getBody());
    setCallToAction(sampleAd.getCallToAction());
    setStarRating(sampleAd.getStarRating());
    setStore(sampleAd.getStoreName());
    setIcon(
        new SampleNativeMappedImage(
            ad.getIcon(), ad.getIconUri(), SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE));
    setAdvertiser(ad.getAdvertiser());

    List<NativeAd.Image> imagesList = new ArrayList<NativeAd.Image>();
    imagesList.add(new SampleNativeMappedImage(ad.getImage(), ad.getImageUri(),
        SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE));
    setImages(imagesList);

    if (sampleAd.getPrice() != null) {
      NumberFormat formatter = NumberFormat.getCurrencyInstance();
      String priceString = formatter.format(sampleAd.getPrice());
      setPrice(priceString);
    }

    Bundle extras = new Bundle();
    extras.putString(SampleCustomEvent.DEGREE_OF_AWESOMENESS, ad.getDegreeOfAwesomeness());
    this.setExtras(extras);

    setOverrideClickHandling(false);
    setOverrideImpressionRecording(false);

    setAdChoicesContent(sampleAd.getInformationIcon());
  }

  @Override
  public void recordImpression() {
    sampleAd.recordImpression();
  }

  @Override
  public void handleClick(View view) {
    sampleAd.handleClick(view);
  }

  // The Sample SDK doesn't do its own impression/click tracking, instead relies on its
  // publishers calling the recordImpression and handleClick methods on its native ad object. So
  // there's no need to pass a reference to the View being used to display the native ad. If
  // your mediated network does need a reference to the view, the following method can be used
  // to provide one.

  @Override
  public void trackViews(View containerView, Map<String, View> clickableAssetViews,
      Map<String, View> nonClickableAssetViews) {
    super.trackViews(containerView, clickableAssetViews, nonClickableAssetViews);
    // If your ad network SDK does its own impression tracking, here is where you can track the
    // top level native ad view and its individual asset views.
  }

  @Override
  public void untrackView(View view) {
    super.untrackView(view);
    // Here you would remove any trackers from the View added in trackView.
  }
}

Nous allons maintenant examiner de plus près le code du constructeur.

Conserver une référence à l'objet d'annonce native de médiation

Le constructeur accepte le paramètre SampleNativeAd, la classe d'annonce native utilisée par le SDK d'exemple pour ses annonces natives. Le mapper a besoin d'une référence à l'annonce de médiation pour pouvoir transmettre les événements de clic et d'impression. SampleNativeAd est stocké en tant que variable locale.

Définir les propriétés des composants mappés

Le constructeur utilise l'objet SampleNativeAd pour remplir les composants dans UnifiedNativeAdMapper.

Cet extrait obtient les données de prix de l'annonce de médiation et les utilise pour définir le prix du mapper :

Java

if (sampleAd.getPrice() != null) {
    NumberFormat formatter = NumberFormat.getCurrencyInstance();
    String priceString = formatter.format(sampleAd.getPrice());
    setPrice(priceString);
}

Dans cet exemple, l'annonce de médiation stocke le prix sous la forme d'un double, tandis qu'Ad Manager utilise un String pour le même composant. Le mapper est chargé de gérer ces types de conversions.

Mapper des composants Image

Le mappage des composants Image est plus complexe que le mappage des types de données tels que double ou String. Les images peuvent être téléchargées automatiquement ou renvoyées en tant que valeurs d'URL. Leur échelle de pixels par dpi peut également varier.

Pour vous aider à gérer ces informations, Google Mobile Ads SDK fournit la NativeAd.Image classe. De la même manière que vous devez créer une sous-classe de UnifiedNativeAdMapper pour mapper une annonce native de médiation, vous devez également créer une sous-classe de NativeAd.Image lors du mappage des composants Image.

Voici un exemple pour la classe SampleNativeMappedImage de l'événement personnalisé :

Java

public class SampleNativeMappedImage extends NativeAd.Image {

  private Drawable drawable;
  private Uri imageUri;
  private double scale;

  public SampleNativeMappedImage(Drawable drawable, Uri imageUri, double scale) {
    this.drawable = drawable;
    this.imageUri = imageUri;
    this.scale = scale;
  }

  @Override
  public Drawable getDrawable() {
    return drawable;
  }

  @Override
  public Uri getUri() {
    return imageUri;
  }

  @Override
  public double getScale() {
    return scale;
  }
}

Le SampleNativeAdMapper utilise sa classe d'image mappée dans cette ligne pour définir le composant d'image d'icône du mapper :

Java

setIcon(new SampleNativeMappedImage(ad.getAppIcon(), ad.getAppIconUri(),
    SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE));

Ajouter des champs au bundle d'extras

Certains SDK de médiation fournissent des composants supplémentaires au-delà de ceux du format d'annonce native Ad Manager. La classe UnifiedNativeAdMapper inclut une méthode setExtras() qui permet de transmettre ces composants aux éditeurs. Le SampleNativeAdMapper l'utilise pour le composant "degree of awesomeness" du SDK d'exemple :

Java

Bundle extras = new Bundle();
extras.putString(SampleCustomEvent.DEGREE_OF_AWESOMENESS, ad.getDegreeOfAwesomeness());
this.setExtras(extras);

Les éditeurs peuvent récupérer les données à l'aide de la méthode getExtras() de la classe NativeAd.

AdChoices

Votre événement personnalisé est chargé de fournir une icône Choisir sa pub à l'aide de la méthode setAdChoicesContent() sur UnifiedNativeAdMapper. Voici un extrait de SampleNativeAdMapper qui montre comment fournir l'icône Choisir sa pub :

Java

public SampleNativeAdMapper(SampleNativeAd ad) {
    ...
    setAdChoicesContent(sampleAd.getInformationIcon());
}

Événements d'impression et de clic

Google Mobile Ads SDK et le SDK de médiation doivent savoir quand une impression ou un clic se produit, mais un seul SDK doit suivre ces événements. Les événements personnalisés peuvent utiliser deux approches différentes, selon que le SDK de médiation est compatible ou non avec le suivi des impressions et des clics.

Suivre les clics et les impressions avec Google Mobile Ads SDK

Si le SDK de médiation n'effectue pas son propre suivi des impressions et des clics, mais fournit des méthodes pour enregistrer les clics et les impressions, Google Mobile Ads SDK peut suivre ces événements et avertir l'adaptateur. La classe UnifiedNativeAdMapper inclut deux méthodes : recordImpression() et handleClick() que les événements personnalisés peuvent implémenter pour appeler la méthode correspondante sur l'objet d'annonce native de médiation :

Java

@Override
public void recordImpression() {
  sampleAd.recordImpression();
}

@Override
public void handleClick(View view) {
  sampleAd.handleClick(view);
}

Étant donné que le SampleNativeAdMapper contient une référence à l'objet d'annonce native du SDK d'exemple, il peut appeler la méthode appropriée sur cet objet pour signaler un clic ou une impression. Notez que la méthode handleClick() ne prend qu'un seul paramètre : l'objet View correspondant au composant d'annonce native qui a reçu le clic.

Suivre les clics et les impressions avec le SDK de médiation

Certains SDK de médiation peuvent préférer suivre eux-mêmes les clics et les impressions. Dans ce cas, vous devez remplacer le suivi par défaut des clics et des impressions en effectuant les deux appels suivants dans le constructeur de votre UnifiedNativeAdMapper :

Java

setOverrideClickHandling(true);
setOverrideImpressionRecording(true);

Les événements personnalisés qui remplacent le suivi des clics et des impressions doivent signaler les événements onAdClicked() et onAdImpression() au SDK Google Mobile Ads.

Pour suivre les impressions et les clics, le SDK de médiation a probablement besoin d'accéder aux vues pour activer le suivi. L'événement personnalisé doit remplacer la méthode trackViews() et l'utiliser pour transmettre la vue de l'annonce native au SDK de médiation à suivre. Le SDK d'exemple de notre exemple de projet d'événement personnalisé (à partir duquel les extraits de code de ce guide ont été extraits) n'utilise pas cette approche. Toutefois, si c'était le cas, le code de l'événement personnalisé ressemblerait à ceci :

Java

@Override
public void trackViews(View containerView,
    Map<String, View> clickableAssetViews,
    Map<String, View> nonClickableAssetViews) {
  sampleAd.setNativeAdViewForTracking(containerView);
}

Si le SDK de médiation est compatible avec le suivi des composants individuels, il peut examiner clickableAssetViews pour voir quelles vues doivent être cliquables. Cette carte est associée à un nom de composant dans NativeAdAssetNames. Le UnifiedNativeAdMapper propose une méthode untrackView() correspondante que les événements personnalisés peuvent remplacer pour libérer toutes les références à la vue et la dissocier de l'objet d'annonce native.

Transférer les événements de médiation à Google Mobile Ads SDK

Vous trouverez tous les rappels compatibles avec la médiation dans la MediationNativeAdCallback documentation.

Il est important que votre événement personnalisé transfère autant de rappels que possible, afin que votre application reçoive ces événements équivalents de Google Mobile Ads SDK. Voici un exemple d'utilisation des rappels :

L'implémentation des événements personnalisés pour les annonces natives est terminée. L'exemple complet est disponible sur GitHub.