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

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

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

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

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

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

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

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

  • चरण 4-7: अपना अडैप्टर शुरू करें और शुरू करने के बाद 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 के बताए गए किसी एक "Ad" इंटरफ़ेस की पुष्टि करता हो. ये विज्ञापन इंटरफ़ेस, आपसे विज्ञापन के बारे में कुछ जानकारी देने के लिए कहते हैं.

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 पर कॉलबैक मैप करना होता है.

इस उदाहरण में बताया गया है कि अपने 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, नेटिव विज्ञापन का एक इंप्रेशन तब रिकॉर्ड करता है, जब विज्ञापन का एक पिक्सल दिखता है. अगर मान्य इंप्रेशन दिखाने के लिए, आपके विज्ञापन नेटवर्क SDK टूल को खास एसेट दिखाने की ज़रूरत है, तो बिडिंग करने वाला व्यक्ति बिड रिस्पॉन्स में इन ज़रूरी नेटिव एसेट की जानकारी दे सकता है. इसके बाद, Google Mobile Ads SDK इस बात की पुष्टि करता है कि इंप्रेशन रिकॉर्ड करने से पहले आपकी ज़रूरी नेटिव एसेट दिख रही हैं या नहीं.

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

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

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

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

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

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

फिर से कॉल करें नतीजा
onAdOpened() Impression recorded
onAd FelToShow() 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, ...);
  }
}