الأحداث المخصّصة لإعلانات البانر

المتطلبات الأساسية

أكمِل إعداد الأحداث المخصَّصة.

طلب إعلان بانر

عند الوصول إلى العنصر الخاص بالحدث المخصّص في سلسلة التوسّط للعرض الإعلاني بدون انقطاع، يتمّ استدعاء الأسلوب loadBanner:adConfiguration:completionHandler: على اسم الفئة الذي قدّمته عند إنشاء حدث مخصّص. وفي هذه الحالة، تلك الطريقة هي في 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

  • تلقّي استدعاءات أحداث الإعلانات وإعداد تقارير عنها إلى حزمة "SDK لإعلانات Google على الأجهزة الجوّالة"

المعلمة الاختيارية المحددة في واجهة مستخدم "مدير الإعلانات" هي مضمّنة في إعدادات الإعلان. يمكن الوصول إلى المعلمة من خلال 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 لمَعلمة الخطأ. وفي حال تعذُّر التنفيذ، استخدم الخطأ الذي واجهته.

يتم عادةً تنفيذ هذه الطرق داخل وظائف الاستدعاء من حزمة SDK التابعة لجهة خارجية التي ينفّذها المحوِّل. في هذا المثال، نموذج حزمة SDK لدى SampleBannerAdDelegate مع استدعاءات ذات صلة:

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

إعادة توجيه أحداث التوسّط إلى "SDK لإعلانات Google على الأجهزة الجوّالة"

بعد استدعاء GADMediationBannerLoadCompletionHandler باستخدام إعلان محمّل، يمكن لمحوِّل البيانات استخدام GADMediationBannerAdEventDelegate المفوَّض المُعاد لإعادة توجيه أحداث العرض من حزمة SDK التابعة لجهة خارجية إلى "حزمة SDK لإعلانات Google على الأجهزة الجوّالة". تنفِّذ فئة SampleCustomEventBanner بروتوكول SampleBannerAdDelegate لإعادة توجيه عمليات تسجيل الإحالات الناجحة من نموذج الشبكة الإعلانية إلى حزمة "SDK لإعلانات Google على الأجهزة الجوّالة".

من المهم أن يعيد توجيه الحدث المخصّص أكبر عدد ممكن من عمليات تسجيل الإحالات الناجحة هذه، لكي يتلقّى تطبيقك هذه الأحداث المماثلة من حزمة SDK لإعلانات Google على الأجهزة الجوّالة. إليك مثال على استخدام عمليات معاودة الاتصال:

Swift

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

Objective-C

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

وبذلك، تكون قد أكملت تنفيذ الأحداث المخصّصة لإعلانات البانر. يتوفّر المثال الكامل على GitHub. يمكنك استخدامه مع شبكة إعلانات متوافقة أو تعديلها إلى عرض إعلانات بانر للأحداث المخصّصة