Peristiwa kustom iklan banner

Prasyarat

Selesaikan penyiapan peristiwa kustom.

Meminta iklan banner

Saat item baris peristiwa kustom dijangkau dalam rantai mediasi waterfall, metode loadBanner:adConfiguration:completionHandler: dipanggil di nama kelas yang Anda berikan saat membuat peristiwa. Dalam kasus ini, metode tersebut berada di SampleCustomEvent, yang kemudian memanggil metode loadBanner:adConfiguration:completionHandler: di SampleCustomEventBanner.

Untuk meminta iklan banner, buat atau ubah kelas yang menerapkan GADMediationAdapter dan loadBanner:adConfiguration:completionHandler:. Jika yang memperluas GADMediationAdapter sudah ada, implementasikan loadBanner:adConfiguration:completionHandler: di sana. Selain itu, buat class baru untuk mengimplementasikan GADMediationBannerAd.

Dalam contoh peristiwa kustom, SampleCustomEvent menerapkan antarmuka GADMediationAdapter, lalu didelegasikan ke SampleCustomEventBanner.

Swift

import GoogleMobileAds

class SampleCustomEvent: NSObject, GADMediationAdapter {

  fileprivate var bannerAd: SampleCustomEventBanner?
  ...

  func loadBanner(
    for adConfiguration: GADMediationBannerAdConfiguration,
    completionHandler: @escaping GADMediationBannerLoadCompletionHandler
  ) {
    self.bannerAd = SampleCustomEventBanner()
    self.bannerAd?.loadBanner(
      for: adConfiguration, completionHandler: completionHandler)
  }
}

Objective-C

#import "SampleCustomEvent.h"

@implementation SampleCustomEvent
...

SampleCustomEventBanner *sampleBanner;

- (void)loadBannerForAdConfiguration:
            (GADMediationBannerAdConfiguration *)adConfiguration
                   completionHandler:(GADMediationBannerLoadCompletionHandler)
                                         completionHandler {
  sampleBanner = [[SampleCustomEventBanner alloc] init];
  [sampleBanner loadBannerForAdConfiguration:adConfiguration
                           completionHandler:completionHandler];
}

SampleCustomEventBanner bertanggung jawab atas tugas berikut:

• Memuat iklan banner dan memanggil Metode GADMediationBannerLoadCompletionHandler sekali pemuatan selesai.

• Mengimplementasikan protokol GADMediationBannerAd.

• Menerima dan melaporkan callback peristiwa iklan ke Google Mobile Ads SDK

Parameter opsional yang ditetapkan di UI AdMob adalah disertakan dalam konfigurasi iklan. Parameter ini dapat diakses melalui adConfiguration.credentials.settings[@"parameter"]. Parameter ini biasanya ID unit iklan yang diperlukan SDK jaringan iklan saat membuat instance objek iklan.

Swift

class SampleCustomEventBanner: NSObject, GADMediationBannerAd {
  /// The Sample Ad Network banner ad.
  var bannerAd: SampleBanner?

  /// The ad event delegate to forward ad rendering events to the Google Mobile Ads SDK.
  var delegate: GADMediationBannerAdEventDelegate?

  /// Completion handler called after ad load
  var completionHandler: GADMediationBannerLoadCompletionHandler?

  func loadBanner(
    for adConfiguration: GADMediationBannerAdConfiguration,
    completionHandler: @escaping GADMediationBannerLoadCompletionHandler
  ) {
    // Create the bannerView with the appropriate size.
    let adSize = adConfiguration.adSize
    bannerAd = SampleBanner(
      frame: CGRect(x: 0, y: 0, width: adSize.size.width, height: adSize.size.height))
    bannerAd?.delegate = self
    bannerAd?.adUnit = adConfiguration.credentials.settings["parameter"] as? String
    let adRequest = SampleAdRequest()
    adRequest.testMode = adConfiguration.isTestRequest
    self.completionHandler = completionHandler
    bannerAd?.fetchAd(adRequest)
  }
}

Objective-C

#import "SampleCustomEventBanner.h"

@interface SampleCustomEventBanner () <SampleBannerAdDelegate,
                                       GADMediationBannerAd> {
  /// The sample banner ad.
  SampleBanner *_bannerAd;

  /// The completion handler to call when the ad loading succeeds or fails.
  GADMediationBannerLoadCompletionHandler _loadCompletionHandler;

  /// The ad event delegate to forward ad rendering events to the Google Mobile
  /// Ads SDK.
  id <GADMediationBannerAdEventDelegate> _adEventDelegate;
}
@end

@implementation SampleCustomEventBanner

- (void)loadBannerForAdConfiguration:
            (GADMediationBannerAdConfiguration *)adConfiguration
                   completionHandler:(GADMediationBannerLoadCompletionHandler)
                                         completionHandler {
  __block atomic_flag completionHandlerCalled = ATOMIC_FLAG_INIT;
  __block GADMediationBannerLoadCompletionHandler originalCompletionHandler =
      [completionHandler copy];

  _loadCompletionHandler = ^id<GADMediationBannerAdEventDelegate>(
      _Nullable id<GADMediationBannerAd> ad, NSError *_Nullable error) {
    // Only allow completion handler to be called once.
    if (atomic_flag_test_and_set(&completionHandlerCalled)) {
      return nil;
    }

    id<GADMediationBannerAdEventDelegate> delegate = nil;
    if (originalCompletionHandler) {
      // Call original handler and hold on to its return value.
      delegate = originalCompletionHandler(ad, error);
    }

    // Release reference to handler. Objects retained by the handler will also
    // be released.
    originalCompletionHandler = nil;

    return delegate;
  };

  NSString *adUnit = adConfiguration.credentials.settings[@"parameter"];
  _bannerAd = [[SampleBanner alloc]
      initWithFrame:CGRectMake(0, 0, adConfiguration.adSize.size.width,
                               adConfiguration.adSize.size.height)];
  _bannerAd.adUnit = adUnit;
  _bannerAd.delegate = self;
  SampleAdRequest *adRequest = [[SampleAdRequest alloc] init];
  adRequest.testMode = adConfiguration.isTestRequest;
  [_bannerAd fetchAd:adRequest];
}

Apakah iklan berhasil diambil atau mengalami error, Anda akan memanggil GADMediationBannerLoadCompletionHandler. Jika berhasil, teruskan class yang mengimplementasikan GADMediationBannerAd dengan nilai nil untuk parameter {i>error<i}; jika terjadi kegagalan, teruskan error yang temukan.

Biasanya, metode ini diimplementasikan dalam callback dari SDK pihak ketiga yang diterapkan adaptor Anda. Untuk contoh ini, SDK Sampel memiliki SampleBannerAdDelegate dengan callback yang relevan:

Swift

func bannerDidLoad(_ banner: SampleBanner) {
  if let handler = completionHandler {
    delegate = handler(self, nil)
  }
}

func banner(
  _ banner: SampleBanner, didFailToLoadAdWith errorCode: SampleErrorCode
) {
  let error =
    SampleCustomEventUtilsSwift.SampleCustomEventErrorWithCodeAndDescription(
      code: SampleCustomEventErrorCodeSwift
        .SampleCustomEventErrorAdLoadFailureCallback,
      description:
        "Sample SDK returned an ad load failure callback with error code: \(errorCode)"
    )
  if let handler = completionHandler {
    delegate = handler(nil, error)
  }
}

Objective-C

- (void)bannerDidLoad:(SampleBanner *)banner {
  _adEventDelegate = _loadCompletionHandler(self, nil);
}

- (void)banner:(SampleBanner *)banner
    didFailToLoadAdWithErrorCode:(SampleErrorCode)errorCode {
  NSError *error = SampleCustomEventErrorWithCodeAndDescription(
      SampleCustomEventErrorAdLoadFailureCallback,
      [NSString stringWithFormat:@"Sample SDK returned an ad load failure "
                                 @"callback with error code: %@",
                                 errorCode]);
  _adEventDelegate = _loadCompletionHandler(nil, error);
}

GADMediationBannerAd mengharuskan penerapan properti UIView:

Swift

var view: UIView {
  return bannerAd ?? UIView()
}

Objective-C

- (nonnull UIView *)view {
  return _bannerAd;
}

Meneruskan peristiwa mediasi ke Google Mobile Ads SDK

Setelah Anda memanggil GADMediationBannerLoadCompletionHandler dengan iklan yang dimuat, objek delegasi GADMediationBannerAdEventDelegate yang ditampilkan kemudian dapat digunakan oleh adaptor untuk meneruskan kejadian presentasi dari SDK pihak ketiga ke Google Mobile Ads SDK. Class SampleCustomEventBanner mengimplementasikan Protokol SampleBannerAdDelegate untuk meneruskan callback dari iklan contoh jaringan Anda ke Google Mobile Ads SDK.

Peristiwa kustom harus meneruskan callback ini sebanyak mungkin memungkinkan, sehingga aplikasi Anda menerima peristiwa yang setara ini dari SDK Iklan Seluler. Berikut adalah contoh penggunaan callback:

Swift

func bannerWillLeaveApplication(_ banner: SampleBanner) {
  delegate?.reportClick()
}

Objective-C

- (void)bannerWillLeaveApplication:(SampleBanner *)banner {
  [_adEventDelegate reportClick];
}

Langkah ini menyelesaikan penerapan peristiwa khusus untuk iklan banner. Contoh lengkap tersedia di GitHub. Anda dapat menggunakannya dengan jaringan iklan yang sudah didukung atau mengubahnya untuk menampilkan iklan banner peristiwa khusus.