Événements personnalisés pour les bannières

Prérequis

Configurez les événements personnalisés.

Demander une bannière

Lorsque la ligne d'insertion d'événement personnalisé est atteinte dans la chaîne de médiation en cascade, la méthode loadBanner:adConfiguration:completionHandler: est appelée sur le nom de classe que vous avez fourni lors de la création d'un événement personnalisé. Dans ce cas, cette méthode se trouve dans SampleCustomEvent, qui appelle ensuite la méthode loadBanner:adConfiguration:completionHandler: dans SampleCustomEventBanner.

Pour demander une bannière publicitaire, créez ou modifiez une classe qui implémente GADMediationAdapter et loadBanner:adConfiguration:completionHandler:. Si une classe qui étend GADMediationAdapter existe déjà, implémentez loadBanner:adConfiguration:completionHandler: dans cette classe. En outre, créez une classe pour implémenter GADMediationBannerAd.

Dans notre exemple d'événement personnalisé, SampleCustomEvent implémente l'interface GADMediationAdapter, puis délègue à 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 est responsable des tâches suivantes :

  • Chargement de la bannière publicitaire et appel d'une méthode GADMediationBannerLoadCompletionHandler une fois le chargement terminé.

  • Implémenter le protocole GADMediationBannerAd.

  • Réception et signalement des rappels d'événements d'annonces au SDK Google Mobile Ads.

Le paramètre facultatif défini dans l'UI Ad Manager est inclus dans la configuration de l'annonce. Le paramètre est accessible via adConfiguration.credentials.settings[@"parameter"]. Ce paramètre est généralement un identifiant de bloc d'annonces qu'un SDK de réseau publicitaire requiert lors de l'instanciation d'un objet d'annonce.

Swift

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

  /// The ad event delegate to forward ad rendering events to 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];
}

Que l'annonce soit récupérée avec succès ou qu'une erreur se produise, vous devez appeler GADMediationBannerLoadCompletionHandler. En cas de réussite, transmettez la classe qui implémente GADMediationBannerAd avec une valeur nil pour le paramètre d'erreur. En cas d'échec, transmettez l'erreur que vous avez rencontrée.

En général, ces méthodes sont implémentées dans des rappels du SDK tiers que votre adaptateur implémente. Pour cet exemple, le SDK Sample comporte un SampleBannerAdDelegate avec des rappels pertinents :

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 nécessite l'implémentation d'une propriété UIView :

Swift

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

Objective-C

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

Transférer les événements de médiation vers le SDK Google Mobile Ads

Une fois que vous avez appelé GADMediationBannerLoadCompletionHandler avec une annonce chargée, l'objet délégué GADMediationBannerAdEventDelegate renvoyé peut ensuite être utilisé par l'adaptateur pour transférer les événements de présentation du SDK tiers vers le SDK Google Mobile Ads. La classe SampleCustomEventBanner implémente le protocole SampleBannerAdDelegate pour transférer les rappels de l'exemple de réseau publicitaire vers le SDK Google Mobile Ads.

Il est important que votre événement personnalisé transmette le plus grand nombre possible de ces rappels, afin que votre application reçoive ces événements équivalents du SDK Google Mobile Ads. Voici un exemple d'utilisation des rappels :

Swift

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

Objective-C

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

L'implémentation des événements personnalisés pour les bannières publicitaires est terminée. L'exemple complet est disponible sur GitHub. Vous pouvez l'utiliser avec un réseau publicitaire déjà compatible ou le modifier pour afficher des bannières d'annonces d'événements personnalisés.