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

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

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

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

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

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

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

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

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

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

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

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

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

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

getSDKVersionInfo()

यहां आपको अपने एसडीके का वर्शन डालना चाहिए. यह वर्शन, OpenRTB अनुरोध के हिस्से के तौर पर आपके बिडर को भेजा जाता है.

इस तरीके के लिए, आपको VersionInfo को वापस करना होगा. यहां दिए गए उदाहरण में बताया गया है कि एसडीके के स्ट्रिंग वर्शन को 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 टूल शुरू हो जाए और विज्ञापन के अनुरोध पाने के लिए तैयार हो जाए, तब 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, बिडिंग में हिस्सा लेने वाले सभी अडैप्टर से एक साथ सिग्नल मांगता है. कृपया इस दौरान, यूज़र इंटरफ़ेस (यूआई) थ्रेड पर कॉल करने की संख्या सीमित रखें और सम्मानजनक तरीके से कॉल करें. आपके अडैप्टर या एसडीके को सिग्नल इकट्ठा करने के लिए जो भी काम करना है उसे initialize() तरीके से किया जाना चाहिए और कैश मेमोरी में सेव किया जाना चाहिए.

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

यहां लागू करने का एक उदाहरण दिया गया है:

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

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

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

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

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

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

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

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

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

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

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

एसडीके के विज्ञापन लोड करने के बाद, mediationAdLoadCallback.onSuccess() को कॉल करें. अगर इवेंट विज्ञापन लोड नहीं होता है, तो mediationAdLoadCallback.onFailure() को कॉल करें. इसमें गड़बड़ी के बारे में बताने वाली स्ट्रिंग शामिल करें.

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

MediationAdConfiguration में, PNG इमेज को दिखाने वाली base64-encoded स्ट्रिंग को वापस लाने के लिए, getWatermark() तरीका भी है. इस इमेज को, आपके विज्ञापनों पर पारदर्शी ओवरले में टाइल किया जाना चाहिए. वॉटरमार्क रेंडर करने के तरीके के बारे में ज़्यादा जानने के लिए, 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 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 टूल की वजह से ट्रिगर होते हैं. अडैप्टर का काम सिर्फ़ आपके विज्ञापन नेटवर्क एसडीके से मिले कॉलबैक को 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 पिक्सल दिखता है. अगर आपके विज्ञापन नेटवर्क कंपनी के एसडीके टूल को मान्य इंप्रेशन रेंडर करने के लिए, कुछ ऐसेट दिखाने की ज़रूरत होती है, तो बिडर, बिड रिस्पॉन्स में इन ज़रूरी नेटिव ऐसेट के बारे में बता सकता है. इसके बाद, 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, ...);
  }
}