Zdarzenia niestandardowe dotyczące banerów reklamowych

Wymagania wstępne

Dokończ konfigurowanie zdarzeń niestandardowych.

Wysyłanie żądania banera reklamowego

Gdy element zamówienia zdarzenia niestandardowego zostanie osiągnięty w łańcuchu zapośredniczenia kaskadowego, metoda loadBanner:adConfiguration:completionHandler: jest wywoływana na nazwa klasy podana podczas tworzenia niestandardowej . W tym przypadku ta metoda jest w komórce SampleCustomEvent, która następnie wywołuje metody loadBanner:adConfiguration:completionHandler: w SampleCustomEventBanner

Aby wysłać żądanie banera reklamowego, utwórz lub zmodyfikuj klasę, która implementuje: GADMediationAdapter i loadBanner:adConfiguration:completionHandler:. Jeśli klasa, która rozszerza zakres GADMediationAdapter, już istnieje, wprowadź loadBanner:adConfiguration:completionHandler:. Dodatkowo utwórz nowej klasy do zaimplementowania GADMediationBannerAd.

W naszym przykładzie zdarzenia niestandardowego SampleCustomEvent implementuje interfejsu GADMediationAdapter, a następnie przekazuje 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 odpowiada za następujące zadania:

• Wczytanie banera reklamowego i wywołanie Metoda GADMediationBannerLoadCompletionHandler raz Wczytywanie zostało ukończone.

• Wdrażanie protokołu GADMediationBannerAd.

• Odbieranie i raportowanie wywołań zwrotnych zdarzeń reklamowych do pakietu SDK do reklam mobilnych Google

Opcjonalny parametr zdefiniowany w interfejsie Ad Managera to uwzględnionych w konfiguracji reklam. Dostęp do parametru można uzyskać za pomocą: adConfiguration.credentials.settings[@"parameter"] Ten parametr ma wartość zwykle jest to identyfikator jednostki reklamowej wymagany przez pakiet SDK sieci reklamowej utworzenie instancji obiektu reklamy.

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

Jeśli reklama została pobrana lub napotka błąd, wywołałby GADMediationBannerLoadCompletionHandler. Jeśli się uda, przekaż klasę, która implementuje funkcję GADMediationBannerAd z wartością nil dla parametru błędu; w przypadku niepowodzenia przekaż komunikat o błędzie napotkano problem.

Te metody są zwykle implementowane wewnątrz wywołań zwrotnych z funkcji pakietu SDK innej firmy wdrożonego przez adapter. W tym przykładzie Przykładowy pakiet SDK zawiera SampleBannerAdDelegate z odpowiednimi wywołaniami zwrotnymi:

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

Działanie GADMediationBannerAd wymaga zaimplementowania właściwości UIView:

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

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

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

Gdy wywołasz funkcję GADMediationBannerLoadCompletionHandler z załadowaną reklamą, zwrócony obiekt delegata GADMediationBannerAdEventDelegate może być następnie używane przez adapter do przekazywania zdarzeń prezentacji z pakietu SDK firmy zewnętrznej do pakiet SDK do reklam mobilnych Google. Klasa SampleCustomEventBanner implementuje metodę Protokół SampleBannerAdDelegate do przekazywania wywołań zwrotnych z przykładowej reklamy z pakietem SDK do reklam mobilnych Google.

Ważne jest, aby zdarzenie niestandardowe przekazuje jak najwięcej z tych wywołań zwrotnych by aplikacja otrzymywała te same zdarzenia z Google Pakiet SDK do reklam mobilnych. Oto przykład użycia wywołań zwrotnych:

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

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

Kończy się implementacja zdarzeń niestandardowych w przypadku banerów reklamowych. Pełny przykład jest dostępny na GitHub Możesz go używać w sieci reklamowej, która jest już obsługiwana, lub zmienić ją na aby wyświetlać niestandardowe banery reklamowe związane z zdarzeniami niestandardowymi.