Benutzerdefinierte Ereignisse für Anzeigen mit Prämie

Plattform auswählen: Android iOS Android (Legacy)

Vorbereitung

Schließen Sie die Einrichtung benutzerdefinierter Ereignisse ab.

Anzeige mit Prämie anfordern

Wenn die Werbebuchung für das benutzerdefinierte Ereignis in der abfolgebasierten Vermittlungskette erreicht wird, wird die Methode „loadRewarded:adConfiguration:completionHandler:“ für den Klassennamen aufgerufen, den Sie beim Erstellen eines benutzerdefinierten Ereignisses angegeben haben. In diesem Fall befindet sich diese Methode in SampleCustomEvent, wodurch dann die Methode loadRewarded:adConfiguration:completionHandler: in SampleCustomEventRewarded aufgerufen wird.

Wenn Sie eine Anzeige mit Prämie anfordern möchten, erstellen oder ändern Sie eine Klasse, die GADMediationAdapter und loadRewarded:adConfiguration:completionHandler: implementiert. Wenn bereits eine Klasse vorhanden ist, die GADMediationAdapter erweitert, implementieren Sie loadRewarded:adConfiguration:completionHandler: dort. Erstellen Sie außerdem eine neue Klasse, um GADMediationRewardedAd zu implementieren.

In unserem Beispiel für ein benutzerdefiniertes Ereignis implementiert SampleCustomEvent die Schnittstelle GADMediationAdapter und delegiert dann an SampleCustomEventRewarded.

Swift

import GoogleMobileAds

class SampleCustomEvent: NSObject, MediationAdapter {

  fileprivate var rewardedAd: SampleCustomEventRewarded?
  ...

  func loadRewarded(
    for adConfiguration: MediationRewardedAdConfiguration,
    completionHandler: @escaping GADMediationRewardedLoadCompletionHandler
  ) {
    self.rewardedAd = SampleCustomEventRewarded()
    self.rewardedAd?.loadRewarded(
      for: adConfiguration, completionHandler: completionHandler)
  }
}

Objective-C

#import "SampleCustomEvent.h"

@implementation SampleCustomEvent
...

SampleCustomEventRewarded *sampleRewarded;

- (void)loadRewardedForAdConfiguration:
            (GADMediationRewardedAdConfiguration *)adConfiguration
                     completionHandler:
                         (GADMediationRewardedLoadCompletionHandler)
                             completionHandler {
  sampleRewarded = [[SampleCustomEventRewarded alloc] init];
  [sampleRewarded loadRewardedForAdConfiguration:adConfiguration
                               completionHandler:completionHandler];
}

SampleCustomEventRewarded ist für die folgenden Aufgaben verantwortlich:

  • Anzeige mit Prämie wird geladen.

  • Implementierung des GADMediationRewardedAd-Protokolls.

  • Empfangen und Melden von Callbacks für Anzeigenereignisse an Google Mobile Ads SDK.

Der optionale Parameter, der in der AdMob-Benutzeroberfläche definiert ist, ist in der Anzeigenkonfiguration enthalten. Auf den Parameter kann über adConfiguration.credentials.settings[@"parameter"] zugegriffen werden. Dieser Parameter ist in der Regel eine Anzeigenblock-ID, die ein Werbenetzwerk-SDK beim Instanziieren eines Anzeigenobjekts benötigt.

Swift

class SampleCustomEventRewarded: NSObject, MediationRewardedAd {
  /// The Sample Ad Network rewarded ad.
  var nativeAd: SampleRewarded?

  /// The ad event delegate to forward ad rendering events to Google Mobile Ads SDK.
  var delegate: MediationRewardedAdEventDelegate?

  /// Completion handler called after ad load.
  var completionHandler: GADMediationRewardedLoadCompletionHandler?

  func loadRewarded(
    for adConfiguration: MediationRewardedAdConfiguration,
    completionHandler: @escaping GADMediationRewardedLoadCompletionHandler
  ) {
    rewarded = SampleRewarded.init(
      adUnitID: adConfiguration.credentials.settings["parameter"] as? String)
    rewarded?.delegate = self
    let adRequest = SampleAdRequest()
    adRequest.testMode = adConfiguration.isTestRequest
    self.completionHandler = completionHandler
    rewarded?.fetchAd(adRequest)
  }
}

Objective-C

#import "SampleCustomEventRewarded.h"

@interface SampleCustomEventRewarded () <SampleRewardedAdDelegate,
                                         GADMediationRewardedAd> {
  /// The sample rewarded ad.
  SampleRewarded *_rewardedAd;

  /// The completion handler to call when the ad loading succeeds or fails.
  GADMediationRewardedLoadCompletionHandler _loadCompletionHandler;

  /// The ad event delegate to forward ad rendering events to Google Mobile Ads SDK.
  id <GADMediationRewardedAdEventDelegate> _adEventDelegate;
}
@end

- (void)loadRewardedAdForAdConfiguration:(GADMediationRewardedAdConfiguration *)adConfiguration
                       completionHandler:
                           (GADMediationRewardedLoadCompletionHandler)completionHandler {
  __block atomic_flag completionHandlerCalled = ATOMIC_FLAG_INIT;
  __block GADMediationRewardedLoadCompletionHandler originalCompletionHandler =
      [completionHandler copy];

  _loadCompletionHandler = ^id<GADMediationRewardedAdEventDelegate>(
      _Nullable id<GADMediationRewardedAd> ad, NSError *_Nullable error) {
    // Only allow completion handler to be called once.
    if (atomic_flag_test_and_set(&completionHandlerCalled)) {
      return nil;
    }

    id<GADMediationRewardedAdEventDelegate> 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"];
  _rewardedAd = [[SampleRewardedAd alloc] initWithAdUnitID:adUnit];
  _rewardedAd.delegate = self;
  SampleAdRequest *adRequest = [[SampleAdRequest alloc] init];
  adRequest.testMode = adConfiguration.isTestRequest;
  [_rewardedAd fetchAd:adRequest];
}

Unabhängig davon, ob die Anzeige erfolgreich abgerufen wird oder ein Fehler auftritt, rufen Sie GADMediationRewardedLoadCompletionHandler auf. Übergeben Sie im Erfolgsfall die Klasse, die GADMediationRewardedAd mit einem nil-Wert für den Fehlerparameter implementiert. Übergeben Sie im Fehlerfall den aufgetretenen Fehler.

In der Regel werden diese Methoden in Callbacks des Drittanbieter-SDKs implementiert, das Ihr Adapter implementiert. In diesem Beispiel hat das Beispiel-SDK ein SampleRewardedAdDelegate mit relevanten Callbacks:

Swift

func rewardedDidLoad(_ interstitial: SampleRewarded) {
  if let handler = completionHandler {
    delegate = handler(self, nil)
  }
}

func rewarded(
  rewarded: SampleRewarded, didFailToLoadAdWith errorCode: SampleErrorCode
) {
  let error =
    SampleCustomEventUtils.SampleCustomEventErrorWithCodeAndDescription(
      code: SampleCustomEventErrorCode
        .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)rewardedDidLoad:(SampleRewarded *)rewarded {
  _adEventDelegate = _loadCompletionHandler(self, nil);
}

- (void)rewarded:(SampleInterstitial *)rewarded
    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);
}

Für GADMediationrewardedAd muss eine present(viewController:)-Methode implementiert werden, um die Anzeige einzublenden:

Swift

func present(from viewController: UIViewController) {
  if let rewarded = rewarded, rewarded.isRewardedLoaded {
    rewarded.show()
  }
}

Objective-C

- (void)presentFromViewController:(UIViewController *)viewController {
  if ([_rewardedAd isRewardedLoaded]) {
    [_rewardedAd show];
  } else {
    NSError *error = SampleCustomEventErrorWithCodeAndDescription(
        SampleCustomEventErrorAdNotLoaded,
        [NSString stringWithFormat:
                      @"The rewarded ad failed to present because the ad was not loaded."]);
    [_adEventDelegate didFailToPresentWithError:error]
  }
}

Vermittlungsereignisse an Google Mobile Ads SDK weiterleiten

Nachdem Sie GADMediationRewardedLoadCompletionHandler mit einer geladenen Anzeige aufgerufen haben, kann der Adapter das zurückgegebene GADMediationRewardedAdEventDelegate-Delegatobjekt verwenden, um Präsentationsereignisse vom Drittanbieter-SDK an Google Mobile Ads SDK weiterzuleiten. Die Klasse SampleCustomEventRewarded implementiert das Protokoll SampleRewardedAdDelegate, um Callbacks vom Beispiel-Werbenetzwerk an Google Mobile Ads SDK weiterzuleiten.

Es ist wichtig, dass Ihr benutzerdefiniertes Ereignis so viele dieser Callbacks wie möglich weiterleitet, damit Ihre App diese entsprechenden Ereignisse von Google Mobile Ads SDK empfängt. Hier ein Beispiel für die Verwendung von Callbacks:

Swift

func rewardedAdDidPresent(_ rewarded: SampleRewardedAd) {
  delegate?.willPresentFullScreenVideo()
  delegate?.didStartVideo()
}

func rewardedAdUserDidEarnReward(_ rewarded: SampleRewardedAd) {
  AdReward aReward = AdReward("", rewarded)
  delegate.didRewardUser()
}

Objective-C

- (void)rewardedAdDidPresent:(SampleRewardedAd *)rewardedAd {
  [_adEventDelegate willPresentFullScreenView];
  [_adEventDelegate didStartVideo];
}

- (void)rewardedAd:(nonnull SampleRewardedAd *)rewardedAd
    userDidEarnReward:(NSUInteger)reward {
  GADAdReward *aReward = [[GADAdReward alloc]
      initWithRewardType:@""
            rewardAmount:[NSDecimalNumber numberWithUnsignedInt:reward]];
  [_adEventDelegate didRewardUserWithReward];
}

Damit ist die Implementierung benutzerdefinierter Ereignisse für Anzeigen mit Prämie abgeschlossen. Das vollständige Beispiel ist auf GitHub verfügbar. Sie können ihn mit einem bereits unterstützten Werbenetzwerk verwenden oder ihn so anpassen, dass benutzerdefinierte Ereignis-Anzeigen mit Prämie ausgeliefert werden.