बिडिंग अडैप्टर का डेवलपमेंट

यह गाइड उन विज्ञापन नेटवर्क के लिए है जो Google मीडिएशन में रीयल-टाइम बिडिंग (आरटीबी) में हिस्सा लेने के लिए, बिडिंग अडैप्टर बनाना चाहते हैं. अगर आप पब्लिशर हैं, तो पब्लिशर मीडिएशन के निर्देश देखें.

बिडिंग अडैप्टर, इंटिग्रेशन का क्लाइंट-साइड हिस्सा होता है. अडैप्टर की मदद से, आपके विज्ञापन नेटवर्क SDK टूल को Google Mobile Ads SDK टूल के साथ कम्यूनिकेट करने की सुविधा मिलती है. इससे, बिडर की ओर से दिखाए जाने वाले विज्ञापन लोड किए जा सकते हैं.

बिडिंग की सुविधा ठीक से काम करे, इसके लिए आपके अडैप्टर को शुरू करने, सिग्नल इकट्ठा करने, विज्ञापन लोड करने, और विज्ञापन लाइफ़साइकल इवेंट को रिले करने की ज़रूरत होगी. इस गाइड में, हम आपको बताएंगे कि इन कार्रवाइयों को मैनेज करने के लिए, आपके अडैप्टर को कैसे लागू किया जाना चाहिए.

बिडिंग अडैप्टर का वर्कफ़्लो

डेटा लेयर में इवेंट बनाने की प्रोसेस

किसी अडैप्टर के अनुरोध-जवाब-रेंडरिंग लाइफ़साइकल के बारे में पूरी जानकारी यहां दी गई है:

अडैप्टर की यह ज़िम्मेदारी होती है कि वह वर्कफ़्लो के इन हिस्सों को मैनेज करे:

  • चौथा से सातवां चरण: अपने अडैप्टर को शुरू करें और शुरू करने की प्रोसेस पूरी होने के बाद, Google Mobile Ads SDK टूल को फिर से कॉल करें.

  • 10 से 13 चरण: आरटीबी अनुरोध में हिस्सा लेने के लिए, बिडर को भेजे जाने वाले सिग्नल को अपने विज्ञापन नेटवर्क के SDK टूल से इकट्ठा करें और उन्हें Google Mobile Ads SDK टूल पर भेजें.

  • 18 से 21 चरण: अगर बिडिंग करने वाला आपका सिस्टम, जीतने वाली बिड दिखाता है, तो बिडिंग करने वाले सिस्टम के जवाब के हिसाब से विज्ञापन लोड करें. लोड होने के बाद, Google Mobile Ads SDK को सूचना दें कि विज्ञापन लोड हो गया है.

  • 23वां और उसके बाद का चरण: जब आपका विज्ञापन दिख रहा हो, तो Google Mobile Ads SDK टूल को इंप्रेशन और क्लिक इवेंट के साथ-साथ, विज्ञापन के प्रज़ेंटेशन लाइफ़साइकल के दौरान होने वाले अन्य विज्ञापन इवेंट की सूचना दें.

बिडिंग अडैप्टर लागू करना

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

getSDKVersionInfo()

यहां आपको अपने SDK टूल का वर्शन डालना होगा. यह वर्शन, OpenRTB रिक्वेस्ट के हिस्से के तौर पर आपके बिडर को भेजा जाता है.

इस तरीके के लिए, आपको VersionInfo दिखाना होगा. नीचे दिए गए उदाहरण में बताया गया है कि अपने SDK टूल के स्ट्रिंग वर्शन को VersionInfo. में कैसे बदला जा सकता है

@Override
public VersionInfo getSDKVersionInfo() {
  // Get your SDK's version as a string. E.g. "1.2.3"
  // String versionString = YourSdk.getVersion();
  String splits[] = versionString.split("\\.");
  if (splits.length >= 3) {
      int major = Integer.parseInt(splits[0]);
      int minor = Integer.parseInt(splits[1]);
      int micro = Integer.parseInt(splits[2]);
      return new VersionInfo(major, minor, micro);
   }

   String logMessage = String.format("Unexpected SDK version format: %s." +
           "Returning 0.0.0 for SDK version.", sdkVersion);
   Log.w(TAG, logMessage);
   return new VersionInfo(0, 0, 0);
}

getVersionInfo()

यहां आपको अपने अडैप्टर का वर्शन बताना होगा. यह वर्शन, OpenRTB रिक्वेस्ट के हिस्से के तौर पर आपके बिडर को भेजा जाता है.

Google के ओपन सोर्स और वर्शन वाले अडैप्टर, अडैप्टर के वर्शन के लिए चार अंकों का स्कीम इस्तेमाल करते हैं. हालांकि, VersionInfo में सिर्फ़ तीन अंक इस्तेमाल किए जा सकते हैं. इस समस्या को हल करने के लिए, हमारा सुझाव है कि पैच वर्शन में आखिरी दो अंक जोड़ें, जैसा कि यहां दिखाया गया है.

@Override
public VersionInfo getVersionInfo() {
  // Get your adapters's version as a string. E.g. "1.2.3.0"
  String versionString = BuildConfig.VERSION_NAME;
  String splits[] = versionString.split("\\.");
  if (splits.length >= 4) {
      int major = Integer.parseInt(splits[0]);
      int minor = Integer.parseInt(splits[1]);
      int micro = Integer.parseInt(splits[2]) * 100 + Integer.parseInt(splits[3]);
      return new VersionInfo(major, minor, micro);
    }

    String logMessage = String.format("Unexpected adapter version format: %s." +
                "Returning 0.0.0 for adapter version.", versionString);
    Log.w(TAG, logMessage);
    return new VersionInfo(0, 0, 0);
}

initialize()

टाइम आउट: 30 सेकंड

initialize() तरीका, आपके अडैप्टर में सबसे पहले कॉल किया जाने वाला तरीका है. इसे हर सेशन में सिर्फ़ एक बार कॉल किया जाता है. इस तरीके से, आपको MediationConfiguration ऑब्जेक्ट की एक सूची मिलती है. यह सूची, इस ऐप्लिकेशन में मौजूद उन प्लेसमेंट की पूरी सूची दिखाती है जिन्हें आपके विज्ञापन नेटवर्क के लिए कॉन्फ़िगर किया गया है. हर प्लेसमेंट के क्रेडेंशियल को पार्स करने के लिए, इस सूची को लूप किया जा सकता है. साथ ही, SDK टूल को शुरू करने के लिए, उसमें काम का डेटा पास किया जा सकता है.

जब आपका SDK टूल शुरू हो जाए और विज्ञापन अनुरोध पाने के लिए तैयार हो जाए, तो InitializationCompleteCallback के onInitializationSucceeded() तरीके को लागू करें. इस कॉलबैक को ऐप्लिकेशन पब्लिशर को भेजा जाता है, ताकि वे विज्ञापन लोड करना शुरू कर सकें.

@Override
public void initialize(Context context,
    InitializationCompleteCallback initializationCompleteCallback,
    List<MediationConfiguration> mediationConfigurations) {
  // Initialize your ad network's SDK.
  ...

  // Invoke the InitializationCompleteCallback once initialization completes.
  initializationCompleteCallback.onInitializationSucceeded();
}

collectSignals()

टाइम आउट: 1 सेकंड

जब भी पब्लिशर किसी विज्ञापन का अनुरोध करता है, तो आपके RtbAdapter का एक नया इंस्टेंस बन जाता है और collectSignals() का तरीका लागू हो जाता है. RtbAdapter के इस इंस्टेंस का इस्तेमाल, विज्ञापन के अनुरोध, जवाब, और विज्ञापन के रेंडरिंग लाइफ़साइकल के दौरान किया जाएगा. collectSignals() तरीके की मदद से, आपका अडैप्टर डिवाइस से सिग्नल भेज सकता है, ताकि उन्हें OpenRTB अनुरोध में बिडर को भेजा जा सके.

collectSignals() को बैकग्राउंड थ्रेड पर कॉल किया जाता है. Google Mobile Ads SDK, बिडिंग में हिस्सा लेने वाले सभी अडैप्टर से एक साथ सिग्नल मांगता है. कृपया इस दौरान, यूज़र इंटरफ़ेस (यूआई) थ्रेड पर कॉल सीमित रखें और सम्मान के साथ बातचीत करें. सिग्नल इकट्ठा करने के लिए, आपके अडैप्टर या SDK टूल को जो भी ज़्यादा काम करना है उसे initialize() तरीके से किया जाना चाहिए और उसे कैश मेमोरी में सेव किया जाना चाहिए.

सिग्नल तैयार होने के बाद, एन्क्रिप्ट किए गए सिग्नल के साथ onSuccess() कॉलबैक को कॉल करें.

लागू करने का उदाहरण:

@Override
public void collectSignals(RtbSignalData rtbSignalData,
                           SignalCallbacks signalCallbacks) {
  String signals = YourSdk.getSignals();
  signalCallbacks.onSuccess(signals);
}

अगर आपका अडैप्टर सिग्नल इकट्ठा नहीं कर पाता है, तो signalCallbacks.onFailure() को कॉल करें. साथ ही, उस गड़बड़ी की जानकारी देने वाली स्ट्रिंग दें जो हुई है.

विज्ञापन लोड करने के तरीके लागू करना

टाइम आउट: 10 सेकंड

अगर आपका बिडर, जीतने वाली बिड दिखाता है, तो Google Mobile Ads SDK टूल, जीतने वाले विज्ञापन को लोड करने के लिए आपके अडैप्टर को कॉल करता है. साथ ही, आपके बिडर से मिला वह डेटा भी आपको भेजता है जिसकी ज़रूरत आपके SDK टूल को उस विज्ञापन को लोड करने के लिए होती है.

लोड करने का सटीक तरीका, इस बात पर निर्भर करता है कि यह अनुरोध किस विज्ञापन फ़ॉर्मैट के लिए है:

विज्ञापन फ़ॉर्मैट लोड करने का तरीका
बैनर loadBannerAd()
मध्यवर्ती loadInterstitialAd()
इनाम दिया गया loadRewardedAd()

आपके अडैप्टर के साथ काम करने वाले विज्ञापन फ़ॉर्मैट के लिए, ये तरीके लागू करें.

लोड करने के तरीके को यूज़र इंटरफ़ेस (यूआई) थ्रेड पर, अडैप्टर के उसी इंस्टेंस पर कॉल किया जाता है जिससे आपने सिग्नल दिए थे. इस तरीके से, आपको ये पैरामीटर मिलते हैं:

  • MediationAdConfiguration, जिसमें ऐसे पैरामीटर होते हैं जिनकी ज़रूरत आपके SDK टूल को, विजेता बिड के लिए विज्ञापन लोड करने के लिए होती है. जैसे, बिड रिस्पॉन्स और AdMob यूज़र इंटरफ़ेस में कॉन्फ़िगर किए गए पब्लिशर के क्रेडेंशियल.

  • MediationAdLoadCallback ऑब्जेक्ट का इस्तेमाल, Google Mobile Ads SDK को यह सूचना देने के लिए किया जाता है कि लोडिंग पूरी हो गई है या नहीं.

जब आपका SDK टूल विज्ञापन लोड कर ले, तब mediationAdLoadCallback.onSuccess() को कॉल करें. अगर विज्ञापन लोड नहीं हो पाता है, तो उस गड़बड़ी की जानकारी देने वाली स्ट्रिंग के साथ mediationAdLoadCallback.onFailure() को कॉल करें.

mediationAdLoadCallback.onSuccess() तरीके के लिए, आपको ऐसा ऑब्जेक्ट पास करना होगा जो Google Mobile Ads SDK के तय किए गए किसी "विज्ञापन" इंटरफ़ेस के मुताबिक हो. ये विज्ञापन इंटरफ़ेस, आपसे विज्ञापन के बारे में कुछ जानकारी मांगते हैं.

MediationAdConfiguration में getWatermark() का एक तरीका भी है, जिससे PNG इमेज को दिखाने वाली base64 कोड में बदली गई स्ट्रिंग को दिखाया जा सकता है. इस इमेज को आपके विज्ञापनों पर, पारदर्शी ओवरले में टाइल किया जाना चाहिए. वॉटरमार्क को रेंडर करने के तरीके के बारे में ज़्यादा जानने के लिए, Google से संपर्क करें. इसमें दिखाए जा रहे विज्ञापन का मेटाडेटा होता है. पब्लिशर इसका इस्तेमाल करके, दिखाए जा रहे विज्ञापनों के सोर्स का पता लगाते हैं.

बैनर के लिए, आपसे बैनर व्यू देने के लिए कहा जाएगा. इंटरस्टीशियल और इनाम वाले विज्ञापनों के लिए, आपको बाद में विज्ञापन दिखाने के लिए show() तरीका लागू करने के लिए कहा जाएगा. हमारा सुझाव है कि विज्ञापन लोड करने वाली अपनी क्लास में, विज्ञापन दिखाने के इन तरीकों को लागू करने की ज़िम्मेदारी भी रखें.

यहां loadBannerAd() को लागू करने का सैंपल दिया गया है. ध्यान रखें कि आपके अडैप्टर को लागू करने का तरीका अलग दिखेगा, क्योंकि आपका अडैप्टर किसी दूसरे SDK के साथ इंटिग्रेट होता है.

public final class SampleRtbAdapter extends RtbAdapter {
  ...

  @Override
  public void loadBannerAd(
      MediationBannerAdConfiguration adConfiguration,
      MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback> callback) {

      SampleBannerRenderer bannerRenderer =
          new SampleBannerRenderer(adConfiguration, callback);
      bannerRenderer.render();
    }
}

// Renders a banner ad, and forwards callbacks to the Google Mobile Ads SDK.
public class SampleBannerRenderer implements MediationBannerAd {
  private MediationBannerAdConfiguration adConfiguration;
  private final MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback> adLoadCallback;
  private AdView adView;
  private MediationBannerAdCallback callback;

  public SampleRtbBannerRenderer(
      MediationBannerAdConfiguration adConfiguration,
      MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback> adLoadCallback) {
    this.adConfiguration = adConfiguration;
    this.adLoadCallback = adLoadCallback;
  }

  public void render() {
    adView = new AdView(adConfiguration.getContext());
    adView.setAdSize(adConfiguration.getAdSize());
    // serverParameters are the parameters entered in the AdMob UI for your network.
    adView.setAdUnitId(adConfiguration.getServerParameters().getString("adUnitId"));

    // Map the callbacks from your SDK to Google's SDK.
    adView.setAdListener(new AdListener() {
      // See the next step for more information on callback mapping.
      // ...
    });

    // Get the bid response and watermark from the ad configuration and
    // pass the relevant information to your SDK.
    String ad = adConfiguration.getBidResponse();
    String watermark = adConfiguration.getWatermark();
    Bundle extras = new Bundle();
    extras.putString("bid", ad);
    extras.putString("watermark", watermark);
    AdRequest request = new AdRequest.Builder()
        .addNetworkExtrasBundle(AdMobAdapter.class, extras)
        .build();
    adView.loadAd(request);
  }

  // MediationBannerAd implementation

  @NonNull
  @Override
  public View getView() {
    return adView;
  }
}

विज्ञापन प्रज़ेंटेशन के लाइफ़साइकल इवेंट को रीले

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

लागू होने पर, अडैप्टर को ये इवेंट ट्रिगर करने चाहिए:

सभी फ़ॉर्मैट के लिए सामान्य
तरीका कॉल कब करें
reportAdClicked() विज्ञापन पर क्लिक किया गया.
reportAdImpression() विज्ञापन ने इंप्रेशन रेंडर किया.
onAdOpened() विज्ञापन में फ़ुल-स्क्रीन व्यू दिखाया गया था.
onAdClosed() विज्ञापन का फ़ुल स्क्रीन व्यू बंद हो गया है.
onAdLeftApplication() विज्ञापन की वजह से उपयोगकर्ता ऐप्लिकेशन छोड़ देता है.
इनाम वाले विज्ञापन
onRewarded() उपयोगकर्ता को इनाम दिया जाता है.
वीडियो कॉलबैक (इनाम वाले और नेटिव विज्ञापन)
onVideoStarted() विज्ञापन का वीडियो शुरू हो गया.
onVideoCompleted() विज्ञापन का वीडियो खत्म हो गया.

mediationAdLoadCallback.onSuccess() को कॉल करने पर, अडैप्टर को MediationAdLoadCallback<MediationAdT, MediationAdCallbackT> ऑब्जेक्ट वापस मिलता है. अडैप्टर को इस ऑब्जेक्ट को होल्ड करके, आपके विज्ञापन पर होने वाले प्रज़ेंटेशन इवेंट को ट्रिगर करने के लिए इसका इस्तेमाल करना चाहिए.

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

यहां दिए गए उदाहरण में, एसडीके के विज्ञापन लिसनर से Google Mobile Ads SDK टूल पर कॉलबैक फ़ॉरवर्ड करने का तरीका बताया गया है:

adView.setAdListener(new AdListener() {
    public void onAdLoaded() {
        callback = adLoadCallback.onSuccess(SampleBannerRenderer.this);
    }

    public void onAdImpression() {
        if (callback != null) {
            callback.reportAdImpression();
        }
    }

    public void onAdFailedToLoad(LoadAdError adError) {
        adLoadCallback.onFailure("Error: " + adError.toString());
    }

    public void onAdClosed() {
        if (callback != null) {
            callback.onAdClosed();
        }
    }

    public void onAdOpened() {
        if (callback != null) {
            callback.onAdOpened();
            callback.reportAdClicked();
        }
    }

    public void onAdLeftApplication() {
        if (callback != null) {
            callback.onAdLeftApplication();
        }
    }
});

नेटिव विज्ञापन इंप्रेशन ट्रैकिंग के लिए ज़रूरी ऐसेट

Google Mobile Ads SDK, नेटिव विज्ञापन के लिए इंप्रेशन तब रिकॉर्ड करता है, जब विज्ञापन का 1 पिक्सल दिखता है. अगर आपके विज्ञापन नेटवर्क SDK टूल को मान्य इंप्रेशन दिखाने के लिए, कुछ खास एसेट दिखाने की ज़रूरत है, तो बिडिंग करने वाला आपका सिस्टम, बिड रिस्पॉन्स में इन ज़रूरी नेटिव एसेट के बारे में बता सकता है. इसके बाद, Google Mobile Ads SDK टूल यह पुष्टि करता है कि इंप्रेशन रिकॉर्ड करने से पहले, आपकी ज़रूरी नेटिव एसेट दिखाई गई हैं या नहीं.

बिड रिस्पॉन्स में ज़रूरी अन्य ऐसेट की जानकारी देने के तरीके के बारे में ज़्यादा जानने के लिए, नेटिव ऐसेट से जुड़ा ज़रूरी दस्तावेज़ देखें.

विज्ञापन से जुड़ी गड़बड़ियां दिखाना

इंटरस्टीशियल और इनाम वाले विज्ञापनों जैसे फ़ुल स्क्रीन फ़ॉर्मैट के लिए, आपको सफलता के तौर पर लोड होने वाले कॉलबैक में, MediationInterstitialAd या MediationRewardedAd का इस्तेमाल करना होगा. ऐसा इसलिए, ताकि Google Mobile Ads SDK टूल आपके अडैप्टर से विज्ञापन दिखाने के लिए कह सके.

Google Mobile Ads SDK टूल को उम्मीद है कि अगर किसी अडैप्टर ने विज्ञापन लोड कर लिया है, तो पब्लिशर के विज्ञापन दिखाने के अनुरोध पर, विज्ञापन दिखाने के लिए तैयार हो जाएगा. इसका मतलब है कि हर शो कॉल से एक इंप्रेशन मिलना चाहिए.

हालांकि, कुछ मामलों में ऐसा हो सकता है कि आपका विज्ञापन न दिखे. अगर विज्ञापन नहीं दिखाया जा सकता, तो इंप्रेशन रद्द करने के लिए, onAdFailedToShow() कॉलबैक को कॉल करें.

नीचे दी गई टेबल से पता चलता है कि प्रज़ेंटेशन कॉलबैक का फ़ुल स्क्रीन विज्ञापन फ़ॉर्मैट के लिए, इंप्रेशन रिकॉर्डिंग पर क्या असर पड़ता है:

कॉलबैक नतीजा
onAdOpened() Impression recorded
onAdFailedToShow() Impression failure1
कुछ सेकंड तक इनमें से कोई भी नहीं Impression recorded

1 जिन इंप्रेशन को रिकॉर्ड नहीं किया जा सका उनके लिए, आपके विज्ञापन नेटवर्क से इंप्रेशन के लिए शुल्क नहीं लिया जाता. हालांकि, इससे बिलिंग के लिए तय की गई इवेंट दर में बदलाव होता है. ज़्यादा जानकारी के लिए, बिड रिक्वेस्ट सिग्नल देखें.

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

final class SampleRtbAdapter extends RtbAdapter implements MediationRewardedAd {

 private MediationRewardedAdCallback callback;
 private RewardedAd rewardedAd;

 ...

  @Override
  public void loadRewardedAd(
      MediationRewardedAdConfiguration adConfiguration,
      final MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback> loadCallback) {

    // Load an ad. This mock example uses Google's SDK, but in practice
    // your adapter will load the ad using your ad network's SDK.
    RewardedAd.load(adConfiguration.getContext(),
        "ca-app-pub-3940256099942544/5224354917",
        new AdRequest.Builder().build(),
        new RewardedAdLoadCallback() {
          @Override
          public void onAdLoaded(@NonNull RewardedAd rewardedAd) {
            // When the ad loads, invoke the load success callback.
            callback = loadCallback.onSuccess(SampleRtbAdapter.this);
          }
        });
  }

  @Override
  public void showAd(Context context) {
    // In this mock example, your ad network requires an activity context, but
    // didn't receive one, making you unable to show the ad.
    if (!(context instanceof Activity)) {
      AdError error = new AdError(1, "Context must be an activity",
          "com.google.ads.mediation.sample");
      callback.onAdFailedToShow(error);
    }

    // This example shows Google SDK's callbacks, but it's likely your SDK
    // has similar presentation callbacks.
    rewardedAd.setFullScreenContentCallback(new FullScreenContentCallback() {
      @Override
      public void onAdShowedFullScreenContent() {
        // Your ad network SDK successfully showed the ad. Call onAdOpened().
        callback.onAdOpened();
      }

      @Override
      public void onAdFailedToShowFullScreenContent(AdError adError) {
        // Your ad network SDK failed to show the ad, invoke onAdFailedToShow.
        // In practice, you will map your SDK's error to an AdError.
        AdError error = new AdError(adError.getCode(), adError.getMessage(),
            adError.getDomain());
        callback.onAdFailedToShow(adError);
      }
    });


    rewardedAd.show((Activity) context, ...);
  }
}