Пользовательские события баннерной рекламы

Предпосылки

Завершите настройку пользовательских событий .

Запросить баннерную рекламу

При достижении элемента строки пользовательского события в каскадной цепочке медиации вызывается метод loadBanner:adConfiguration:completionHandler: для имени класса, указанного вами при создании пользовательского события . В данном случае этот метод находится в SampleCustomEvent , который затем вызывает метод loadBanner:adConfiguration:completionHandler: в SampleCustomEventBanner .

Чтобы запросить баннерную рекламу, создайте или измените класс, реализующий GADMediationAdapter и loadBanner:adConfiguration:completionHandler: . Если класс, расширяющий GADMediationAdapter уже существует, реализуйте в нём loadBanner:adConfiguration:completionHandler: . Кроме того, создайте новый класс для реализации GADMediationBannerAd .

В нашем примере пользовательского события SampleCustomEvent реализует интерфейс GADMediationAdapter , а затем делегирует полномочия SampleCustomEventBanner .

Быстрый 

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 отвечает за следующие задачи:

  • Загрузка рекламного баннера и вызов метода GADMediationBannerLoadCompletionHandler после завершения загрузки.

  • Реализация протокола GADMediationBannerAd .

  • Получение и отправка обратных вызовов рекламных событий в Google Mobile Ads SDK

Необязательный параметр, определённый в пользовательском интерфейсе AdMob, включён в конфигурацию объявления. Доступ к нему можно получить через adConfiguration.credentials.settings[@"parameter"] . Обычно этот параметр представляет собой идентификатор рекламного блока, который SDK рекламной сети требует при создании экземпляра объекта объявления.

Быстрый 

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

Независимо от того, успешно ли загружено объявление или возникла ошибка, необходимо вызвать GADMediationBannerLoadCompletionHandler . В случае успеха передайте класс, реализующий GADMediationBannerAd , со значением nil для параметра error; в случае неудачи передайте возникшую ошибку.

Обычно эти методы реализуются внутри обратных вызовов стороннего 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)
  }
}

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 требует реализации свойства UIView :

Быстрый 

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

Objective-C 

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

Objective-C 

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

На этом реализация пользовательских событий для баннерной рекламы завершена. Полный пример доступен на GitHub . Вы можете использовать его с уже поддерживаемой рекламной сетью или модифицировать для отображения пользовательских событийных баннеров.