Zdarzenia niestandardowe dotyczące banerów reklamowych

Wymagania wstępne

Dokończ konfigurację zdarzeń niestandardowych.

Wysyłanie żądania banera reklamowego

Gdy w łańcuchu zapośredniczenia kaskadowego zostanie osiągnięta pozycja niestandardowego zdarzenia, wywoływana jest metoda loadBanner:adConfiguration:completionHandler: w przypadku nazwy klasy podanej podczas tworzenia zdarzenia niestandardowego. W tym przypadku metoda znajduje się w SampleCustomEvent, która następnie wywołuje metodę loadBanner:adConfiguration:completionHandler: w SampleCustomEventBanner.

Aby poprosić o baner reklamowy, utwórz lub zmodyfikuj klasę, która implementuje GADMediationAdapter i loadBanner:adConfiguration:completionHandler:. Jeśli klasa rozszerzająca GADMediationAdapter już istnieje, zaimplementuj loadBanner:adConfiguration:completionHandler: w niej. Utwórz też nową klasę, aby wdrożyć GADMediationBannerAd.

W naszym przykładzie zdarzenia niestandardowego SampleCustomEvent implementuje interfejs GADMediationAdapter, a następnie przekazuje wywołanie do SampleCustomEventBanner.

Swift

import GoogleMobileAds

class SampleCustomEvent: NSObject, MediationAdapter {

  fileprivate var bannerAd: SampleCustomEventBanner?
  ...

  func loadBanner(
    for adConfiguration: MediationBannerAdConfiguration,
    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 odpowiada za te zadania:

  • Wczytanie banera reklamowego i wywołanie metody GADMediationBannerLoadCompletionHandler po zakończeniu wczytywania.

  • Wdrażanie protokołu GADMediationBannerAd.

  • Otrzymywanie i zgłaszanie wywołań zwrotnych zdarzeń związanych z reklamami do pakietu SDK do reklam mobilnych Google

Parametr opcjonalny zdefiniowany w interfejsie AdMob jest uwzględniany w konfiguracji reklamy. Dostęp do parametru można uzyskać za pomocą funkcji adConfiguration.credentials.settings[@"parameter"]. Ten parametr jest zwykle identyfikatorem jednostki reklamowej, którego pakiet SDK sieci reklamowej wymaga podczas tworzenia instancji obiektu reklamy.

Swift

class SampleCustomEventBanner: NSObject, MediationBannerAd {
  /// 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: MediationBannerAdEventDelegate?

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

  func loadBanner(
    for adConfiguration: MediationBannerAdConfiguration,
    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];
}

Niezależnie od tego, czy reklama zostanie pobrana, czy wystąpi błąd, wywołasz funkcję GADMediationBannerLoadCompletionHandler. W przypadku powodzenia przekaż klasę, która implementuje GADMediationBannerAd z wartością nil parametru error. W przypadku niepowodzenia przekaż napotkany błąd.

Zazwyczaj te metody są wdrażane w wywołaniach zwrotnych z pakietu SDK firmy zewnętrznej, który implementuje Twój adapter. W tym przykładzie pakiet SDK zawiera element SampleBannerAdDelegate z odpowiednimi wywołaniami zwrotnymi:

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 wymaga wdrożenia usługi UIView:

Swift

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

Objective-C

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

Przekazywanie zdarzeń zapośredniczenia do pakietu SDK do reklam mobilnych Google

Po wywołaniu funkcji GADMediationBannerLoadCompletionHandler z załadowaną reklamą zwrócony obiekt delegata GADMediationBannerAdEventDelegate może być używany przez adapter do przekazywania zdarzeń wyświetlania z pakietu SDK innej firmy do pakietu SDK do reklam mobilnych Google. Klasa SampleCustomEventBanner implementuje protokół SampleBannerAdDelegate, aby przekazywać wywołania zwrotne z przykładowej sieci reklamowej do pakietu SDK do reklam mobilnych Google.

Ważne jest, aby Twoje zdarzenie niestandardowe przekazywało jak najwięcej tych wywołań zwrotnych, tak aby aplikacja otrzymywała równoważne zdarzenia z pakietu SDK do reklam mobilnych Google. Oto przykład użycia wywołań zwrotnych:

Swift

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

Objective-C

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

W ten sposób zakończysz wdrażanie zdarzeń niestandardowych w przypadku reklam banerowych. Pełny przykład jest dostępny w GitHub. Możesz go używać z obsługiwaną już siecią reklamową lub zmodyfikować go tak, aby wyświetlał banery reklamowe ze zdarzeniami niestandardowymi.