Ön koşullar
Özel etkinlik kurulumunu tamamlayın.
Yerel reklam isteme
Şelale uyumlulaştırma zincirinde özel etkinlik satır öğesine ulaşıldığında loadNativeAd:adConfiguration:completionHandler:
yöntemi, özel etkinlik oluştururken belirttiğiniz sınıf adında çağrılır. Bu durumda, söz konusu yöntem SampleCustomEvent
içindedir ve SampleCustomEventNative
içindeki loadNativeAd:adConfiguration:completionHandler:
yöntemini çağırır.
Yerel reklam istemek için GADMediationAdapter
ve loadNativeAd:adConfiguration:completionHandler:
'yi uygulayan bir sınıf oluşturun veya mevcut bir sınıfta değişiklik yapın. GADMediationAdapter
öğesini genişleten bir sınıf zaten varsa loadNativeAd:adConfiguration:completionHandler:
öğesini oraya uygulayın. Ayrıca, GADMediationNativeAd
özelliğini uygulamak için yeni bir sınıf oluşturun.
Özel etkinlik örneğimizde SampleCustomEvent
, GADMediationAdapter
arayüzünü uygular ve ardından SampleCustomEventNative
için yetki verir.
Swift
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) } }
Objective-C
#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ükleme
GADMediationNativeAd
protokolünü uygulamaGoogle Mobile Ads SDK'sına reklam etkinliği geri çağırma isteklerini alma ve raporlama
AdMob kullanıcı arayüzünde tanımlanan isteğe bağlı parametre, reklam yapılandırmasına dahil edilir.
Parametreye adConfiguration.credentials.settings[@"parameter"]
üzerinden erişilebilir. Bu parametre, genellikle reklam ağı SDK'sının bir reklam nesnesini başlatırken ihtiyaç duyduğu reklam birimi tanımlayıcısıdır.
Swift
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) } }
Objective-C
#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ıyla getirilirse veya bir hatayla karşılaşırsa GADMediationNativeAdLoadCompletionHandler
çağrısını yaparsınız. Başarılı olursa hata parametresi için nil
değeriyle GADMediationNativeAd
'ü uygulayan sınıfı iletin; başarısız olursa karşılaştığınız hatayı iletin.
Bu yöntemler genellikle, bağdaştırıcının uyguladığı üçüncü taraf SDK'dan gelen geri çağırma işlevlerinin içinde uygulanır. Bu örnekte, Örnek SDK'da alakalı geri çağırmalara sahip bir SampleNativeAdDelegate
bulunmaktadır:
Swift
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) } }
Objective-C
- (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 yerel reklamlar için kendine özgü biçimleri vardır. Örneğin, bir işlev "title" alanı içeren nesneler döndürebilirken başka bir işlev "headline" alanına sahip olabilir. Ayrıca, gösterimleri izlemek ve tıklamaları işlemek için kullanılan yöntemler SDK'ya göre değişiklik gösterebilir.
Bu sorunların çözülmesi için bir özel etkinlik, uyumlulaştırılmış SDK'sından bir yerel reklam nesnesi aldığında, uyumlulaştırılmış SDK'nın yerel reklam nesnesini Google Mobile Ads SDK'sının beklediği arayüzle eşleşecek şekilde "eşleştirmek" için GADMediationNativeAd
kullanan bir sınıf (ör. SampleCustomEventNativeAd
) kullanmalıdır.
Şimdi SampleCustomEventNativeAd
için uygulama ayrıntılarına daha yakından bakalım.
Eşlemelerinizi depolama
GADMediationNativeAd
yönergesinin, diğer SDK mülklerinden eşlenen belirli özellikleri uygulaması beklenir:
Swift
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 }
Objective-C
/// 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ı tarafından tanımlananların dışında ek öğeler sağlayabilir. GADMediationNativeAd
protokolü, Google Mobile Ads SDK'sının bu "ekstra" öğelerden herhangi birini haritalayıcınızdan almak için kullandığı extraAssets
adlı bir yöntemi içerir.
Resim öğelerini eşleme
Resim öğelerini eşlemek, NSString
veya double
gibi daha basit veri türlerini eşlemekten daha karmaşıktır. Resimler otomatik olarak indirilebilir veya URL değerleri olarak döndürülebilir. Piksel yoğunluğu 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ını sağlar. Resim öğesi bilgileri (gerçek UIImage
nesneleri veya yalnızca NSURL
değerleri olabilir) bu sınıf kullanılarak Google Mobile Ads SDK'sına döndürülmelidir.
Haritalayıcı sınıfı, simge resmini barındıracak bir GADNativeAdImage
oluşturma işlemini aşağıdaki şekilde gerçekleştirir:
Swift
if let image = nativeAd.image { images = [GADNativeAdImage(image: image)] } else { let imageUrl = URL(fileURLWithPath: nativeAd.imageURL) images = [GADNativeAdImage(url: imageUrl, scale: nativeAd.imageScale)] }
Objective-C
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 aracı SDK'nın bir gösterim veya tıklamanın ne zaman gerçekleştiğini bilmesi gerekir ancak bu etkinliklerin yalnızca bir SDK tarafından izlenmesi gerekir. Uyumlulaştırılmış SDK'nın gösterimleri ve tıklamaları izlemeyi destekleyip desteklemediğine bağlı olarak özel etkinliklerin kullanabileceği iki farklı yaklaşım vardır.
Tıklamaları ve gösterimleri Google Mobile Ads SDK'sıyla izleme
Uyumlulaştırılmış SDK kendi gösterim ve tıklama izlemesini gerçekleştirmez ancak tıklamaları ve gösterimleri kaydetme yöntemleri sağlarsa Google Mobile Ads SDK'sı bu etkinlikleri izleyebilir ve bağdaştırıcıyı bilgilendirebilir. GADMediationNativeAd
protokolü, özel etkinliklerin aracılı yerel reklam nesnesinde ilgili yöntemi çağırmak için uygulayabileceği iki yöntem içerir: didRecordImpression:
ve didRecordClickOnAssetWithName:view:viewController:
:
Swift
func didRecordImpression() { nativeAd?.recordImpression() } func didRecordClickOnAsset( withName assetName: GADUnifiedNativeAssetIdentifier, view: UIView, wController: UIViewController ) { nativeAd?.handleClick(on: view) }
Objective-C
- (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]; } }
GADMediationNativeAd
Protokolünü uygulayan sınıf, Örnek SDK'nın doğal reklam nesnesine referans sunduğundan, bir tıklama veya gösterimi bildirmek için bu nesnenin uygun yöntemini çağırabilir. didRecordClickOnAssetWithName:view:viewController:
yönteminin tek bir parametre aldığını unutmayın: tıklamayı alan yerel reklam öğesine karşılık gelen View
nesnesi.
Arabulucu SDK'sı ile tıklamaları ve gösterimleri izleme
Bazı aracı SDK'lar tıklamaları ve gösterimleri kendi başlarına izlemeyi tercih edebilir. Bu durumda, handlesUserClicks
ve handlesUserImpressions
yöntemlerini aşağıdaki snippet'te gösterildiği gibi uygulamanız gerekir. YES
döndürerek özel etkinliğin bu etkinlikleri izleme sorumluluğunu aldığını ve bu etkinlikler gerçekleştiğinde Google Mobile Ads SDK'sını bilgilendireceğini belirtirsiniz.
Tıklama ve gösterim izlemeyi geçersiz kılan özel etkinlikler, didRenderInView:
mesajını kullanarak yerel reklamın görünümünü uyumlulaştırılmış SDK'nın yerel reklam nesnesine iletebilir. Böylece uyumlulaştırılmış SDK gerçek izlemeyi yapabilir. Özel etkinlik örnek projemizdeki (bu kılavuzun kod snippet'lerinin alındığı) örnek SDK bu yaklaşımı kullanmaz ancak kullansaydı özel etkinlik kodu aşağıdaki snippet'te gösterildiği gibi setNativeAdView:view:
yöntemini çağırırdı:
Swift
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) }
Objective-C
- (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
Yüklenen bir reklamla GADMediationNativeLoadCompletionHandler
işlevini çağırdıysanız döndürülen GADMediationNativeAdEventDelegate
temsilci nesnesi, bağdaştırıcının üçüncü taraf SDK'sındaki sunum etkinliklerini Google Mobile Ads SDK'sına iletmesi için kullanılabilir.
Uygulamanızın Google Mobile Ads SDK'sından bu eşdeğer etkinlikleri alması için özel etkinliğinizin bu geri çağırmalardan mümkün olduğunca fazlasını iletmesi önemlidir. Geri çağırma işlevlerinin kullanımına dair bir örnek aşağıda verilmiştir:
Bu işlemle, doğal reklamlar için özel etkinliklerin uygulanması tamamlanır. Örneğin tamamını GitHub'da bulabilirsiniz.