אירועים בהתאמה אישית במודעות באנר

דרישות מוקדמות

משלימים את הגדרת האירועים בהתאמה אישית.

שליחת בקשה להצגת מודעת באנר

כשמגיעים לפריט האירוע המותאם אישית בשרשרת תהליך בחירת הרשת ב-Waterfall, מתבצעת קריאה ל-method‏ loadBanner:adConfiguration:completionHandler: עם שם הכיתה שסיפקתם בזמן יצירת האירוע המותאם אישית. במקרה הזה, ה-method הזה הוא ב-SampleCustomEvent, ואז קוראת השיטה loadBanner:adConfiguration:completionHandler: SampleCustomEventBanner.

כדי לבקש מודעת באנר, צריך ליצור או לשנות מחלקה שמממשת GADMediationAdapter וגם loadBanner:adConfiguration:completionHandler: אם כבר יש כיתה שמרחיבה את GADMediationAdapter, מטמיעים את loadBanner:adConfiguration:completionHandler: בה. בנוסף, יוצרים מחלקה חדשה להטמיע את GADMediationBannerAd.

בדוגמה של האירוע המותאם אישית, SampleCustomEvent הטמעות את הממשק GADMediationAdapter ואז להעניק גישה אל SampleCustomEventBanner

Swift

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

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.

• קבלת קריאות חזרה (callbacks) של אירועי מודעות ב-Google Mobile Ads SDK ודיווח עליהן

הפרמטר האופציונלי שמוגדר בממשק המשתמש של Ad Manager הוא שכלולות בהגדרת המודעה. אפשר לגשת לפרמטר דרך adConfiguration.credentials.settings[@"parameter"] הפרמטר הזה בדרך כלל מזהה יחידת מודעות שנדרש ל-SDK של רשת מודעות, יצירת אובייקט של מודעה.

Swift

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

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 עבור פרמטר השגיאה; במקרה של כשל, מעבירים את השגיאה המערכת נתקלה בבעיה.

בדרך כלל, השיטות האלה מיושמות בתוך קריאות חזרה (callbacks) מ-SDK של צד שלישי שהמתאם מטמיע. לצורך הדוגמה הזו, ערכת ה-SDK לדוגמה כולל SampleBannerAdDelegate עם קריאה חוזרת (callback) רלוונטית:

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, צריך להטמיע את המאפיין UIView:

Swift

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

Objective-C

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

העברת אירועי תהליך בחירת הרשת (Mediation) אל Google Mobile Ads SDK

אחרי שהתקשרת אל GADMediationBannerLoadCompletionHandler עם מודעה שנטענה, לאחר מכן, אובייקט ה-מיוצג באמצעות GADMediationBannerAdEventDelegate שהוחזר יכול להיות משמש את המתאם להעברת אירועי מצגת מה-SDK של הצד השלישי אל Google Mobile Ads SDK. הכיתה SampleCustomEventBanner מיישמת את הפרוטוקול SampleBannerAdDelegate כדי להעביר קריאות חזרה מרשת המודעות לדוגמה אל Google Mobile Ads SDK.

חשוב שהאירוע בהתאמה אישית יעביר כמה שיותר מהקריאות החוזרות האלה כדי שהאפליקציה שלך תקבל את האירועים המקבילים האלה Mobile Ads SDK. דוגמה לשימוש בקריאות חזרה (callbacks):

Swift

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

Objective-C

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

הושלמה ההטמעה של אירועים מותאמים אישית במודעות באנר. הדוגמה המלאה זמינה ב-GitHub. אפשר להשתמש בפרמטר הזה עם רשת מודעות שכבר נתמכת, או לשנות את הערך שמופיע בה להציג מודעות באנר מותאמות אישית לאירוע.