Eventos personalizados de anuncios nativos

Requisitos previos

Completa la configuración de eventos personalizados.

Cómo solicitar un anuncio nativo

Cuando se llega al elemento de línea del evento personalizado en la cadena de mediación en cascada, se llama al método loadNativeAd() en el nombre de la clase que proporcionaste cuando creaste un evento personalizado. En este caso, ese método está en SampleCustomEvent, que luego llama al método loadNativeAd() en SampleNativeCustomEventLoader.

Para solicitar un anuncio nativo, crea o modifica una clase que extienda Adapter para implementar loadNativeAd(). Si ya existe una clase que extiende Adapter, implementa loadNativeAd() allí. Además, crea una clase nueva para implementar UnifiedNativeAdMapper.

En nuestro ejemplo de evento personalizado, SampleCustomEvent extiende la clase Adapter y, luego, delega a SampleNativeCustomEventLoader.

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 es responsable de las siguientes tareas:

• Carga del anuncio nativo

• Implementa la clase UnifiedNativeAdMapper.

• Recibir y generar devoluciones de llamada de eventos de anuncios en el SDK de anuncios de Google para dispositivos móviles

El parámetro opcional definido en la IU de Ad Manager se incluye en la configuración del anuncio. Se puede acceder al parámetro a través de adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD). Por lo general, este parámetro es un identificador de unidades de anuncios que requiere un SDK de red de publicidad cuando se crea una instancia de un objeto de anuncio.

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

Según si el anuncio se recupera correctamente o encuentra un error, llamarás a onSuccess() o a onFailure(). Para llamar a onSuccess(), pasa una instancia de la clase que implementa MediationNativeAd.

Por lo general, estos métodos se implementan dentro de devoluciones de llamada del SDK de terceros que implementa tu adaptador. En este ejemplo, el SDK de ejemplo tiene un SampleAdListener con devoluciones de llamada relevantes:

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

Cómo asignar anuncios nativos

Los diferentes SDKs tienen sus propios formatos únicos para los anuncios nativos. Por ejemplo, uno podría mostrar objetos que contienen un campo "título", mientras que otro podría tener "título principal". Además, los métodos que se usan para hacer un seguimiento de las impresiones y procesar los clics pueden variar de un SDK a otro.

UnifiedNativeAdMapper es responsable de conciliar estas diferencias y adaptar el objeto de anuncio nativo de un SDK mediado para que coincida con la interfaz que espera el SDK de anuncios de Google para dispositivos móviles. Los eventos personalizados deben extender esta clase para crear sus propios asignadores específicos de su SDK mediado. Este es un ejemplo de asignador de anuncios de nuestro proyecto de ejemplo de eventos personalizados:

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

Ahora, analicemos con más detalle el código del constructor.

Conserva una referencia al objeto de anuncio nativo mediado

El constructor acepta el parámetro SampleNativeAd, la clase de anuncio nativo que usa el SDK de muestra para sus anuncios nativos. El asignador necesita una referencia al anuncio mediado para poder pasar los eventos de clic y de impresión. SampleNativeAd se almacena como una variable local.

Cómo establecer propiedades de activos asignados

El constructor usa el objeto SampleNativeAd para propagar los recursos en el UnifiedNativeAdMapper.

Este fragmento obtiene los datos de precios del anuncio mediado y los usa para establecer el precio del asignador:

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

En este ejemplo, el anuncio mediado almacena el precio como un double, mientras que Ad Manager usa un String para el mismo recurso. El asignador es responsable de controlar estos tipos de conversiones.

Recursos de imagen del mapa

Asignar elementos de imagen es más complicado que asignar tipos de datos como double o String. Es posible que las imágenes se descarguen automáticamente o se muestren como valores de URL. Sus escalas de píxeles a DPI también pueden variar.

Para ayudarte a administrar estos detalles, el SDK de anuncios de Google para dispositivos móviles proporciona la clase NativeAd.Image. De la misma manera en que debes crear una subclase de UnifiedNativeAdMapper para asignar un anuncio nativo mediado, también debes crear una subclase de NativeAd.Image cuando asignes elementos de imagen.

Este es un ejemplo de la clase SampleNativeMappedImage del evento personalizado:

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 usa su clase de imagen asignada en esta línea para establecer el activo de imagen del ícono del asignador:

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

Agrega campos al paquete de extras

Algunos SDKs mediados proporcionan recursos adicionales más allá de los que se incluyen en el formato de anuncio nativo de Ad Manager. La clase UnifiedNativeAdMapper incluye un método setExtras() que se usa para pasar estos recursos a los publicadores. El SampleNativeAdMapper usa esto para el elemento "degree of awesomeness" (grado de genialidad) del SDK de muestra:

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

Los editores pueden recuperar los datos con el método getExtras() de la clase NativeAd.

AdChoices

Tu evento personalizado es responsable de proporcionar un ícono de AdChoices mediante el método setAdChoicesContent() en UnifiedNativeAdMapper. Este es un fragmento de SampleNativeAdMapper que muestra cómo proporcionar el ícono de AdChoices:

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

Eventos de impresión y clic

Tanto el SDK de anuncios de Google para dispositivos móviles como el SDK mediado deben saber cuándo se produce una impresión o un clic, pero solo un SDK debe hacer un seguimiento de estos eventos. Existen dos enfoques diferentes que pueden usar los eventos personalizados, según si el SDK mediado admite el seguimiento de impresiones y clics por sí solo.

Realiza un seguimiento de los clics y las impresiones con el SDK de anuncios de Google para dispositivos móviles

Si el SDK mediado no realiza su propio seguimiento de clics e impresiones, pero proporciona métodos para registrar clics e impresiones, el SDK de anuncios de Google para dispositivos móviles puede hacer un seguimiento de estos eventos y notificar al adaptador. La clase UnifiedNativeAdMapper incluye dos métodos: recordImpression() y handleClick() que los eventos personalizados pueden implementar para llamar al método correspondiente en el objeto de anuncio nativo mediado:

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

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

Debido a que SampleNativeAdMapper contiene una referencia al objeto de anuncio nativo del SDK de Sample, puede llamar al método adecuado en ese objeto para informar un clic o una impresión. Ten en cuenta que el método handleClick() toma un solo parámetro: el objeto View que corresponde al recurso de anuncio nativo que recibió el clic.

Realiza un seguimiento de los clics y las impresiones con el SDK mediado

Es posible que algunos SDKs mediados prefieran hacer un seguimiento de los clics y las impresiones por su cuenta. En ese caso, debes anular el seguimiento de clics y de impresiones predeterminados realizando las siguientes dos llamadas en el constructor de tu UnifiedNativeAdMapper:

setOverrideClickHandling(true);
setOverrideImpressionRecording(true);

Los eventos personalizados que anulan el seguimiento de clics y de impresiones deben informar los eventos onAdClicked() y onAdImpression() al SDK de anuncios de Google para dispositivos móviles.

Para hacer un seguimiento de las impresiones y los clics, es probable que el SDK mediado necesite acceso a las vistas para habilitar el seguimiento. El evento personalizado debe anular el método trackViews() y usarlo para pasar la vista del anuncio nativo al SDK mediado para realizar un seguimiento. El SDK de muestra de nuestro proyecto de evento personalizado de ejemplo (del que se extrajeron los fragmentos de código de esta guía) no usa este enfoque. Sin embargo, si lo hiciera, el código del evento personalizado se vería de la siguiente manera:

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

Si el SDK mediado admite el seguimiento de elementos individuales, puede revisar dentro de clickableAssetViews para ver en qué vistas se puede hacer clic. Este mapa se codifica por un nombre de activo en NativeAdAssetNames. UnifiedNativeAdMapper ofrece un método untrackView() correspondiente que los eventos personalizados pueden anular para liberar cualquier referencia a la vista y desasociación del objeto de anuncio nativo.

Reenvía eventos de mediación al SDK de anuncios de Google para dispositivos móviles

Puedes encontrar todas las devoluciones de llamada que admite la mediación en la documentación de MediationNativeAdCallback.

Es importante que tu evento personalizado reenvíe tantas de estas devoluciones de llamada como sea posible, de modo que tu app reciba estos eventos equivalentes del SDK de Google Mobile Ads. Este es un ejemplo del uso de devoluciones de llamada:

Esto completa la implementación de eventos personalizados para los anuncios nativos. El ejemplo completo está disponible en GitHub.