Eventi personalizzati di annunci nativi

Seleziona la piattaforma: Android (beta) Nuovo Android iOS

Prerequisiti

Completa la configurazione degli eventi personalizzati .

Richiedere un annuncio nativo

Quando l'elemento pubblicitario dell'evento personalizzato viene raggiunto nella catena di mediazione a cascata, viene chiamato il metodo loadNativeAd() sul nome della classe fornito quando si crea un evento personalizzato. In questo caso, il metodo si trova in SampleCustomEvent, che a sua volta chiama il metodo loadNativeAd() in SampleNativeCustomEventLoader.

Per richiedere un annuncio nativo, crea o modifica una classe che estende Adapter per implementare loadNativeAd(). Se esiste già una classe che estende Adapter, implementa loadNativeAd() in questa classe. Inoltre, crea una nuova classe per implementare UnifiedNativeAdMapper.

Nel nostro esempio di evento personalizzato, SampleCustomEvent estende la classe Adapter e poi delega a 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 è responsabile delle seguenti attività:

  • Caricamento dell'annuncio nativo.

  • Implementazione della classe UnifiedNativeAdMapper.

  • Ricezione e segnalazione dei callback degli eventi degli annunci a Google Mobile Ads SDK.

Il parametro facoltativo definito nell'interfaccia utente di AdMob è incluso nella configurazione dell'annuncio. È possibile accedere al parametro tramite adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD). Questo parametro è in genere un identificatore dell'unità pubblicitaria richiesto da un SDK della rete pubblicitaria quando viene creata un'istanza di un oggetto annuncio.

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

A seconda che l'annuncio venga recuperato correttamente o si verifichi un errore, dovrai chiamare either onSuccess() or onFailure(). onSuccess() viene chiamato passando un'istanza della classe che implementa MediationNativeAd.

In genere, questi metodi vengono implementati all'interno dei callback dell'SDK di terze parti implementato dall'adattatore. Per questo esempio, l'SDK di esempio ha un SampleAdListener con i callback pertinenti:

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

Mappare gli annunci nativi

I diversi SDK hanno formati univoci per gli annunci nativi. Ad esempio, uno potrebbe restituire oggetti che contengono un campo "title", mentre un altro potrebbe avere "headline". Inoltre, i metodi utilizzati per monitorare le impressioni ed elaborare i clic possono variare da un SDK all'altro.

Il UnifiedNativeAdMapper è responsabile della riconciliazione di queste differenze e dell'adattamento dell'oggetto annuncio nativo di un SDK di mediazione in modo che corrisponda all'interfaccia prevista da Google Mobile Ads SDK. Gli eventi personalizzati devono estendere questa classe per creare i propri mapper specifici per l'SDK di mediazione. Ecco un esempio di mapper di annunci dal nostro progetto di evento personalizzato di esempio:

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

Ora esaminiamo più da vicino il codice del costruttore.

Mantenere un riferimento all'oggetto annuncio nativo di mediazione

Il costruttore accetta il parametro SampleNativeAd, la classe di annunci nativi utilizzata dall'SDK di esempio per i suoi annunci nativi. Il mapper ha bisogno di un riferimento all'annuncio di mediazione per poter trasmettere gli eventi di clic e impressione. SampleNativeAd viene memorizzato come variabile locale.

Impostare le proprietà degli asset mappati

Il costruttore utilizza l'oggetto SampleNativeAd per popolare gli asset in UnifiedNativeAdMapper.

Questo snippet recupera i dati sui prezzi dell'annuncio di mediazione e li utilizza per impostare il prezzo del mapper:

Java

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

In questo esempio, l'annuncio di mediazione memorizza il prezzo come double, mentre AdMob utilizza una String per lo stesso asset. Il mapper è responsabile della gestione di questi tipi di conversioni.

Mappare gli asset immagine

La mappatura degli asset immagine è più complicata della mappatura di tipi di dati come double o String. Le immagini potrebbero essere scaricate automaticamente o restituite come valori URL. Anche le scale pixel-dpi possono variare.

Per aiutarti a gestire questi dettagli, Google Mobile Ads SDK fornisce la NativeAd.Image classe. Proprio come devi creare una sottoclasse di UnifiedNativeAdMapper per mappare un annuncio nativo di mediazione, devi anche creare una sottoclasse di NativeAd.Image quando mappi gli asset immagine.

Ecco un esempio per la classe SampleNativeMappedImage dell'evento personalizzato:

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

SampleNativeAdMapper utilizza la classe immagine mappata in questa riga per impostare l'asset immagine dell'icona del mapper:

Java

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

Aggiungere campi al bundle di extra

Alcuni SDK di mediazione forniscono asset aggiuntivi oltre a quelli nel formato dell'annuncio nativo di AdMob. La classe UnifiedNativeAdMapper include un metodo setExtras() utilizzato per passare questi asset ai publisher. SampleNativeAdMapper lo utilizza per l'asset "grado di meraviglia" dell'SDK di esempio:

Java

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

I publisher possono recuperare i dati utilizzando il metodo getExtras() della classe NativeAd.

AdChoices

L'evento personalizzato è responsabile della fornitura di un'icona Scegli Tu! utilizzando il metodo setAdChoicesContent() su UnifiedNativeAdMapper. Ecco uno snippet di SampleNativeAdMapper che mostra come fornire l'icona Scegli Tu!:

Java

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

Eventi di impressione e clic

Sia Google Mobile Ads SDK sia l'SDK di mediazione devono sapere quando si verifica un' impressione o un clic, ma solo un SDK deve monitorare questi eventi. Esistono due approcci diversi che gli eventi personalizzati possono utilizzare, a seconda che l'SDK di mediazione supporti o meno il monitoraggio delle impressioni e dei clic.

Monitorare i clic e le impressioni con Google Mobile Ads SDK

Se l'SDK di mediazione non esegue il monitoraggio delle impressioni e dei clic, ma fornisce metodi per registrare clic e impressioni, Google Mobile Ads SDK può monitorare questi eventi e inviare una notifica all'adattatore. La classe UnifiedNativeAdMapper include due metodi: recordImpression() e handleClick() che gli eventi personalizzati possono implementare per chiamare il metodo corrispondente sull'oggetto annuncio nativo di mediazione:

Java

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

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

Poiché SampleNativeAdMapper contiene un riferimento all'oggetto annuncio nativo dell'SDK di esempio, può chiamare il metodo appropriato su quell'oggetto per segnalare un clic o un'impressione. Tieni presente che il metodo handleClick() accetta un singolo parametro: l'oggetto View corrispondente all'asset dell'annuncio nativo che ha ricevuto il clic.

Monitorare i clic e le impressioni con l'SDK di mediazione

Alcuni SDK di mediazione potrebbero preferire monitorare autonomamente i clic e le impressioni. In questo caso, devi sostituire il monitoraggio predefinito dei clic e delle impressioni effettuando le seguenti due chiamate nel costruttore di UnifiedNativeAdMapper:

Java

setOverrideClickHandling(true);
setOverrideImpressionRecording(true);

Gli eventi personalizzati che sostituiscono il monitoraggio dei clic e delle impressioni devono segnalare gli eventi onAdClicked() e onAdImpression() all'SDK Google Mobile Ads.

Per monitorare le impressioni e i clic, l'SDK di mediazione probabilmente ha bisogno di accedere alle visualizzazioni per attivare il monitoraggio. L'evento personalizzato deve sostituire il metodo trackViews() e utilizzarlo per passare la visualizzazione dell'annuncio nativo all'SDK di mediazione per il monitoraggio. L'SDK di esempio del nostro progetto di evento personalizzato di esempio (da cui sono stati presi gli snippet di codice di questa guida) non utilizza questo approccio, ma se lo facesse, il codice dell'evento personalizzato sarebbe simile al seguente:

Java

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

Se l'SDK di mediazione supporta il monitoraggio dei singoli asset, può esaminare clickableAssetViews per vedere quali visualizzazioni devono essere rese cliccabili. Questa mappa è indicizzata in base a un nome asset in NativeAdAssetNames. UnifiedNativeAdMapper offre un metodo untrackView() corrispondente che gli eventi personalizzati possono sostituire per rilasciare eventuali riferimenti alla visualizzazione e dissociarla dall'oggetto annuncio nativo.

Inoltrare gli eventi di mediazione a Google Mobile Ads SDK

Puoi trovare tutti i callback supportati dalla mediazione nella MediationNativeAdCallback documentazione.

È importante che l'evento personalizzato inoltri il maggior numero possibile di questi callback, in modo che l'app riceva questi eventi equivalenti da Google Mobile Ads SDK. Ecco un esempio di utilizzo dei callback:

In questo modo si completa l'implementazione degli eventi personalizzati per gli annunci nativi. L'esempio completo è disponibile su GitHub.