ज़रूरी शर्तें
कस्टम इवेंट का सेटअप पूरा करें.
नेटिव विज्ञापन का अनुरोध करें
वॉटरफ़ॉल मीडिएशन चेन में कस्टम इवेंट लाइन आइटम के पहुंचने पर,the loadNativeAd()
method को उस क्लास के नाम पर कॉल किया जाता है जो आपने कस्टम इवेंट बनाते समय दिया था. इस मामले में, वह तरीका SampleCustomEvent
में है, जिसके बादthe loadNativeAd()
method में SampleNativeCustomEventLoader
कॉल करेगा.
नेटिव विज्ञापन का अनुरोध करने के लिए, Adapter
को बढ़ाने वाली क्लास बनाएं या उसमें बदलाव करें, ताकि आप loadNativeAd()
को लागू कर सकें. अगर Adapter
को बढ़ाने वाली कोई क्लास पहले से मौजूद है, तो वहां loadNativeAd()
लागू करें. इसके अलावा, UnifiedNativeAdMapper
को लागू करने के लिए एक नई क्लास बनाएं.
कस्टम इवेंट के हमारे उदाहरण में, SampleCustomEvent
इसे लागू करता है
the Adapter
interface और फिर इसे
SampleNativeCustomEventLoader
में सौंपता है.
Java
package com.google.ads.mediation.sample.customevent; import com.google.android.gms.ads.mediation.Adapter; import com.google.android.gms.ads.mediation.MediationAdConfiguration; import com.google.android.gms.ads.mediation.MediationAdLoadCallback; import com.google.android.gms.ads.mediation.MediationNativeAdCallback; ... public class SampleCustomEvent extends Adapter { private SampleNativeCustomEventLoader nativeLoader; @Override public void loadNativeAd( @NonNull MediationNativeAdConfiguration adConfiguration, @NonNull MediationAdLoadCallback<UnifiedNativeAdMapper, MediationNativeAdCallback> callback) { nativeLoader = new SampleNativeCustomEventLoader(adConfiguration, callback); nativeLoader.loadAd(); } }
SampleNativeCustomEventLoader
इन टास्क के लिए ज़िम्मेदार हैं:
नेटिव विज्ञापन लोड हो रहा है
UnifiedNativeAdMapper
interfaceको लागू करनाGoogle Mobile Ads SDK पर विज्ञापन इवेंट कॉलबैक पाना और उन्हें रिपोर्ट करना
AdMob यूज़र इंटरफ़ेस (यूआई) में तय किया गया वैकल्पिक पैरामीटर,
विज्ञापन कॉन्फ़िगरेशन में शामिल है. इस पैरामीटर को
adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD)
से ऐक्सेस किया जा सकता है.
आम तौर पर, यह पैरामीटर एक विज्ञापन यूनिट आइडेंटिफ़ायर होता है. किसी विज्ञापन ऑब्जेक्ट को इंस्टैंशिएट करते समय, विज्ञापन नेटवर्क के SDK टूल की ज़रूरत होती है.
Java
package com.google.ads.mediation.sample.customevent; import com.google.android.gms.ads.mediation.Adapter; import com.google.android.gms.ads.mediation.MediationNativeAdConfiguration; import com.google.android.gms.ads.mediation.MediationAdLoadCallback; import com.google.android.gms.ads.mediation.MediationNativeAdCallback; ... public class SampleNativeCustomEventLoader extends SampleNativeAdListener { /** Configuration for requesting the native ad from the third-party network. */ private final MediationNativeAdConfiguration mediationNativeAdConfiguration; /** Callback that fires on loading success or failure. */ private final MediationAdLoadCallback<UnifiedNativeAdMapper, MediationNativeAdCallback> mediationAdLoadCallback; /** Callback for native ad events. */ private MediationNativeAdCallback nativeAdCallback; /** Constructor */ public SampleNativeCustomEventLoader( @NonNull MediationNativeAdConfiguration mediationNativeAdConfiguration, @NonNull MediationAdLoadCallback<MediationNativeAd, MediationNativeAdCallback> mediationAdLoadCallback) { this.mediationNativeAdConfiguration = mediationNativeAdConfiguration; this.mediationAdLoadCallback = mediationAdLoadCallback; } /** Loads the native ad from the third-party ad network. */ public void loadAd() { // Create one of the Sample SDK's ad loaders to request ads. Log.i("NativeCustomEvent", "Begin loading native ad."); SampleNativeAdLoader loader = new SampleNativeAdLoader(mediationNativeAdConfiguration.getContext()); // All custom events have a server parameter named "parameter" that returns // back the parameter entered into the UI when defining the custom event. String serverParameter = mediationNativeAdConfiguration .getServerParameters() .getString(MediationConfiguration .CUSTOM_EVENT_SERVER_PARAMETER_FIELD); Log.d("NativeCustomEvent", "Received server parameter."); loader.setAdUnit(serverParameter); // Create a native request to give to the SampleNativeAdLoader. SampleNativeAdRequest request = new SampleNativeAdRequest(); NativeAdOptions options = mediationNativeAdConfiguration.getNativeAdOptions(); if (options != null) { // If the NativeAdOptions' shouldReturnUrlsForImageAssets is true, the adapter should // send just the URLs for the images. request.setShouldDownloadImages(!options.shouldReturnUrlsForImageAssets()); request.setShouldDownloadMultipleImages(options.shouldRequestMultipleImages()); switch (options.getMediaAspectRatio()) { case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_LANDSCAPE: request.setPreferredImageOrientation(SampleNativeAdRequest.IMAGE_ORIENTATION_LANDSCAPE); break; case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_PORTRAIT: request.setPreferredImageOrientation(SampleNativeAdRequest.IMAGE_ORIENTATION_PORTRAIT); break; case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_SQUARE: case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_ANY: case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_UNKNOWN: default: request.setPreferredImageOrientation(SampleNativeAdRequest.IMAGE_ORIENTATION_ANY); } } loader.setNativeAdListener(this); // Begin a request. Log.i("NativeCustomEvent", "Start fetching native ad."); loader.fetchAd(request); } }
विज्ञापन फ़ेच हो गया है या उसमें कोई गड़बड़ी मिली है या नहीं, इसके आधार पर onSuccess()
या onFailure()
में से किसी एक को कॉल करें.
MediationNativeAd
को लागू करने वाली क्लास के इंस्टेंस में पास होने पर onSuccess()
कॉल किया जाता है.
आम तौर पर, इन तरीकों को तीसरे पक्ष के SDK टूल से कॉलबैक में लागू किया जाता है. यह SDK टूल, आपका अडैप्टर इस्तेमाल करता है. इस उदाहरण के लिए, सैंपल SDK टूल में काम के कॉलबैक के साथ एक SampleAdListener
है:
Java
@Override public void onNativeAdFetched(SampleNativeAd ad) { SampleUnifiedNativeAdMapper mapper = new SampleUnifiedNativeAdMapper(ad); mediationNativeAdCallback = mediationAdLoadCallback.onSuccess(mapper); } @Override public void onAdFetchFailed(SampleErrorCode errorCode) { mediationAdLoadCallback.onFailure(SampleCustomEventError.createSampleSdkError(errorCode)); }
नेटिव विज्ञापनों को मैप करें
नेटिव विज्ञापनों के लिए, अलग-अलग SDK टूल के अलग-अलग फ़ॉर्मैट होते हैं. उदाहरण के लिए, एक ऐसा ऑब्जेक्ट दिख सकता है जिसमें "टाइटल" फ़ील्ड होता है, जबकि दूसरे में "हेडलाइन" हो सकती है. इसके अलावा, इंप्रेशन को ट्रैक करने और क्लिक प्रोसेस करने के लिए इस्तेमाल किए जाने वाले तरीके एक SDK टूल से दूसरे में अलग-अलग हो सकते हैं.
इन अंतर को ठीक करने और मीडिएट किए गए SDK टूल के नेटिव विज्ञापन ऑब्जेक्ट को Google Mobile Ads SDK से उम्मीद के मुताबिक बनाए
जाने के लिए, UnifiedNativeAdMapper
की ज़िम्मेदारी होती है. कस्टम इवेंट को अपने मीडिएशन वाले SDK टूल के लिए खुद के मैपर बनाने के लिए, इस क्लास को बढ़ाना चाहिए. यहां हमारे कस्टम इवेंट प्रोजेक्ट से नमूने के तौर पर
विज्ञापन मैपर का उदाहरण दिया गया है:
Java
package com.google.ads.mediation.sample.customevent; import com.google.android.gms.ads.mediation.UnifiedNativeAdMapper; import com.google.android.gms.ads.nativead.NativeAd; ... public class SampleUnifiedNativeAdMapper extends UnifiedNativeAdMapper { private final SampleNativeAd sampleAd; public SampleUnifiedNativeAdMapper(SampleNativeAd ad) { sampleAd = ad; setHeadline(sampleAd.getHeadline()); setBody(sampleAd.getBody()); setCallToAction(sampleAd.getCallToAction()); setStarRating(sampleAd.getStarRating()); setStore(sampleAd.getStoreName()); setIcon( new SampleNativeMappedImage( ad.getIcon(), ad.getIconUri(), SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE)); setAdvertiser(ad.getAdvertiser()); List<NativeAd.Image> imagesList = new ArrayList<NativeAd.Image>(); imagesList.add(new SampleNativeMappedImage(ad.getImage(), ad.getImageUri(), SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE)); setImages(imagesList); if (sampleAd.getPrice() != null) { NumberFormat formatter = NumberFormat.getCurrencyInstance(); String priceString = formatter.format(sampleAd.getPrice()); setPrice(priceString); } Bundle extras = new Bundle(); extras.putString(SampleCustomEvent.DEGREE_OF_AWESOMENESS, ad.getDegreeOfAwesomeness()); this.setExtras(extras); setOverrideClickHandling(false); setOverrideImpressionRecording(false); setAdChoicesContent(sampleAd.getInformationIcon()); } @Override public void recordImpression() { sampleAd.recordImpression(); } @Override public void handleClick(View view) { sampleAd.handleClick(view); } // The Sample SDK doesn't do its own impression/click tracking, instead relies on its // publishers calling the recordImpression and handleClick methods on its native ad object. So // there's no need to pass a reference to the View being used to display the native ad. If // your mediated network does need a reference to the view, the following method can be used // to provide one. @Override public void trackViews(View containerView, Map<String, View> clickableAssetViews, Map<String, View> nonClickableAssetViews) { super.trackViews(containerView, clickableAssetViews, nonClickableAssetViews); // If your ad network SDK does its own impression tracking, here is where you can track the // top level native ad view and its individual asset views. } @Override public void untrackView(View view) { super.untrackView(view); // Here you would remove any trackers from the View added in trackView. } }
अब हम कंस्ट्रक्टर कोड को गहराई से समझते हैं.
मीडिएशन वाले नेटिव विज्ञापन ऑब्जेक्ट का रेफ़रंस दें
कंस्ट्रक्टर, SampleNativeAd
पैरामीटर को स्वीकार करता है. यह नेटिव विज्ञापन क्लास है, जिसका इस्तेमाल SDK टूल अपने नेटिव विज्ञापनों के लिए करता है. मैपर को मीडिएशन विज्ञापन के रेफ़रंस की ज़रूरत होती है, ताकि यह क्लिक और इंप्रेशन इवेंट पास कर सके. SampleNativeAd
को
लोकल वैरिएबल के तौर पर सेव किया जाता है.
मैप की गई ऐसेट प्रॉपर्टी सेट करें
कंस्ट्रक्टर, UnifiedNativeAdMapper
में एसेट की जानकारी अपने-आप भरने के लिए, SampleNativeAd
ऑब्जेक्ट का इस्तेमाल करता है.
इस स्निपेट को मीडिएशन वाले विज्ञापन की कीमत का डेटा मिलता है और इसका इस्तेमाल, मैपर की कीमत सेट करने के लिए किया जाता है:
Java
if (sampleAd.getPrice() != null) { NumberFormat formatter = NumberFormat.getCurrencyInstance(); String priceString = formatter.format(sampleAd.getPrice()); setPrice(priceString); }
इस उदाहरण में, मीडिएशन वाला विज्ञापन, कीमत को double
के तौर पर सेव करता है, जबकि
AdMob उसी ऐसेट के लिए String
का इस्तेमाल करता है. इस तरह के कन्वर्ज़न को हैंडल करने की ज़िम्मेदारी मैपर की होती है.
मैप इमेज एसेट
इमेज ऐसेट को मैप करना, double
या String
जैसे डेटा टाइप को मैप करने के मुकाबले ज़्यादा मुश्किल है. इमेज अपने-आप डाउनलोड हो सकती हैं या
यूआरएल वैल्यू के तौर पर दिखाई जा सकती हैं. इनके पिक्सल-टू-डीपीआई स्केल अलग-अलग हो सकते हैं.
इस जानकारी को मैनेज करने में आपकी मदद के लिए, Google Mobile Ads SDK NativeAd.Image
क्लास उपलब्ध कराता है. जिस तरह आपको मीडिएशन वाले नेटिव विज्ञापन को मैप करने के लिए, UnifiedNativeAdMapper
की सब-क्लास बनानी होती है उसी तरह आपको इमेज एसेट को मैप करते समय, NativeAd.Image
की एक सब-क्लास भी बनानी चाहिए.
यहां कस्टम इवेंट की SampleNativeMappedImage
क्लास का उदाहरण दिया गया है:
Java
public class SampleNativeMappedImage extends NativeAd.Image { private Drawable drawable; private Uri imageUri; private double scale; public SampleNativeMappedImage(Drawable drawable, Uri imageUri, double scale) { this.drawable = drawable; this.imageUri = imageUri; this.scale = scale; } @Override public Drawable getDrawable() { return drawable; } @Override public Uri getUri() { return imageUri; } @Override public double getScale() { return scale; } }
मैपर के आइकॉन इमेज एसेट को सेट करने के लिए, SampleNativeAdMapper
इस लाइन में अपनी मैप की गई इमेज क्लास का इस्तेमाल करता है:
Java
setIcon(new SampleNativeMappedImage(ad.getAppIcon(), ad.getAppIconUri(), SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE));
अतिरिक्त बंडल में फ़ील्ड जोड़ें
मीडिएशन वाले कुछ SDK टूल,AdMob नेटिव विज्ञापन फ़ॉर्मैट की एसेट के अलावा, अतिरिक्त एसेट भी देते हैं. UnifiedNativeAdMapper
क्लास में, setExtras()
वाला एक तरीका शामिल है. इसका इस्तेमाल, इन ऐसेट को पब्लिशर के पास करने के लिए किया जाता है. SampleNativeAdMapper
इसका इस्तेमाल, सैंपल SDK टूल की "डिग्री ऑफ़ शानदार" ऐसेट के लिए करता है:
Java
Bundle extras = new Bundle(); extras.putString(SampleCustomEvent.DEGREE_OF_AWESOMENESS, ad.getDegreeOfAwesomeness()); this.setExtras(extras);
पब्लिशर, NativeAd
क्लास के getExtras()
तरीके का इस्तेमाल करके, डेटा वापस ला सकते हैं.
AdChoices
आपके कस्टम इवेंट की ज़िम्मेदारी है कि वह UnifiedNativeAdMapper
पर setAdChoicesContent()
तरीके का इस्तेमाल करके, AdChoices आइकॉन उपलब्ध कराए. यहां SampleNativeAdMapper
का एक स्निपेट दिया गया है, जिसमें AdChoices आइकॉन देने का तरीका बताया गया है:
Java
public SampleNativeAdMapper(SampleNativeAd ad) { ... setAdChoicesContent(sampleAd.getInformationIcon()); }
इंप्रेशन और क्लिक इवेंट
Google Mobile Ads SDK और मीडिएशन वाले SDK टूल, दोनों को यह पता होना चाहिए कि इंप्रेशन या क्लिक कब होता है. हालांकि, इन इवेंट को ट्रैक करने के लिए सिर्फ़ एक ही SDK टूल को इसकी ज़रूरत होती है. कस्टम इवेंट दो अलग-अलग तरीकों का इस्तेमाल कर सकते हैं, जो इस बात पर निर्भर करते हैं कि मीडिएशन SDK अपने-आप इंप्रेशन और क्लिक को ट्रैक करने की सुविधा देता है या नहीं.
Google Mobile Ads SDK से क्लिक और इंप्रेशन ट्रैक करें
अगर मीडिएट किया गया SDK टूल अपना इंप्रेशन और क्लिक ट्रैकिंग नहीं करता, लेकिन
क्लिक और इंप्रेशन को रिकॉर्ड करने के तरीके उपलब्ध कराता है, तो Google Mobile Ads SDK इन इवेंट को ट्रैक करके अडैप्टर को सूचना दे सकता है.
UnifiedNativeAdMapper
interface इसमें दो तरीके शामिल हैं:
recordImpression()
और handleClick()
जिन
कस्टम इवेंट को मीडिएशन वाले नेटिव विज्ञापन ऑब्जेक्ट पर, मिलते-जुलते तरीके को कॉल करने के लिए लागू किया जा सकता है:
Java
@Override public void recordImpression() { sampleAd.recordImpression(); } @Override public void handleClick(View view) { sampleAd.handleClick(view); }
SampleNativeAdMapper
में, SDK टूल के नेटिव विज्ञापन ऑब्जेक्ट का रेफ़रंस होता है. इसलिए, यह क्लिक या इंप्रेशन की रिपोर्ट करने के लिए, उस ऑब्जेक्ट के लिए सही तरीके को कॉल कर सकता है. ध्यान दें कि handleClick()
तरीका सिर्फ़ एक पैरामीटर लेता है: View
ऑब्जेक्ट, उस नेटिव विज्ञापन एसेट से जुड़ा है जिस पर क्लिक किया गया था.
मीडिएशन वाले SDK टूल की मदद से, क्लिक और इंप्रेशन ट्रैक करें
ऐसा हो सकता है कि मीडिएशन वाले कुछ SDK टूल, क्लिक और इंप्रेशन को खुद ही ट्रैक करना पसंद करें. ऐसी स्थिति में, आपको अपने UnifiedNativeAdMapper
के कंस्ट्रक्टर में ये दो कॉल करके, डिफ़ॉल्ट क्लिक और इंप्रेशन ट्रैकिंग को बदलना चाहिए:
Java
setOverrideClickHandling(true); setOverrideImpressionRecording(true);
क्लिक और इंप्रेशन ट्रैकिंग को ओवरराइड करने वाले कस्टम इवेंट के लिए
Google मोबाइल विज्ञापन SDK को onAdClicked()
और onAdImpression()
इवेंट रिपोर्ट करना ज़रूरी है.
इंप्रेशन और क्लिक को ट्रैक करने के लिए, हो सकता है कि मीडिएशन वाले SDK टूल को ट्रैकिंग चालू करने के लिए, व्यू के ऐक्सेस की ज़रूरत हो. कस्टम इवेंट को trackViews()
तरीके को बदलना चाहिए. साथ ही, इसे ट्रैक करने के लिए मीडिएशन वाले SDK टूल को नेटिव विज्ञापन के व्यू को पास करना चाहिए. हमारे कस्टम इवेंट उदाहरण प्रोजेक्ट (जिससे इस गाइड के कोड स्निपेट लिए गए हैं) का नमूना SDK इस तरीके का इस्तेमाल नहीं करता है; लेकिन अगर
ऐसा हुआ है, तो कस्टम इवेंट कोड कुछ ऐसा दिखेगा:
Java
@Override public void trackViews(View containerView, Map<String, View> clickableAssetViews, Map<String, View> nonClickableAssetViews) { sampleAd.setNativeAdViewForTracking(containerView); }
अगर मीडिएशन वाले SDK टूल से, अलग-अलग एसेट को ट्रैक किया जा सकता है, तो यह
clickableAssetViews
में देखकर पता कर सकता है कि किन व्यू को क्लिक करने लायक बनाया जाना चाहिए. यह मैप, NativeAdAssetNames
में मौजूद एसेट के नाम के हिसाब से सेव किया जाता है. UnifiedNativeAdMapper
, इसके लिए एक untrackView()
तरीका देता है. कस्टम इवेंट, व्यू के किसी भी रेफ़रंस को रिलीज़ करने और उसे नेटिव विज्ञापन ऑब्जेक्ट से अलग करने के लिए, इसे बदल सकता है.
Google Mobile Ads SDK पर मीडिएशन इवेंट फ़ॉरवर्ड करना
MediationNativeAdCallback
दस्तावेज़ में वे सभी कॉलबैक देखे जा सकते हैं जो मीडिएशन के साथ काम करते हैं.
आपके कस्टम इवेंट से ज़्यादा से ज़्यादा कॉलबैक फ़ॉरवर्ड करने चाहिए, ताकि आपके ऐप्लिकेशन को Google Mobile Ads SDK से मिलते-जुलते इवेंट मिल सकें. यहां कॉलबैक इस्तेमाल करने का एक उदाहरण दिया गया है:
इससे नेटिव विज्ञापनों के लिए कस्टम इवेंट लागू करने की प्रोसेस पूरी हो जाती है. इसका पूरा उदाहरण GitHub पर उपलब्ध है.