設定

カスタム イベントを使用すると、メディエーションのサポート対象でない広告ネットワークもウォーターフォール メディエーションに組み込むことができます。これは、組み込みたい広告ネットワークに対応するカスタム イベント アダプタを実装することによって実現可能です。

GitHub リポジトリでは、サンプル カスタム イベント プロジェクトの全体を確認できます。

前提条件

カスタム イベントを作成するには、あらかじめ次のいずれかの広告フォーマットをアプリに組み込んでおく必要があります。

UI でカスタム イベントを作成する

カスタム イベントはまず AdMob 管理画面で作成する必要があります。カスタム イベントを追加するの手順をご覧ください。

以下を指定する必要があります。

クラス名

カスタム イベント アダプタを実装するクラスの完全修飾名です（例: com.google.ads.mediation.sample.customevent.SampleCustomEvent）。ベスト プラクティスとして、すべてのカスタム イベント広告フォーマットで同一のアダプタクラスを使用することをおすすめします。

ラベル

広告のソースを定義する一意の名前です。

パラメータ

カスタム イベント アダプタに渡される文字列引数（任意使用）です。

アダプタを初期化する

Google Mobile Ads SDK が初期化されると、AdMob 管理画面で該当アプリ用に設定されたすべてのサポート対象サードパーティ アダプタおよびカスタム イベントで、initialize() が呼び出されます。カスタム イベントに必要なサードパーティ SDK でセットアップまたは初期化を行う際は、このメソッドを使用します。

Java

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

import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.InitializationCompleteCallback;
import com.google.android.gms.ads.mediation.MediationConfiguration;

public class SampleAdNetworkCustomEvent extends Adapter {
  private static final String SAMPLE_AD_UNIT_KEY = "parameter";

  @Override
  public void initialize(Context context,
      InitializationCompleteCallback initializationCompleteCallback,
      List<MediationConfiguration> mediationConfigurations) {
    // This is where you will initialize the SDK that this custom
    // event is built for. Upon finishing the SDK initialization,
    // call the completion handler with success.
    initializationCompleteCallback.onInitializationSucceeded();
  }
}

Kotlin

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

import com.google.android.gms.ads.mediation.Adapter
import com.google.android.gms.ads.mediation.InitializationCompleteCallback
import com.google.android.gms.ads.mediation.MediationConfiguration

class SampleCustomEvent : Adapter() {
  private val SAMPLE_AD_UNIT_KEY = "parameter"

  override fun initialize(
    context: Context,
    initializationCompleteCallback: InitializationCompleteCallback,
    mediationConfigurations: List<MediationConfiguration>
  ) {
    // This is where you will initialize the SDK that this custom
    // event is built for. Upon finishing the SDK initialization,
    // call the completion handler with success.
    initializationCompleteCallback.onInitializationSucceeded()
  }
}

バージョン番号を報告する

すべてのカスタム イベントは、カスタム イベント アダプタ自体のバージョンと、カスタム イベントがアクセスするサードパーティ SDK のバージョンを、Google Mobile Ads SDK に報告する必要があります。バージョンは VersionInfo オブジェクトとして報告されます。

Java

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

public class SampleCustomEvent extends Adapter {

  @Override
  public VersionInfo getVersionInfo() {
    String versionString = new VersionInfo(1, 2, 3);
    String[] splits = versionString.split("\\.");

    if (splits.length >= 4) {
      int major = Integer.parseInt(splits[0]);
      int minor = Integer.parseInt(splits[1]);
      int micro = Integer.parseInt(splits[2]) * 100 + Integer.parseInt(splits[3]);
      return new VersionInfo(major, minor, micro);
    }

    return new VersionInfo(0, 0, 0);
  }

  @Override
  public VersionInfo getSDKVersionInfo() {
    String versionString = SampleAdRequest.getSDKVersion();
    String[] splits = versionString.split("\\.");

    if (splits.length >= 3) {
      int major = Integer.parseInt(splits[0]);
      int minor = Integer.parseInt(splits[1]);
      int micro = Integer.parseInt(splits[2]);
      return new VersionInfo(major, minor, micro);
    }

    return new VersionInfo(0, 0, 0);
  }
}

Kotlin

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

class SampleCustomEvent : Adapter() {
  override fun getVersionInfo(): VersionInfo {
    val versionString = VersionInfo(1,2,3).toString()
    val splits: List<String> = versionString.split("\\.")

    if (splits.count() >= 4) {
      val major = splits[0].toInt()
      val minor = splits[1].toInt()
      val micro = (splits[2].toInt() * 100) + splits[3].toInt()
      return VersionInfo(major, minor, micro)
    }

    return VersionInfo(0, 0, 0)
  }

  override fun getSDKVersionInfo(): VersionInfo {
    val versionString = VersionInfo(1,2,3).toString()
    val splits: List<String> = versionString.split("\\.")

    if (splits.count() >= 3) {
      val major = splits[0].toInt()
      val minor = splits[1].toInt()
      val micro = splits[2].toInt()
      return VersionInfo(major, minor, micro)
    }

    return VersionInfo(0, 0, 0)
  }
}

広告をリクエストする

広告をリクエストする方法については、各広告フォーマットの固有手順をご覧ください。