橫幅廣告自訂事件

必要條件

完成自訂事件設定。

要求橫幅廣告

在瀑布式中介鏈中到達自訂事件明細時，系統會根據您在建立自訂事件時提供的類別名稱，呼叫 loadBanner:adConfiguration:completionHandler: 方法。在本例中，該方法位於 SampleCustomEvent 中，然後會在 SampleCustomEventBanner 中呼叫 loadBanner:adConfiguration:completionHandler: 方法。

如要要求橫幅廣告，請建立或修改實作 GADMediationAdapter 和 loadBanner:adConfiguration:completionHandler: 的類別。如果已存在擴充 GADMediationAdapter 的類別，請在該類別中實作 loadBanner:adConfiguration:completionHandler:。此外，請建立新類別來實作 GADMediationBannerAd。

在自訂事件範例中，SampleCustomEvent 會實作 GADMediationAdapter 介面，然後將委派作業交給 SampleCustomEventBanner。

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

#import "SampleCustomEvent.h"

@implementation SampleCustomEvent
...

SampleCustomEventBanner *sampleBanner;

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

SampleCustomEventBanner 負責執行以下工作：

• 載入橫幅廣告，並在載入完成後叫用 GADMediationBannerLoadCompletionHandler 方法。

• 實作 GADMediationBannerAd 通訊協定。

• 接收並回報廣告事件回呼至 Google Mobile Ads SDK

廣告設定中會納入 AdMob UI 中定義的選用參數。您可以透過 adConfiguration.credentials.settings[@"parameter"] 存取此參數。這個參數通常是廣告聯播網 SDK 在例項化廣告物件時所需的廣告單元 ID。

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

#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];
}

無論廣告是否成功擷取或發生錯誤，您都會呼叫 GADMediationBannerLoadCompletionHandler。如果成功，請傳遞實作 GADMediationBannerAd 的類別，並為錯誤參數使用 nil 值；如果失敗，請傳遞遇到的錯誤。

一般來說，這些方法會在轉接程式實作的第三方 SDK 回呼中實作。在本例中，Sample SDK 具有含有相關回呼的 SampleBannerAdDelegate：

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

- (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 需要實作 UIView 屬性：

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

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

將中介服務事件轉送至 Google Mobile Ads SDK

在您使用已載入的廣告呼叫 GADMediationBannerLoadCompletionHandler 後，轉接程式就能使用傳回的 GADMediationBannerAdEventDelegate 委派物件，將第三方 SDK 的呈現事件轉送至 Google Mobile Ads SDK。SampleCustomEventBanner 類別會實作 SampleBannerAdDelegate 通訊協定，將來自範例廣告聯播網的回呼轉送至 Google Mobile Ads SDK。

請務必盡可能轉寄這些回呼，讓應用程式從 Google Mobile Ads SDK 接收這些對等事件。以下是使用回呼的範例：

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

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

這就完成了橫幅廣告的自訂事件實作。您可以在 GitHub 上找到完整範例。您可以將其與已支援的廣告聯播網搭配使用，也可以修改該廣告活動，以便顯示自訂事件橫幅廣告。