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

اختيار النظام الأساسي: Android (إصدار تجريبي) جديد Android iOS

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

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

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

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

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

سواء تم جلب الإعلان بنجاح أو حدث خطأ، عليك استدعاء 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;
}

إعادة توجيه أحداث توسّط العرض الإعلاني إلى Google Mobile Ads SDK

بعد استدعاء GADMediationBannerLoadCompletionHandler باستخدام إعلان تم تحميله، يمكن للمحوّل بعد ذلك استخدام كائن التفويض GADMediationBannerAdEventDelegate الذي تم عرضه لإعادة توجيه أحداث العرض من حزمة تطوير البرامج (SDK) التابعة لجهة خارجية إلى Google Mobile Ads SDK. تنفيذ الفئة SampleCustomEventBanner بروتوكول SampleBannerAdDelegate لإعادة توجيه عمليات ردّ الاتصال من شبكة الإعلانات النموذجية إلى Google Mobile Ads SDK.

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

Swift

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

Objective-C

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

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