Doğal reklamlar özel etkinlikleri

Ön koşullar

Özel etkinlik ayarlarını tamamlayın.

Doğal reklam isteme

Özel etkinlik satır öğesine şelale uyumlulaştırma zincirinde ulaşıldığında, loadNativeAd:adConfiguration:completionHandler: yöntemi oluştururken belirttiğiniz sınıf adı bakın. Böyle durumlarda bu yöntem SampleCustomEvent içindedir ve bu durumda loadNativeAd:adConfiguration:completionHandler: yöntemi SampleCustomEventNative.

Doğal reklam istemek için şunu uygulayan bir sınıf oluşturun veya değiştirin: GADMediationAdapter ve loadNativeAd:adConfiguration:completionHandler:. Eğer GADMediationAdapter öğesini genişleten bir sınıf zaten var, uygulayın loadNativeAd:adConfiguration:completionHandler: burada. Ek olarak, GADMediationNativeAd öğesini uygulamak için yeni sınıf oluşturun.

Özel etkinlik örneğimizde, SampleCustomEvent uygular GADMediationAdapter arayüzünü kullanır ve ardından SampleCustomEventNative.

import GoogleMobileAds

class SampleCustomEvent: NSObject, GADMediationAdapter {

  fileprivate var nativeAd: SampleCustomEventNativeAd?

  func loadNativeAd(
    for adConfiguration: GADMediationNativeAdConfiguration,
    completionHandler: @escaping GADMediationNativeAdLoadCompletionHandler
  ) {
    self.nativeAd = SampleCustomEventNativeAd()
    self.nativeAd?.loadNativeAd(
      for: adConfiguration, completionHandler: completionHandler)
  }
}

#import "SampleCustomEvent.h"

@implementation SampleCustomEvent

SampleCustomEventNativeAd *sampleNativeAd;

- (void)loadNativeAdForAdConfiguration:
            (GADMediationNativeAdConfiguration *)adConfiguration
                     completionHandler:
                         (GADMediationNativeAdLoadCompletionHandler)
                             completionHandler {
  sampleNative = [[SampleCustomEventNativeAd alloc] init];
  [sampleNative loadNativeAdForAdConfiguration:adConfiguration
                             completionHandler:completionHandler];
}

SampleCustomEventNative" şu görevlerden sorumludur:

• Doğal reklam yükleniyor

• GADMediationNativeAd protokolü uygulanıyor.

• Google Mobile Ads SDK'sına reklam etkinliği geri çağırmaları alma ve raporlama

Ad Manager kullanıcı arayüzünde tanımlanan isteğe bağlı parametre: dahil edilir. Parametreye adConfiguration.credentials.settings[@"parameter"] Bu parametre genellikle bir reklam ağı SDK'sının aşağıdaki durumlarda gerekli olan reklam birimi tanımlayıcısını bir reklam nesnesini örneklendirmek için kullanılır.

class SampleCustomEventNativeAd: NSObject, GADMediationNativeAd {
  /// The Sample Ad Network native ad.
  var nativeAd: SampleNativeAd?

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

  /// Completion handler called after ad load
  var completionHandler: GADMediationNativeLoadCompletionHandler?

  func loadNativeAd(
    for adConfiguration: GADMediationNativeAdConfiguration,
    completionHandler: @escaping GADMediationNativeLoadCompletionHandler
  ) {
    let adLoader = SampleNativeAdLoader()
    let sampleRequest = SampleNativeAdRequest()

    // The Google Mobile Ads SDK requires the image assets to be downloaded
    // automatically unless the publisher specifies otherwise by using the
    // GADNativeAdImageAdLoaderOptions object's disableImageLoading property. If
    // your network doesn't have an option like this and instead only ever
    // returns URLs for images (rather than the images themselves), your adapter
    // should download image assets on behalf of the publisher. This should be
    // done after receiving the native ad object from your network's SDK, and
    // before calling the connector's adapter:didReceiveMediatedNativeAd: method.
    sampleRequest.shouldDownloadImages = true
    sampleRequest.preferredImageOrientation = NativeAdImageOrientation.any
    sampleRequest.shouldRequestMultipleImages = false
    let options = adConfiguration.options
    for loaderOptions: GADAdLoaderOptions in options {
      if let imageOptions = loaderOptions as? GADNativeAdImageAdLoaderOptions {
        sampleRequest.shouldRequestMultipleImages =
          imageOptions.shouldRequestMultipleImages
        // If the GADNativeAdImageAdLoaderOptions' disableImageLoading property is
        // YES, the adapter should send just the URLs for the images.
        sampleRequest.shouldDownloadImages = !imageOptions.disableImageLoading
      } else if let mediaOptions = loaderOptions
        as? GADNativeAdMediaAdLoaderOptions
      {
        switch mediaOptions.mediaAspectRatio {
        case GADMediaAspectRatio.landscape:
          sampleRequest.preferredImageOrientation =
            NativeAdImageOrientation.landscape
        case GADMediaAspectRatio.portrait:
          sampleRequest.preferredImageOrientation =
            NativeAdImageOrientation.portrait
        default:
          sampleRequest.preferredImageOrientation = NativeAdImageOrientation.any
        }
      }
    }
    // This custom event uses the server parameter to carry an ad unit ID, which
    // is the most common use case.
    adLoader.delegate = self
    adLoader.adUnitID =
      adConfiguration.credentials.settings["parameter"] as? String
    self.completionHandler = completionHandler
    adLoader.fetchAd(sampleRequest)
  }
}

#import "SampleCustomEventNativeAd.h"

@interface SampleCustomEventNativeAd () <SampleNativeAdDelegate,
                                         GADMediationNativeAd> {
  /// The sample native ad.
  SampleNativeAd *_nativeAd;

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

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

- (void)loadNativeAdForAdConfiguration:
            (GADMediationNativeAdConfiguration *)adConfiguration
                     completionHandler:(GADMediationNativeLoadCompletionHandler)
                                           completionHandler {
  __block atomic_flag completionHandlerCalled = ATOMIC_FLAG_INIT;
  __block GADMediationNativeLoadCompletionHandler originalCompletionHandler =
      [completionHandler copy];

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

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

  SampleNativeAdLoader *adLoader = [[SampleNativeAdLoader alloc] init];
  SampleNativeAdRequest *sampleRequest = [[SampleNativeAdRequest alloc] init];

  // The Google Mobile Ads SDK requires the image assets to be downloaded
  // automatically unless the publisher specifies otherwise by using the
  // GADNativeAdImageAdLoaderOptions object's disableImageLoading property. If
  // your network doesn't have an option like this and instead only ever returns
  // URLs for images (rather than the images themselves), your adapter should
  // download image assets on behalf of the publisher. This should be done after
  // receiving the native ad object from your network's SDK, and before calling
  // the connector's adapter:didReceiveMediatedNativeAd: method.
  sampleRequest.shouldDownloadImages = YES;

  sampleRequest.preferredImageOrientation = NativeAdImageOrientationAny;
  sampleRequest.shouldRequestMultipleImages = NO;
  sampleRequest.testMode = adConfiguration.isTestRequest;

  for (GADAdLoaderOptions *loaderOptions in adConfiguration.options) {
    if ([loaderOptions isKindOfClass:[GADNativeAdImageAdLoaderOptions class]]) {
      GADNativeAdImageAdLoaderOptions *imageOptions =
          (GADNativeAdImageAdLoaderOptions *)loaderOptions;
      sampleRequest.shouldRequestMultipleImages =
          imageOptions.shouldRequestMultipleImages;

      // If the GADNativeAdImageAdLoaderOptions' disableImageLoading property is
      // YES, the adapter should send just the URLs for the images.
      sampleRequest.shouldDownloadImages = !imageOptions.disableImageLoading;
    } else if ([loaderOptions
                   isKindOfClass:[GADNativeAdMediaAdLoaderOptions class]]) {
      GADNativeAdMediaAdLoaderOptions *mediaOptions =
          (GADNativeAdMediaAdLoaderOptions *)loaderOptions;
      switch (mediaOptions.mediaAspectRatio) {
        case GADMediaAspectRatioLandscape:
          sampleRequest.preferredImageOrientation =
              NativeAdImageOrientationLandscape;
          break;
        case GADMediaAspectRatioPortrait:
          sampleRequest.preferredImageOrientation =
              NativeAdImageOrientationPortrait;
          break;
        default:
          sampleRequest.preferredImageOrientation = NativeAdImageOrientationAny;
          break;
      }
    } else if ([loaderOptions isKindOfClass:[GADNativeAdViewAdOptions class]]) {
      _nativeAdViewAdOptions = (GADNativeAdViewAdOptions *)loaderOptions;
    }
  }

  // This custom event uses the server parameter to carry an ad unit ID, which
  // is the most common use case.
  NSString *adUnit = adConfiguration.credentials.settings[@"parameter"];
  adLoader.adUnitID = adUnit;
  adLoader.delegate = self;

  [adLoader fetchAd:sampleRequest];
}

Reklam başarılı bir şekilde getirildiğinde veya bir hatayla karşılaşıldığında GADMediationNativeAdLoadCompletionHandler araması yapar. Başarılı olmaları durumunda, nil değeriyle GADMediationNativeAd öğesini uygulayan sınıfı geç hata parametresi için; başarısız olması durumunda, kullandığınız hatayı karşılaşılır.

Genellikle bu yöntemler üçüncü taraf SDK'sı oluşturun. Bu örnekte, örnek SDK alakalı geri çağırmaları içeren bir SampleNativeAdDelegate içeriyor:

func adLoader(
  _ adLoader: SampleNativeAdLoader, didReceive nativeAd: SampleNativeAd
) {
  extraAssets = [
    SampleCustomEventConstantsSwift.awesomenessKey: nativeAd.degreeOfAwesomeness
      ?? ""
  ]

  if let image = nativeAd.image {
    images = [GADNativeAdImage(image: image)]
  } else {
    let imageUrl = URL(fileURLWithPath: nativeAd.imageURL)
    images = [GADNativeAdImage(url: imageUrl, scale: nativeAd.imageScale)]
  }
  if let mappedIcon = nativeAd.icon {
    icon = GADNativeAdImage(image: mappedIcon)
  } else {
    let iconURL = URL(fileURLWithPath: nativeAd.iconURL)
    icon = GADNativeAdImage(url: iconURL, scale: nativeAd.iconScale)
  }

  adChoicesView = SampleAdInfoView()
  self.nativeAd = nativeAd
  if let handler = completionHandler {
    delegate = handler(self, nil)
  }
}

func adLoader(
  _ adLoader: SampleNativeAdLoader,
  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)
  }
}

- (void)adLoader:(SampleNativeAdLoader *)adLoader
    didReceiveNativeAd:(SampleNativeAd *)nativeAd {
  if (nativeAd.image) {
    _images = @[ [[GADNativeAdImage alloc] initWithImage:nativeAd.image] ];
  } else {
    NSURL *imageURL = [[NSURL alloc] initFileURLWithPath:nativeAd.imageURL];
    _images = @[ [[GADNativeAdImage alloc] initWithURL:imageURL
                                                 scale:nativeAd.imageScale] ];
  }

  if (nativeAd.icon) {
    _icon = [[GADNativeAdImage alloc] initWithImage:nativeAd.icon];
  } else {
    NSURL *iconURL = [[NSURL alloc] initFileURLWithPath:nativeAd.iconURL];
    _icon = [[GADNativeAdImage alloc] initWithURL:iconURL
                                            scale:nativeAd.iconScale];
  }

  // The sample SDK provides an AdChoices view (SampleAdInfoView). If your SDK
  // provides image and click through URLs for its AdChoices icon instead of an
  // actual UIView, the adapter is responsible for downloading the icon image
  // and creating the AdChoices icon view.
  _adChoicesView = [[SampleAdInfoView alloc] init];
  _nativeAd = nativeAd;

  _adEventDelegate = _loadCompletionHandler(self, nil);
}

- (void)adLoader:(SampleNativeAdLoader *)adLoader
    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);
}

Doğal reklamları eşleştirme

Farklı SDK'ların, doğal reklamlar için kendi benzersiz biçimleri vardır. Birisi geri gelebilir "başlık" içeren nesneler bir diğeri ise "başlık". Ayrıca, gösterimleri ve süreci izlemek için kullanılan yöntemler tıklama sayısı SDK'dan SDK'ya değişiklik gösterebilir.

Bu sorunları gidermek için özel etkinlik, uyumlulaştırılmış SDK'sı varsa GADMediationNativeAd öğesini uygulayan bir sınıf kullanmalıdır. örneğin SampleCustomEventNativeAd, örneğin "map" uyumlulaştırılmış SDK'nın yerel reklam nesnesi Google Mobile Ads SDK'sının beklediği arayüzle eşleşecek şekilde olduğundan emin olun.

Şimdi her bir riskin uygulanmasına ilişkin ayrıntıları SampleCustomEventNativeAd

Eşlemelerinizi saklama

GADMediationNativeAd ürününün aşağıdaki özelliklere sahip belirli özellikleri uygulaması beklenir: diğer SDK'nın mülklerinden eşlenenleri:

var nativeAd: SampleNativeAd?

var headline: String? {
  return nativeAd?.headline
}

var images: [GADNativeAdImage]?

var body: String? {
  return nativeAd?.body
}

var icon: GADNativeAdImage?

var callToAction: String? {
  return nativeAd?.callToAction
}

var starRating: NSDecimalNumber? {
  return nativeAd?.starRating
}

var store: String? {
  return nativeAd?.store
}

var price: String? {
  return nativeAd?.price
}

var advertiser: String? {
  return nativeAd?.advertiser
}

var extraAssets: [String: Any]? {
  return [
    SampleCustomEventConstantsSwift.awesomenessKey:
      nativeAd?.degreeOfAwesomeness
      ?? ""
  ]
}

var adChoicesView: UIView?

var mediaView: UIView? {
  return nativeAd?.mediaView
}

/// Used to store the ad's images. In order to implement the
/// GADMediationNativeAd protocol, we use this class to return the images
/// property.
NSArray<GADNativeAdImage *> *_images;

/// Used to store the ad's icon. In order to implement the GADMediationNativeAd
/// protocol, we use this class to return the icon property.
GADNativeAdImage *_icon;

/// Used to store the ad's ad choices view. In order to implement the
/// GADMediationNativeAd protocol, we use this class to return the adChoicesView
/// property.
UIView *_adChoicesView;

- (nullable NSString *)headline {
  return _nativeAd.headline;
}

- (nullable NSArray<GADNativeAdImage *> *)images {
  return _images;
}

- (nullable NSString *)body {
  return _nativeAd.body;
}

- (nullable GADNativeAdImage *)icon {
  return _icon;
}

- (nullable NSString *)callToAction {
  return _nativeAd.callToAction;
}

- (nullable NSDecimalNumber *)starRating {
  return _nativeAd.starRating;
}

- (nullable NSString *)store {
  return _nativeAd.store;
}

- (nullable NSString *)price {
  return _nativeAd.price;
}

- (nullable NSString *)advertiser {
  return _nativeAd.advertiser;
}

- (nullable NSDictionary<NSString *, id> *)extraAssets {
  return
      @{SampleCustomEventExtraKeyAwesomeness : _nativeAd.degreeOfAwesomeness};
}

- (nullable UIView *)adChoicesView {
  return _adChoicesView;
}

- (nullable UIView *)mediaView {
  return _nativeAd.mediaView;
}

- (BOOL)hasVideoContent {
  return self.mediaView != nil;
}

Bazı uyumlulaştırılmış ağlar, Google Mobile Ads SDK'sı. GADMediationNativeAd protokolü, bir yöntem içerir Google Mobile Ads SDK'sının reklam öğelerinizden herhangi birini almak için kullandığı extraAssets adlı bu "ekstra" öğeler ekleyebilirsiniz.

Resim öğelerini eşleme

Resim öğelerini eşlemek, daha basit verileri eşlemeye kıyasla daha karmaşıktır NSString veya double gibi farklı türlerde. Resimler otomatik olarak indirilebilir veya URL değerleri olarak döndürülür. Piksel yoğunlukları da değişiklik gösterebilir.

Google Mobile Ads SDK'sı, bu ayrıntıları yönetmenize yardımcı olmak için GADNativeAdImage sınıf. Resim öğesi bilgileri (gerçek UIImage olup olmadığı) nesneleri veya yalnızca NSURL değerleri) Google Mobile Ads SDK'sına döndürülmelidir. bu sınıfı kullanıyorsunuz.

Haritacı sınıfının, bir GADNativeAdImage simge resmi:

if let image = nativeAd.image {
  images = [GADNativeAdImage(image: image)]
} else {
  let imageUrl = URL(fileURLWithPath: nativeAd.imageURL)
  images = [GADNativeAdImage(url: imageUrl, scale: nativeAd.imageScale)]
}

if (nativeAd.image) {
  _images = @[ [[GADNativeAdImage alloc] initWithImage:nativeAd.image] ];
} else {
  NSURL *imageURL = [[NSURL alloc] initFileURLWithPath:nativeAd.imageURL];
  _images = @[ [[GADNativeAdImage alloc] initWithURL:imageURL
                                               scale:nativeAd.imageScale] ];
}

Gösterim ve tıklama etkinlikleri

Hem Google Mobile Ads SDK'sının hem de uyumlulaştırılmış SDK'nın, gösterim veya tıklama gerçekleşir, ancak bu etkinlikleri yalnızca bir SDK'nın izlemesi gerekir. Orada bağlı olarak, özel etkinliklerin kullanabileceği iki farklı yaklaşımdır Uyumlulaştırılmış SDK, gösterimleri ve tıklamaları izlemeyi destekler.

Tıklamaları ve gösterimleri Google Mobile Ads SDK'sıyla izleme

Uyumlulaştırılmış SDK kendi gösterim ve tıklama izlemeyi gerçekleştirmez, ancak Google Mobile Ads SDK'sı, tıklamaları ve gösterimleri kaydetmeye yönelik yöntemler sunar. bu etkinlikleri takip edin ve bağdaştırıcıya bildirin. GADMediationNativeAd protokolü iki yöntem içerir: didRecordImpression: ve didRecordClickOnAssetWithName:view:viewController: ile birlikte özel etkinliklerin uyumlulaştırılmış yerel reklam nesnesinde karşılık gelen yöntemi çağırmak için uygulayın:

func didRecordImpression() {
  nativeAd?.recordImpression()
}

func didRecordClickOnAsset(
  withName assetName: GADUnifiedNativeAssetIdentifier,
  view: UIView,
  wController: UIViewController
) {
  nativeAd?.handleClick(on: view)
}

- (void)didRecordImpression {
  if (self.nativeAd) {
    [self.nativeAd recordImpression];
  }
}

- (void)didRecordClickOnAssetWithName:(GADUnifiedNativeAssetIdentifier)assetName
                                 view:(UIView *)view
                       viewController:(UIViewController *)viewController {
  if (self.nativeAd) {
    [self.nativeAd handleClickOnView:view];
  }
}

Çünkü GADMediationNativeAd parametresini uygulayan sınıf protokolü, Örnek SDK'nın yerel reklam nesnesine bir referans tutar. Bu nesne, bir tıklamayı veya gösterimi bildirmek için söz konusu nesnede uygun yöntemi. Lütfen didRecordClickOnAssetWithName:view:viewController: yöntemi tek bir parametre: alınan yerel reklam öğesine karşılık gelen View nesnesi tıklayın.

Uyumlulaştırılmış SDK ile tıklamaları ve gösterimleri izleme

Bazı uyumlulaştırılmış SDK'lar, tıklamaları ve gösterimleri kendi başlarına izlemeyi tercih edebilir. İçinde Bu durumda, handlesUserClicks ve aşağıdaki snippet'te gösterildiği gibi handlesUserImpressions yöntemleri. Geri dönerek YES, özel etkinliğin izleme sorumluluğunu alacağını belirtirsiniz bu etkinlikler gerçekleştiğinde Google Mobile Ads SDK'sını bilgilendirir.

Tıklama ve gösterim izlemeyi geçersiz kılan özel etkinlikler, Yerel reklamın görünümünü uyumlulaştırılmış SDK'lara iletmek için didRenderInView: mesajı yerel reklam nesnesini tanımlayın. Örnek Bu kılavuzun kod snippet'lerini içeren özel etkinlik örneği projemizden SDK "Bu yaklaşımı kullanmıyor" ancak dönüşüm gerçekleşirse özel etkinlik kodu aşağıdaki snippet'te gösterildiği gibi setNativeAdView:view: yöntemini çağırır:

func handlesUserClicks() -> Bool {
  return true
}
func handlesUserImpressions() -> Bool {
  return true
}

func didRender(
  in view: UIView, clickableAssetViews: [GADNativeAssetIdentifier: UIView],
  nonclickableAssetViews: [GADNativeAssetIdentifier: UIView],
  viewController: UIViewController
) {
  // This method is called when the native ad view is rendered. Here you would pass the UIView
  // back to the mediated network's SDK.
  self.nativeAd?.setNativeAdView(view)
}

- (BOOL)handlesUserClicks {
  return YES;
}

- (BOOL)handlesUserImpressions {
  return YES;
}

- (void)didRenderInView:(UIView *)view
       clickableAssetViews:(NSDictionary<GADNativeAssetIdentifier, UIView *> *)
                               clickableAssetViews
    nonclickableAssetViews:(NSDictionary<GADNativeAssetIdentifier, UIView *> *)
                               nonclickableAssetViews
            viewController:(UIViewController *)viewController {
  // This method is called when the native ad view is rendered. Here you would
  // pass the UIView back to the mediated network's SDK. Playing video using
  // SampleNativeAd's playVideo method
  [_nativeAd setNativeAdView:view];
}

Uyumlulaştırma etkinliklerini Google Mobile Ads SDK'sına yönlendirme

GADMediationNativeLoadCompletionHandler bir reklam yükleyerek elde edilen GADMediationNativeAdEventDelegate delegesi nesne, daha sonra bağdaştırıcı tarafından Google Mobile Ads SDK'sına üçüncü taraf SDK'sı eklemek için kullanılır.

Özel etkinliğinizin bu geri çağırmalardan mümkün olduğunca çoğunu yönlendirmesi Böylece uygulamanız, Google Ads'den bu eşdeğer etkinlikleri Mobile Ads SDK'sı. Aşağıda, geri çağırma işlevinin kullanımına dair bir örnek verilmiştir:

Böylece doğal reklamlar için özel etkinlik uygulaması tamamlanır. Tam örnek şurada kullanılabilir: GitHub'a gidin.