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

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

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

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

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

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

हमारे कस्टम इवेंट के उदाहरण में, SampleCustomEvent, Adapter क्लास को बढ़ाता है और फिर इससे डेलिगेट के लिए अनुरोध करता है 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 क्लास लागू करना.

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

आम तौर पर, ये तरीके तीसरे पक्ष के उस 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 टूल के अपने यूनीक फ़ॉर्मैट होते हैं. एक वापस आ सकता है "टाइटल" वाले ऑब्जेक्ट फ़ील्ड में डाल सकते हैं, जबकि किसी अन्य में "headline" बनाना हो. इसके अलावा, इंप्रेशन और प्रोसेस को ट्रैक करने के लिए इस्तेमाल किए गए तरीके अलग-अलग SDK टूल को मिले क्लिक में अंतर हो सकता है.

इन अंतरों को ठीक करने की ज़िम्मेदारी UnifiedNativeAdMapper की है और मीडिएशन वाले SDK टूल के नेटिव विज्ञापन ऑब्जेक्ट को ज़रूरत के मुताबिक बनाना का इस्तेमाल करें. कस्टम इवेंट बनाने के लिए, इस क्लास को बढ़ाना चाहिए मीडिएशन 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 है लोकल वैरिएबल के तौर पर सेव होता है.

मैप की गई ऐसेट प्रॉपर्टी सेट करें

कंस्ट्रक्टर, SampleNativeAd ऑब्जेक्ट का इस्तेमाल, UnifiedNativeAdMapper.

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

Java

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

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

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

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

इन जानकारी को मैनेज करने में आपकी मदद के लिए, 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() तरीका. यह रहा एक स्निपेट 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 क्लास में दो मेथड शामिल हैं: recordImpression() और handleClick(). कस्टम इवेंट, इन मेथड को लागू करके, मीडिएट किए गए नेटिव विज्ञापन ऑब्जेक्ट पर संबंधित मेथड को कॉल कर सकते हैं:

Java

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

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

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

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

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

Java

setOverrideClickHandling(true);
setOverrideImpressionRecording(true);

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

इंप्रेशन और क्लिक को ट्रैक करने के लिए, हो सकता है कि मीडिएट किए गए SDK टूल को व्यू का ऐक्सेस चाहिए, ताकि ट्रैकिंग की सुविधा चालू की जा सके. कस्टम इवेंट को trackViews() तरीके को बदलना चाहिए और इसका इस्तेमाल, ट्रैक करने के लिए मीडिएट किए गए 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 की तरफ़ से इसी तरह के इवेंट मिल सकें मोबाइल विज्ञापन SDK टूल. यहां कॉलबैक का इस्तेमाल करने का एक उदाहरण दिया गया है:

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