नेटिव विज्ञापनों के कस्टम इवेंट

ज़रूरी शर्तें

कस्टम इवेंट सेटअप पूरा करें.

नेटिव विज्ञापन का अनुरोध करना

जब वॉटरफ़ॉल मीडिएशन चेन में कस्टम इवेंट लाइन आइटम पर पहुंचा जाता है, तब loadNativeAd() तरीके को उस क्लास के नाम पर कॉल किया जाता है जिसे आपने कस्टम इवेंट बनाते समय दिया था. इस मामले में, वह तरीका SampleCustomEvent में है, जो SampleNativeCustomEventLoader में loadNativeAd() तरीके को कॉल करता है.

नेटिव विज्ञापन का अनुरोध करने के लिए, ऐसी क्लास बनाएं या उसमें बदलाव करें जो Adapter को लागू करने के लिए loadNativeAd() को बढ़ाती हो. अगर Adapter को एक्सटेंड करने वाली कोई क्लास पहले से मौजूद है, तो उसमें loadNativeAd() लागू करें. इसके अलावा, UnifiedNativeAdMapper को लागू करने के लिए एक नई क्लास बनाएं.

कस्टम इवेंट के उदाहरण में, SampleCustomEvent Adapter क्लास को एक्सटेंड़ करता है और फिर SampleNativeCustomEventLoader को डिलीगेट करता है.

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 क्लास को लागू करना.

• Google Mobile Ads SDK में विज्ञापन इवेंट कॉलबैक पाने और उनकी रिपोर्टिंग करना.

Ad Manager के यूज़र इंटरफ़ेस में तय किया गया वैकल्पिक पैरामीटर, विज्ञापन कॉन्फ़िगरेशन में शामिल होता है. पैरामीटर को adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD) के ज़रिए ऐक्सेस किया जा सकता है. आम तौर पर, यह पैरामीटर एक विज्ञापन यूनिट आइडेंटिफ़ायर होता है. विज्ञापन नेटवर्क SDK टूल को विज्ञापन ऑब्जेक्ट को इंस्टैंशिएट करते समय, इसकी ज़रूरत होती है.

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() में से किसी एक को कॉल करना होगा. onSuccess() को उस क्लास के इंस्टेंस को पास करके कॉल किया जाता है जो MediationNativeAd को लागू करता है.

आम तौर पर, ये तरीके तीसरे पक्ष के उस SDK टूल के कॉलबैक में लागू किए जाते हैं जिसे आपका अडैप्टर लागू करता है. इस उदाहरण के लिए, सैंपल SDK टूल में काम के कॉलबैक के साथ SampleAdListener है:

@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 टूल में अलग-अलग हो सकते हैं.

UnifiedNativeAdMapper, इन अंतरों को मिलाने और Google Mobile Ads SDK के इंटरफ़ेस से मैच करने के लिए, मीडिएशन वाले SDK टूल के नेटिव विज्ञापन ऑब्जेक्ट को अडैप्ट करने के लिए ज़िम्मेदार है. कस्टम इवेंट को इस क्लास को एक्सटेंड़ करना चाहिए, ताकि वे अपने मीडिएटेड SDK टूल के हिसाब से अपने मैपर बना सकें. यहां हमारे उदाहरण वाले कस्टम इवेंट प्रोजेक्ट से, विज्ञापन मैपर का सैंपल दिया गया है:

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 ऑब्जेक्ट का इस्तेमाल करता है.

यह स्निपेट, मीडिएट किए गए विज्ञापन की कीमत का डेटा पाता है और इसका इस्तेमाल करके मैपर की कीमत सेट करता है:

if (sampleAd.getPrice() != null) {
    NumberFormat formatter = NumberFormat.getCurrencyInstance();
    String priceString = formatter.format(sampleAd.getPrice());
    setPrice(priceString);
}

इस उदाहरण में, मीडिएशन वाले विज्ञापन में कीमत को double के तौर पर सेव किया जाता है, जबकि Ad Manager उसी एसेट के लिए String का इस्तेमाल करता है. इस तरह के कन्वर्ज़न मैनेज करने की ज़िम्मेदारी मैपर की होती है.

इमेज ऐसेट को मैप करना

इमेज एसेट को मैप करना, double या String जैसे डेटा टाइप को मैप करने से ज़्यादा मुश्किल है. इमेज अपने-आप डाउनलोड हो सकती हैं या यूआरएल वैल्यू के तौर पर दिख सकती हैं. इनका पिक्सल-टू-डीपीआई स्केल भी अलग-अलग हो सकता है.

इन जानकारी को मैनेज करने में आपकी मदद करने के लिए, Google Mobile Ads SDK में NativeAd.Image क्लास उपलब्ध है. मीडिएशन वाले नेटिव विज्ञापन को मैप करने के लिए, आपको UnifiedNativeAdMapper का सबक्लास बनाना होता है. इसी तरह, इमेज ऐसेट को मैप करते समय, आपको NativeAd.Image का सबक्लास भी बनाना चाहिए.

यहां कस्टम इवेंट की SampleNativeMappedImage क्लास का उदाहरण दिया गया है:

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, मैपर की आइकॉन इमेज एसेट को सेट करने के लिए, इस लाइन में अपनी मैप की गई इमेज क्लास का इस्तेमाल करता है:

setIcon(new SampleNativeMappedImage(ad.getAppIcon(), ad.getAppIconUri(),
    SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE));

एक्सट्रा बंडल में फ़ील्ड जोड़ना

मीडिएट किए गए कुछ SDK टूल, Ad Manager के नेटिव विज्ञापन फ़ॉर्मैट में मौजूद एसेट के अलावा अन्य एसेट भी उपलब्ध कराते हैं. UnifiedNativeAdMapper क्लास में एक setExtras() तरीका शामिल होता है. इसका इस्तेमाल, पब्लिशर को ये ऐसेट भेजने के लिए किया जाता है. SampleNativeAdMapper, सैंपल SDK टूल की "शानदार" एसेट के लिए इसका इस्तेमाल करता है:

Bundle extras = new Bundle();
extras.putString(SampleCustomEvent.DEGREE_OF_AWESOMENESS, ad.getDegreeOfAwesomeness());
this.setExtras(extras);

पब्लिशर, NativeAd क्लास के getExtras() तरीके का इस्तेमाल करके डेटा हासिल कर सकते हैं.

AdChoices

आपका कस्टम इवेंट, UnifiedNativeAdMapper पर setAdChoicesContent() तरीके का इस्तेमाल करके, AdChoices आइकॉन उपलब्ध कराने के लिए ज़िम्मेदार है. यहां SampleNativeAdMapper का एक स्निपेट दिया गया है, जिसमें AdChoices आइकॉन जोड़ने का तरीका बताया गया है:

public SampleNativeAdMapper(SampleNativeAd ad) {
    ...
    setAdChoicesContent(sampleAd.getInformationIcon());
}

इंप्रेशन और क्लिक इवेंट

Google Mobile Ads SDK और मीडिएट किए गए SDK टूल, दोनों को यह पता होना चाहिए कि कोई इंप्रेशन या क्लिक कब होता है. हालांकि, इन इवेंट को सिर्फ़ एक SDK टूल को ट्रैक करना होता है. कस्टम इवेंट के लिए, दो अलग-अलग तरीके इस्तेमाल किए जा सकते हैं. यह इस बात पर निर्भर करता है कि मीडिएटेड SDK टूल, इंप्रेशन और क्लिक को अपने-आप ट्रैक करता है या नहीं.

Google Mobile Ads SDK की मदद से क्लिक और इंप्रेशन ट्रैक करना

अगर मीडिएटेड SDK टूल, अपने इंप्रेशन और क्लिक ट्रैकिंग को खुद नहीं करता है, लेकिन क्लिक और इंप्रेशन रिकॉर्ड करने के तरीके उपलब्ध कराता है, तो Google Mobile Ads SDK इन इवेंट को ट्रैक कर सकता है और अडैप्टर को सूचना दे सकता है. UnifiedNativeAdMapper क्लास में दो मेथड शामिल हैं: recordImpression() और handleClick(). कस्टम इवेंट, मीडिएट किए गए नेटिव विज्ञापन ऑब्जेक्ट पर उससे जुड़े मेथड को कॉल करने के लिए, इन्हें लागू कर सकते हैं:

@Override
public void recordImpression() {
  sampleAd.recordImpression();
}

@Override
public void handleClick(View view) {
  sampleAd.handleClick(view);
}

SampleNativeAdMapper में सैंपल SDK के नेटिव विज्ञापन ऑब्जेक्ट का रेफ़रंस होता है. इसलिए, यह क्लिक या इंप्रेशन की रिपोर्ट करने के लिए, उस ऑब्जेक्ट पर सही मेथड को कॉल कर सकता है. ध्यान दें कि handleClick() वाला तरीका एक ही पैरामीटर लेता है: क्लिक पाने वाली नेटिव विज्ञापन एसेट से जुड़ा View ऑब्जेक्ट.

मीडिएटेड एसडीके टूल की मदद से क्लिक और इंप्रेशन ट्रैक करना

कुछ मीडिएटेड SDK, क्लिक और इंप्रेशन को खुद ट्रैक करना पसंद कर सकते हैं. ऐसे में, आपको अपने UnifiedNativeAdMapper के कन्स्ट्रक्टर में ये दो कॉल करके, डिफ़ॉल्ट क्लिक और इंप्रेशन ट्रैकिंग को बदलना चाहिए:

setOverrideClickHandling(true);
setOverrideImpressionRecording(true);

क्लिक और इंप्रेशन ट्रैकिंग को बदलने वाले कस्टम इवेंट को, Google Mobile Ads SDK में onAdClicked() और onAdImpression() इवेंट की रिपोर्ट भेजनी ज़रूरी है.

इंप्रेशन और क्लिक को ट्रैक करने के लिए, हो सकता है कि मीडिएट किए गए SDK टूल को व्यू का ऐक्सेस चाहिए, ताकि ट्रैकिंग की सुविधा चालू की जा सके. कस्टम इवेंट को trackViews() तरीके को बदलना चाहिए और इसका इस्तेमाल, ट्रैक करने के लिए मीडिएट किए गए SDK टूल को नेटिव विज्ञापन का व्यू पास करने के लिए करना चाहिए. हमारे कस्टम इवेंट के उदाहरण वाले प्रोजेक्ट (जिससे इस गाइड के कोड स्निपेट लिए गए हैं) का सैंपल एसडीके टूल, इस तरीके का इस्तेमाल नहीं करता. हालांकि, अगर ऐसा होता, तो कस्टम इवेंट कोड कुछ ऐसा दिखता:

@Override
public void trackViews(View containerView,
    Map<String, View> clickableAssetViews,
    Map<String, View> nonClickableAssetViews) {
  sampleAd.setNativeAdViewForTracking(containerView);
}

अगर मीडिएटेड SDK, अलग-अलग ऐसेट को ट्रैक करने की सुविधा देता है, तो वह clickableAssetViews में जाकर यह देख सकता है कि किन व्यू को क्लिक किया जा सकता है. इस मैप को NativeAdAssetNames में ऐसेट के नाम से keyed किया गया है. UnifiedNativeAdMapper, untrackView() के हिसाब से एक तरीका उपलब्ध कराता है. कस्टम इवेंट, व्यू के किसी भी रेफ़रंस को रिलीज़ करने और उसे नेटिव विज्ञापन ऑब्जेक्ट से अलग करने के लिए, इस तरीके को बदल सकते हैं.

Google Mobile Ads SDK टूल को मीडिएशन इवेंट भेजना

आपको MediationNativeAdCallback दस्तावेज़ में, वे सभी कॉलबैक मिल सकते हैं जिनके साथ मीडिएशन काम करता है.

यह ज़रूरी है कि आपका कस्टम इवेंट, इनमें से ज़्यादा से ज़्यादा कॉलबैक फ़ॉरवर्ड करे, ताकि आपके ऐप्लिकेशन को Google Mobile Ads SDK से मिलते-जुलते इवेंट मिल सकें. कॉलबैक का इस्तेमाल करने का उदाहरण यहां दिया गया है:

इससे नेटिव विज्ञापनों के लिए कस्टम इवेंट लागू हो जाते हैं. पूरा उदाहरण, GitHub पर उपलब्ध है.