Pengembangan adaptor bidding

Panduan ini ditujukan untuk jaringan iklan yang ingin membuat adaptor bidding guna berpartisipasi dalam bidding real-time (RTB) dalam mediasi Google. Jika Anda adalah penayang, lihat petunjuk mediasi penayang.

Adaptor bidding adalah bagian sisi klien dari integrasi. Adaptor memungkinkan SDK jaringan iklan Anda berkomunikasi dengan Google Mobile Ads SDK untuk memuat iklan yang ditayangkan oleh bidder Anda.

Agar bidding berfungsi dengan benar, adaptor Anda harus menangani inisialisasi, mengumpulkan sinyal, memuat iklan, dan meneruskan peristiwa siklus proses iklan. Dalam panduan ini, kami akan memandu Anda cara menerapkan adaptor untuk menangani operasi ini.

Catatan: Partisipasi dalam bidding juga memerlukan bidder yang dapat merespons permintaan OpenRTB. Petunjuk tentang cara menyiapkan bidder berada di luar cakupan panduan ini.

Alur kerja adaptor bidding

Inisialisasi

Alur mendetail dari seluruh siklus proses rendering respons permintaan adaptor ditampilkan di bawah:

Adaptor bertanggung jawab atas bagian alur kerja berikut:

• Langkah 4-7: Lakukan inisialisasi adaptor dan panggil kembali Google Mobile Ads SDK setelah inisialisasi selesai.

• Langkah 10-13: Kumpulkan sinyal dari SDK jaringan iklan untuk dikirim ke bidder agar berpartisipasi dalam permintaan RTB, dan teruskan ke Google Mobile Ads SDK.

• Langkah 18-21: Jika bidder Anda menampilkan bid pemenang, muat iklan sesuai dengan respons dari bidder Anda. Setelah dimuat, beri tahu Google Mobile Ads SDK bahwa iklan telah dimuat.

• Langkah 23 dan yang lebih baru: Saat iklan ditampilkan, beri tahu Google Mobile Ads SDK tentang peristiwa tayangan dan klik, serta peristiwa iklan lainnya yang terjadi selama siklus proses presentasi iklan Anda.

Catatan: Google Mobile Ads SDK melacak peristiwa tayangan secara terpisah, tetapi Anda juga harus meneruskan peristiwa tayangan jaringan iklan agar kami dapat memeriksa perbedaan.

Mengimplementasikan adaptor bidding

Untuk membuat adaptor bidding untuk Google Mobile Ads SDK, Anda harus memperluas class abstrak RtbAdapter. Bagian berikut menjelaskan setiap metode abstrak di RtbAdapter.

getSDKVersionInfo()

Di sini, Anda harus menampilkan versi SDK. Versi ini diteruskan ke bidder Anda sebagai bagian dari permintaan OpenRTB.

Metode ini mengharuskan Anda menampilkan VersionInfo. Contoh di bawah menunjukkan cara mengonversi versi string SDK menjadi VersionInfo.

@Override
public VersionInfo getSDKVersionInfo() {
  // Get your SDK's version as a string. E.g. "1.2.3"
  // String versionString = YourSdk.getVersion();
  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);
   }

   String logMessage = String.format("Unexpected SDK version format: %s." +
           "Returning 0.0.0 for SDK version.", sdkVersion);
   Log.w(TAG, logMessage);
   return new VersionInfo(0, 0, 0);
}

getVersionInfo()

Di sini, Anda harus menampilkan versi adaptor. Versi ini diteruskan ke bidder Anda sebagai bagian dari permintaan OpenRTB.

Open source dan adaptor berversi Google menggunakan skema versi adaptor 4 digit, tetapi VersionInfo hanya mengizinkan 3 digit. Untuk mengatasi hal ini, sebaiknya gabungkan dua digit terakhir ke dalam versi patch, seperti yang ditunjukkan di bawah.

@Override
public VersionInfo getVersionInfo() {
  // Get your adapters's version as a string. E.g. "1.2.3.0"
  String versionString = BuildConfig.VERSION_NAME;
  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);
    }

    String logMessage = String.format("Unexpected adapter version format: %s." +
                "Returning 0.0.0 for adapter version.", versionString);
    Log.w(TAG, logMessage);
    return new VersionInfo(0, 0, 0);
}

initialize()

Waktu tunggu: 30 detik

Metode initialize() adalah metode pertama yang dipanggil di adaptor Anda. Metode ini hanya dipanggil sekali per sesi. Metode ini memberi Anda daftar objek MediationConfiguration yang mewakili daftar lengkap penempatan di aplikasi ini yang dikonfigurasi untuk jaringan iklan Anda; Anda dapat melakukan loop pada daftar ini untuk mengurai kredensial untuk setiap penempatan, dan meneruskan data yang relevan ke SDK untuk inisialisasi.

Setelah SDK diinisialisasi dan siap menerima permintaan iklan, panggil metode onInitializationSucceeded() dari InitializationCompleteCallback. Callback ini diteruskan ke penayang aplikasi agar mereka dapat mengetahui bahwa mereka dapat mulai memuat iklan.

Catatan: Metode initialize() dipanggil pada instance adaptor sekali pakai. Tidak ada metode lain yang akan dipanggil pada instance khusus ini. Jika adaptor Anda perlu menyimpan status sebagai hasil dari metode ini, status apa pun harus bersifat statis.

@Override
public void initialize(Context context,
    InitializationCompleteCallback initializationCompleteCallback,
    List<MediationConfiguration> mediationConfigurations) {
  // Initialize your ad network's SDK.
  ...

  // Invoke the InitializationCompleteCallback once initialization completes.
  initializationCompleteCallback.onInitializationSucceeded();
}

collectSignals()

Waktu tunggu: 1 detik

Setiap kali penayang meminta iklan, instance RtbAdapter baru akan dibuat dan metode collectSignals() akan dipanggil. Instance RtbAdapter ini akan digunakan selama durasi siklus proses permintaan, respons, dan rendering iklan untuk iklan tersebut. Metode collectSignals() memungkinkan adaptor Anda menyediakan sinyal dari perangkat untuk dikirim ke bidder dalam permintaan OpenRTB.

collectSignals() dipanggil pada thread latar belakang. Google Mobile Ads SDK secara bersamaan meminta sinyal dari semua adaptor yang berpartisipasi dalam bidding. Harap saling menghormati dan batasi panggilan ke UI thread selama waktu ini. Setiap pekerjaan berat yang perlu dilakukan adaptor atau SDK untuk mengumpulkan sinyal harus dilakukan dalam metode initialize() dan di-cache.

Setelah sinyal siap, panggil callback onSuccess() dengan sinyal yang dienkode.

Berikut adalah contoh penerapan:

@Override
public void collectSignals(RtbSignalData rtbSignalData,
                           SignalCallbacks signalCallbacks) {
  String signals = YourSdk.getSignals();
  signalCallbacks.onSuccess(signals);
}

Jika adaptor Anda gagal mengumpulkan sinyal, panggil signalCallbacks.onFailure() dengan string yang menjelaskan error yang terjadi.

Catatan: String sinyal dapat mewakili objek apa pun, dan dapat dalam format apa pun, seperti JSON biasa, dienkode Base64, atau bentuk enkripsi lainnya yang Anda pilih. Sebaiknya enkripsi sinyal untuk memastikan sinyal tidak transparan di luar jaringan Anda.

Mengimplementasikan metode pemuatan iklan

Waktu tunggu: 10 detik

Jika bidder Anda menampilkan bid pemenang, Google Mobile Ads SDK akan memanggil adaptor untuk memuat iklan pemenang, yang meneruskan data apa pun yang ditampilkan bidder yang diperlukan SDK untuk memuat iklan tersebut.

Metode pemuatan yang tepat yang dipanggil bergantung pada format iklan yang menjadi tujuan permintaan ini:

Format Iklan	Metode pemuatan
Banner	loadBannerAd()
Interstisial	loadInterstitialAd()
Reward	loadRewardedAd()

Terapkan metode ini untuk format iklan yang didukung adaptor Anda.

Metode pemuatan dipanggil di UI thread, pada instance adaptor yang sama tempat Anda memberikan sinyal. Metode ini memberi Anda parameter berikut:

• MediationAdConfiguration, yang berisi parameter yang diperlukan SDK Anda untuk memuat iklan untuk bid pemenang, seperti respons bid dan kredensial apa pun yang dikonfigurasi penayang di UI AdMob.

• Objek MediationAdLoadCallback yang digunakan untuk memberi tahu Google Mobile Ads SDK saat pemuatan berhasil atau gagal.

Setelah SDK memuat iklan, panggil mediationAdLoadCallback.onSuccess(). Jika pemuatan iklan gagal, panggil mediationAdLoadCallback.onFailure() dengan string yang menjelaskan error yang terjadi.

Metode mediationAdLoadCallback.onSuccess() mengharuskan Anda meneruskan objek yang sesuai dengan salah satu antarmuka "Iklan" yang ditentukan oleh Google Mobile Ads SDK. Antarmuka iklan ini meminta Anda untuk memberikan beberapa informasi tentang iklan.

MediationAdConfiguration juga memiliki metode getWatermark() untuk menampilkan string berenkode base64 yang mewakili gambar PNG. Gambar ini harus disusun dalam overlay transparan di iklan Anda. Hubungi Google untuk mendapatkan panduan tambahan tentang cara merender watermark. File ini berisi metadata tentang iklan yang ditampilkan untuk digunakan oleh penayang guna menentukan sumber iklan yang ditampilkan.

Untuk banner, Anda akan diminta untuk memberikan tampilan banner. Untuk iklan interstisial dan imbalan, Anda akan diminta untuk menerapkan metode show() guna menampilkan iklan pada waktu berikutnya. Sebagai praktik terbaik, sebaiknya buat class Anda yang melakukan pemuatan iklan juga bertanggung jawab untuk menerapkan metode iklan ini.

Berikut adalah contoh penerapan loadBannerAd(). Perhatikan bahwa penerapan adaptor Anda akan terlihat berbeda, karena adaptor Anda terintegrasi dengan SDK yang berbeda.

public final class SampleRtbAdapter extends RtbAdapter {
  ...

  @Override
  public void loadBannerAd(
      MediationBannerAdConfiguration adConfiguration,
      MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback> callback) {

      SampleBannerRenderer bannerRenderer =
          new SampleBannerRenderer(adConfiguration, callback);
      bannerRenderer.render();
    }
}

// Renders a banner ad, and forwards callbacks to the Google Mobile Ads SDK.
public class SampleBannerRenderer implements MediationBannerAd {
  private MediationBannerAdConfiguration adConfiguration;
  private final MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback> adLoadCallback;
  private AdView adView;
  private MediationBannerAdCallback callback;

  public SampleRtbBannerRenderer(
      MediationBannerAdConfiguration adConfiguration,
      MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback> adLoadCallback) {
    this.adConfiguration = adConfiguration;
    this.adLoadCallback = adLoadCallback;
  }

  public void render() {
    adView = new AdView(adConfiguration.getContext());
    adView.setAdSize(adConfiguration.getAdSize());
    // serverParameters are the parameters entered in the AdMob UI for your network.
    adView.setAdUnitId(adConfiguration.getServerParameters().getString("adUnitId"));

    // Map the callbacks from your SDK to Google's SDK.
    adView.setAdListener(new AdListener() {
      // See the next step for more information on callback mapping.
      // ...
    });

    // Get the bid response and watermark from the ad configuration and
    // pass the relevant information to your SDK.
    String ad = adConfiguration.getBidResponse();
    String watermark = adConfiguration.getWatermark();
    Bundle extras = new Bundle();
    extras.putString("bid", ad);
    extras.putString("watermark", watermark);
    AdRequest request = new AdRequest.Builder()
        .addNetworkExtrasBundle(AdMobAdapter.class, extras)
        .build();
    adView.loadAd(request);
  }

  // MediationBannerAd implementation

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

Meneruskan peristiwa siklus proses presentasi iklan

Tanggung jawab akhir adaptor adalah memberi tahu Google Mobile Ads SDK tentang peristiwa siklus proses presentasi, sehingga peristiwa tersebut dapat diteruskan ke penayang. Penayang mengharapkan callback ini pada waktu tertentu, apa pun jaringan iklan yang menayangkan iklan, sehingga callback ini harus dipanggil sebanyak mungkin, dan pada waktu yang tepat, sehingga Google Mobile Ads SDK dapat meneruskannya ke penayang.

Adaptor harus memanggil peristiwa berikut jika berlaku:

Umum untuk semua format
Metode	Kapan harus menelepon
reportAdClicked()	Iklan diklik.
reportAdImpression()	Iklan merender tayangan iklan.
onAdOpened()	Iklan menampilkan tampilan layar penuh.
onAdClosed()	Tampilan layar penuh iklan telah ditutup.
onAdLeftApplication()	Iklan menyebabkan pengguna keluar dari aplikasi.
Iklan reward
onRewarded()	Pengguna diberi reward.
Callback video (iklan reward dan native)
onVideoStarted()	Video iklan dimulai.
onVideoCompleted()	Video iklan selesai.

Adaptor mendapatkan objek MediationAdLoadCallback<MediationAdT, MediationAdCallbackT> kembali setelah memanggil mediationAdLoadCallback.onSuccess(). Adaptor diharapkan menyimpan objek ini dan menggunakannya untuk memanggil peristiwa presentasi yang terjadi di iklan Anda.

Biasanya, sebagian besar peristiwa ini didorong oleh SDK jaringan iklan Anda. Peran adaptor hanyalah untuk memetakan callback dari SDK jaringan iklan Anda ke Google Mobile Ads SDK.

Contoh berikut menunjukkan cara meneruskan callback dari pemroses iklan SDK ke Google Mobile Ads SDK:

adView.setAdListener(new AdListener() {
    public void onAdLoaded() {
        callback = adLoadCallback.onSuccess(SampleBannerRenderer.this);
    }

    public void onAdImpression() {
        if (callback != null) {
            callback.reportAdImpression();
        }
    }

    public void onAdFailedToLoad(LoadAdError adError) {
        adLoadCallback.onFailure("Error: " + adError.toString());
    }

    public void onAdClosed() {
        if (callback != null) {
            callback.onAdClosed();
        }
    }

    public void onAdOpened() {
        if (callback != null) {
            callback.onAdOpened();
            callback.reportAdClicked();
        }
    }

    public void onAdLeftApplication() {
        if (callback != null) {
            callback.onAdLeftApplication();
        }
    }
});

Aset yang diperlukan untuk pelacakan tayangan iklan native

Google Mobile Ads SDK mencatat tayangan untuk iklan native saat 1 piksel iklan terlihat. Jika SDK jaringan iklan Anda memerlukan aset tertentu untuk ditampilkan agar dapat merender tayangan yang valid, bidder Anda dapat menunjukkan aset native yang diperlukan ini dalam respons bid. Kemudian, Google Mobile Ads SDK akan memvalidasi bahwa aset native yang diperlukan ditampilkan sebelum merekam tayangan.

Lihat dokumentasi aset native yang diperlukan untuk mengetahui informasi selengkapnya tentang cara menentukan aset tambahan yang diperlukan dalam respons bid.

Poin Penting: Setiap tayangan iklan yang dirender tidak valid karena aset native tambahan yang diperlukan jaringan iklan Anda akan memengaruhi rasio peristiwa yang dapat ditagih untuk penayang tersebut.

Menampilkan error iklan

Untuk format layar penuh, seperti iklan interstisial dan reward, dalam callback muat yang berhasil, Anda akan memberikan implementasi MediationInterstitialAd atau MediationRewardedAd sehingga Google Mobile Ads SDK dapat meminta adaptor Anda untuk menampilkan iklan.

Google Mobile Ads SDK mengharapkan bahwa jika adaptor berhasil memuat iklan, iklan siap ditampilkan saat penayang meminta untuk menampilkannya. Artinya, setiap panggilan tampilan akan menghasilkan tayangan.

Namun, mungkin ada kasus ekstrem saat Anda tidak dapat menampilkan iklan. Jika Anda tidak dapat menampilkan iklan, panggil callback onAdFailedToShow() untuk membatalkan tayangan.

Tabel di bawah menunjukkan pengaruh callback presentasi terhadap perekaman tayangan iklan untuk format iklan layar penuh:

Telepon Balik	Hasil
onAdOpened()	Impression recorded
onAdFailedToShow()	Impression failure^1
Tidak satu pun di atas selama beberapa detik	Impression recorded

¹ Untuk tayangan yang gagal, jaringan iklan Anda tidak akan ditagih untuk tayangan tersebut, tetapi hal ini akan memengaruhi penyesuaian tarif peristiwa yang dapat ditagih. Lihat sinyal permintaan bid untuk informasi selengkapnya.

Contoh tiruan berikut menunjukkan siklus proses pemuatan/tampilan saat panggilan tampilan iklan dapat menyebabkan kegagalan.

final class SampleRtbAdapter extends RtbAdapter implements MediationRewardedAd {

 private MediationRewardedAdCallback callback;
 private RewardedAd rewardedAd;

 ...

  @Override
  public void loadRewardedAd(
      MediationRewardedAdConfiguration adConfiguration,
      final MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback> loadCallback) {

    // Load an ad. This mock example uses Google's SDK, but in practice
    // your adapter will load the ad using your ad network's SDK.
    RewardedAd.load(adConfiguration.getContext(),
        "ca-app-pub-3940256099942544/5224354917",
        new AdRequest.Builder().build(),
        new RewardedAdLoadCallback() {
          @Override
          public void onAdLoaded(@NonNull RewardedAd rewardedAd) {
            // When the ad loads, invoke the load success callback.
            callback = loadCallback.onSuccess(SampleRtbAdapter.this);
          }
        });
  }

  @Override
  public void showAd(Context context) {
    // In this mock example, your ad network requires an activity context, but
    // didn't receive one, making you unable to show the ad.
    if (!(context instanceof Activity)) {
      AdError error = new AdError(1, "Context must be an activity",
          "com.google.ads.mediation.sample");
      callback.onAdFailedToShow(error);
    }

    // This example shows Google SDK's callbacks, but it's likely your SDK
    // has similar presentation callbacks.
    rewardedAd.setFullScreenContentCallback(new FullScreenContentCallback() {
      @Override
      public void onAdShowedFullScreenContent() {
        // Your ad network SDK successfully showed the ad. Call onAdOpened().
        callback.onAdOpened();
      }

      @Override
      public void onAdFailedToShowFullScreenContent(AdError adError) {
        // Your ad network SDK failed to show the ad, invoke onAdFailedToShow.
        // In practice, you will map your SDK's error to an AdError.
        AdError error = new AdError(adError.getCode(), adError.getMessage(),
            adError.getDomain());
        callback.onAdFailedToShow(adError);
      }
    });


    rewardedAd.show((Activity) context, ...);
  }
}