Benutzerdefinierte Ereignisse für Banneranzeigen

Vorbereitung

Führen Sie die Einrichtung benutzerdefinierter Ereignisse durch.

Banneranzeige anfordern

Wenn das benutzerdefinierte Ereignis-Line-Item in der Wasserfall-Mediationskette erreicht wird, wird die Methode loadBannerAd() für den Klassennamen aufgerufen, den Sie beim Erstellen eines benutzerdefinierten Ereignisses angegeben haben. In diesem Fall befindet sich die Methode in SampleCustomEvent, die dann die Methode loadBannerAd() in SampleBannerCustomEventLoader aufruft.

Wenn Sie eine Banneranzeige anfordern möchten, erstellen oder ändern Sie eine Klasse, die Adapter erweitert, um loadBannerAd() zu implementieren. Erstellen Sie außerdem eine neue Klasse, um MediationBannerAd zu implementieren.

In unserem Beispiel für benutzerdefinierte Ereignisse erweitert SampleCustomEvent die Klasse Adapter und delegiert dann an SampleBannerCustomEventLoader.

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.MediationBannerAd;
import com.google.android.gms.ads.mediation.MediationBannerAdCallback;
...

public class SampleCustomEvent extends Adapter {
  private SampleBannerCustomEventLoader bannerLoader;
  @Override
  public void loadBannerAd(
      @NonNull MediationBannerAdConfiguration adConfiguration,
      @NonNull MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback> callback) {
    bannerLoader = new SampleBannerCustomEventLoader(adConfiguration, callback);
    bannerLoader.loadAd();
  }
}

SampleBannerCustomEventLoader ist für die folgenden Aufgaben verantwortlich:

  • Die Banneranzeige wird geladen und nach Abschluss des Ladevorgangs wird die Methode MediationAdLoadCallback aufgerufen.

  • Implementieren Sie die MediationBannerAd-Schnittstelle.

  • Empfangen und Melden von Anzeigenereignis-Callbacks an das Google Mobile Ads SDK.

Der optionale Parameter, der in der -Benutzeroberfläche definiert ist, ist in der Anzeigenkonfiguration enthalten. Auf den Parameter kann über adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD) zugegriffen werden. Dieser Parameter ist in der Regel eine Anzeigenblock-ID, die ein SDK eines Werbenetzwerks beim Instanziieren eines Anzeigenobjekts benötigt.

Java

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

import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.MediationBannerAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdLoadCallback;
import com.google.android.gms.ads.mediation.MediationBannerAd;
import com.google.android.gms.ads.mediation.MediationBannerAdCallback;
...

public class SampleBannerCustomEventLoader extends SampleAdListener implements MediationBannerAd {

  /** View to contain the sample banner ad. */
  private SampleAdView sampleAdView;

  /** Configuration for requesting the banner ad from the third-party network. */
  private final MediationBannerAdConfiguration mediationBannerAdConfiguration;

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

  /** Callback for banner ad events. */
  private MediationBannerAdCallback bannerAdCallback;

  /** Constructor. */
  public SampleBannerCustomEventLoader(
      @NonNull MediationBannerAdConfiguration mediationBannerAdConfiguration,
      @NonNull MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback>
              mediationAdLoadCallback) {
    this.mediationBannerAdConfiguration = mediationBannerAdConfiguration;
    this.mediationAdLoadCallback = mediationAdLoadCallback;
  }

  /** Loads a banner ad from the third-party ad network. */
  public void loadAd() {
    // All custom events have a server parameter named "parameter" that returns
    // back the parameter entered into the UI when defining the custom event.
    Log.i("BannerCustomEvent", "Begin loading banner ad.");
    String serverParameter =
        mediationBannerAdConfiguration.getServerParameters().getString(
        MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD);

    Log.d("BannerCustomEvent", "Received server parameter.");

    Context context = mediationBannerAdConfiguration.getContext();
    sampleAdView = new SampleAdView(context);

    // Assumes that the serverParameter is the ad unit of the Sample Network.
    sampleAdView.setAdUnit(serverParameter);
    AdSize size = mediationBannerAdConfiguration.getAdSize();

    // Internally, smart banners use constants to represent their ad size, which
    // means a call to AdSize.getHeight could return a negative value. You can
    // accommodate this by using AdSize.getHeightInPixels and
    // AdSize.getWidthInPixels instead, and then adjusting to match the device's
    // display metrics.
    int widthInPixels = size.getWidthInPixels(context);
    int heightInPixels = size.getHeightInPixels(context);
    DisplayMetrics displayMetrics = Resources.getSystem().getDisplayMetrics();
    int widthInDp = Math.round(widthInPixels / displayMetrics.density);
    int heightInDp = Math.round(heightInPixels / displayMetrics.density);

    sampleAdView.setSize(new SampleAdSize(widthInDp, heightInDp));
    sampleAdView.setAdListener(this);

    SampleAdRequest request = createSampleRequest(mediationBannerAdConfiguration);
    Log.i("BannerCustomEvent", "Start fetching banner ad.");
    sampleAdView.fetchAd(request);
  }

  public SampleAdRequest createSampleRequest(
      MediationAdConfiguration mediationAdConfiguration) {
    SampleAdRequest request = new SampleAdRequest();
    request.setTestMode(mediationAdConfiguration.isTestRequest());
    request.setKeywords(mediationAdConfiguration.getMediationExtras().keySet());
    return request;
  }
}

Je nachdem, ob die Anzeige erfolgreich abgerufen wurde oder ein Fehler aufgetreten ist, rufen Sie entweder onSuccess() oder onFailure() auf. onSuccess() wird aufgerufen, indem eine Instanz der Klasse übergeben wird, die MediationBannerAd implementiert.

In der Regel werden diese Methoden in Callbacks des Drittanbieter-SDK implementiert, das von Ihrem Adapter implementiert wird. In diesem Beispiel hat das Beispiel-SDK ein SampleAdListener mit relevanten Callbacks:

Java

@Override
public void onAdFetchSucceeded() {
  bannerAdCallback = mediationAdLoadCallback.onSuccess(this);
}

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

Für MediationBannerAd muss eine View-Getter-Methode implementiert werden:

Java

@Override
@NonNull
public View getView() {
  return sampleAdView;
}

Vermittlungsereignisse an das Google Mobile Ads SDK weiterleiten

Sobald onSuccess() aufgerufen wird, kann das zurückgegebene MediationBannerAdCallback-Objekt vom Adapter verwendet werden, um Präsentationsereignisse vom Drittanbieter-SDK an das Google Mobile Ads SDK weiterzuleiten. Die Klasse SampleBannerCustomEventLoader erweitert die Schnittstelle SampleAdListener, um Callbacks vom Beispiel-Werbenetzwerk an das Google Mobile Ads SDK weiterzuleiten.

Es ist wichtig, dass Ihr benutzerdefiniertes Ereignis so viele dieser Callbacks wie möglich weiterleitet, damit Ihre App diese entsprechenden Ereignisse vom Google Mobile Ads SDK empfängt. Hier ein Beispiel für die Verwendung von Callbacks:

Java

@Override
public void onAdFullScreen() {
  bannerAdCallback.onAdOpened();
  bannerAdCallback.reportAdClicked();
}

@Override
public void onAdClosed() {
  bannerAdCallback.onAdClosed();
}

Damit ist die Implementierung benutzerdefinierter Ereignisse für Banneranzeigen abgeschlossen. Das vollständige Beispiel ist auf GitHub verfügbar. Sie können es mit einem bereits unterstützten Werbenetzwerk verwenden oder es so anpassen, dass Banneranzeigen für benutzerdefinierte Ereignisse ausgeliefert werden.