SDK रनटाइम एपीआई: इंटिग्रेशन गाइड

Android पर प्राइवसी सैंडबॉक्स से जुड़े दस्तावेज़ पढ़ते समय, डेवलपर के लिए झलक या बीटा वर्शन बटन का इस्तेमाल करें. इसके बाद, प्रोग्राम का वह वर्शन चुनें जिस पर आपको काम करना है. निर्देश अलग-अलग हो सकते हैं.


इंटिग्रेशन की योजना बनाने में आपकी मदद करने के लिए, इस गाइड में इंटिग्रेशन की प्रोसेस के बारे में पूरी जानकारी दी गई है. इसमें ऐसी सुविधाएं शामिल हो सकती हैं जिन्हें अभी तक Android डेवलपर झलक पर प्राइवसी सैंडबॉक्स के मौजूदा चरण में लागू नहीं किया गया है. ऐसे मामलों में, टाइमलाइन से जुड़े दिशा-निर्देश दिए जाते हैं.

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

SDK टूल के रनटाइम इंटिग्रेशन वर्कफ़्लो का विज़ुअल डायग्राम.
SDK टूल के रनटाइम इंटिग्रेशन के लिए वर्कफ़्लो.

ज़रूरी शर्तें और सेटअप

काम से पहले की इस जानकारी को पूरा करने से, आपको SDK टूल के रनटाइम की अच्छी जानकारी मिलती है. साथ ही, इससे विज्ञापन टेक्नोलॉजी नेटवर्क में एपीआई का इस्तेमाल करते समय, काम के नतीजे पाने में मदद मिलती है.

एपीआई के बारे में जानकारी लें

SDK टूल के रनटाइम, इसकी क्षमताओं, और पाबंदियों के बारे में जानने के लिए, डिज़ाइन प्रपोज़ल को पढ़ें.

अपने इस्तेमाल के उदाहरणों में ज़रूरी कोड और एपीआई कॉल को शामिल करने का तरीका जानने के लिए, डेवलपर गाइड पढ़ें.

कृपया दस्तावेज़ के बारे में, खास तौर पर उन सवालों के बारे में सुझाव, शिकायत या राय दें जो आपके पास हैं.

Android पर प्राइवसी सैंडबॉक्स के बारे में अपडेट पाने के लिए, साइन अप करें. इससे आपको आने वाली रिलीज़ में शामिल की जाने वाली नई सुविधाओं के बारे में जानकारी मिलती रहेगी.

ऐप्लिकेशन के नमूने को सेटअप और उसकी जांच करें

जब आप इंटिग्रेशन की प्रोसेस शुरू करने के लिए तैयार हों, तब यहां दिए गए निर्देशों का पालन करके, Android Studio में डेवलपर की नई झलक डाउनलोड करें. इस गाइड के लिए, Android Studio का सबसे नया कैनरी वर्शन इस्तेमाल करना ज़रूरी है. Android Studio के इस वर्शन को, इस्तेमाल किए जा रहे दूसरे वर्शन के साथ चलाया जा सकता है. इसलिए, अगर यह शर्त आपके लिए काम नहीं करती है, तो कृपया हमें बताएं.

हमारे सैंपल ऐप्लिकेशन में कोड को फ़ोर्क करें और चलाएं. इससे आपको पता चलेगा कि "example-sdk" नाम के RE SDK टूल को इंस्टॉल किया गया है या किसी डिवाइस या एम्युलेटर पर "Client-app" नाम का क्लाइंट ऐप्लिकेशन इंस्टॉल किया गया है, ताकि यह पक्का किया जा सके कि उदाहरण के तौर पर दिखने वाला विज्ञापन लोड हो.

मौजूदा SDK टूल को SDK टूल के रनटाइम के हिसाब से बनाएं

इस सेक्शन का मकसद फ़ंक्शन लागू करना है, जैसे कि रनटाइम की सुविधा वाले SDK (RE SDK) में मौजूदा SDK टूल से बैनर विज्ञापन दिखाना, और ऐप्लिकेशन और आरई SDK टूल के बीच कम्यूनिकेशन सेट अप करना.

  • RE SDK में फ़ंक्शनलिटी लागू करने के लिए, SDK-example और sdk- खरीदे जाने की सेटिंग बनाएं या अपडेट करें.

  • दरअसल, RE SDK टूल को मौजूदा SDK टूल की डिपेंडेंसी के तौर पर जोड़ें, जो एक रैपर के तौर पर काम करता है. इससे क्लाइंट ऐप्लिकेशन, मौजूदा SDK टूल या रैपर को सीधे कॉल करना जारी रख सकता है. रैपर SDK टूल नीचे बताई गई अलग-अलग रणनीतियों के आधार पर, एपीआई कॉल को रूट कर सकता है.

SDK टूल के रनटाइम इंटिग्रेशन के बाद, सिस्टम आर्किटेक्चर का विज़ुअल डायग्राम.
SDK टूल के रनटाइम इंटिग्रेशन के बाद सिस्टम का आर्किटेक्चर.

कस्टम डेटा की ज़रूरत वाले इस्तेमाल के उदाहरणों, जैसे कि PPAPIs में कॉल करने के लिए, IPC का इस्तेमाल करके एपीआई परिभाषा बनाना ज़रूरी है. Android के IBinder और AIDL का इस्तेमाल करके, कम्यूनिकेशन प्रोटोकॉल बनाएं. इससे रनटाइम की सुविधा वाले SDK टूल को किसी भी ज़रूरी जानकारी या कार्रवाई के लिए जानकारी भेजी जा सकेगी. SDK टूल के रनटाइम की डेवलपर गाइड में ज़्यादा जानकारी यहां देखें.

ट्रैफ़िक को रनटाइम के लिए चालू किए गए SDK टूल पर रूट करें

एपीआई कॉल के लिए रूटिंग की रणनीतियां

आपके इस्तेमाल के उदाहरणों के आधार पर, हमारा सुझाव है कि SDK कॉल को मौजूदा SDK टूल और आरई SDK कोड पाथ के ज़रिए रूट करें. इससे आपको शुरुआती रोल आउट में A/B टेस्टिंग लागू करने में मदद मिलेगी. ऐप्लिकेशन इंटिग्रेशन को आसान बनाने के लिए, इस गाइड में इस बात का ध्यान रखा गया है कि ऐप्लिकेशन, आरई SDK टूल पर निर्भर करेगा और ज़रूरत पड़ने पर मौजूदा SDK टूल का ऐक्सेस देगा. ये रणनीतियां अपनाएं:

SDK टूल के कॉल के प्रतिशत को आरई SDK टूल पर रूट करें

SDK टूल के कॉल का कुछ प्रतिशत ही आरई SDK टूल पर भेजें. बाकी को मौजूदा SDK टूल कोड पाथ पर रूट करें. उदाहरण के लिए, इस रणनीति का इस्तेमाल उन मामलों के लिए करें जहां आपको SDK टूल का अनुरोध एक बार पूरा करना हो, जैसे कि बैनर विज्ञापन दिखाना.

  • अपने मौजूदा SDK टूल में बदलाव करें, ताकि कुछ प्रतिशत अनुरोधों को आरई SDK टूल को भेजा जा सके. उदाहरण के लिए, दिशा बदलने के मापदंड को डायनैमिक तौर पर कंट्रोल करने के लिए, सर्वर-आधारित डाइनैमिक कॉन्फ़िगरेशन फ़्लैग, जैसे कि Firebase रिमोट कॉन्फ़िगरेशन का इस्तेमाल करें.
  • इससे, मौजूदा SDK टूल ही एक ऐसा इंटरफ़ेस बन जाता है जिसके साथ ऐप्लिकेशन इंटरैक्ट करता है. साथ ही, यही नए RE SDK टूल पर SDK टूल के अनुरोधों को रूट करने की ज़िम्मेदारी भी लेता है.
  • आपके कोड को सिर्फ़ ऐसे अनुरोधों को रीडायरेक्ट करना चाहिए जिन्हें आरई SDK टूल से मैनेज किया जा सके. उदाहरण के लिए, पुष्टि करें कि विज्ञापन फ़ॉर्मैट, SDK टूल के रनटाइम के साथ काम करता है.
  • RESDK के साथ इंटरैक्ट करने के लिए, अपना SDK कोड अपडेट करने के लिए, इन निर्देशों का पालन करें.

रूटिंग लॉजिक के लिए स्यूडो कोड:

void showAd(AdRequest request) {
  if (request.isBannerAd() && enableRuntimeSdkDiversion() == true) {
    // Call showAd() from the RE SDK
  } else {
    // Call showAd() using the existing SDK code path
  }
}

सभी SDK टूल कॉल को मौजूदा और आरई SDK टूल, दोनों पर रूट करें

इस्तेमाल किए जा सकने वाले डिवाइसों पर, सभी SDK टूल कॉल को मौजूदा SDK कोड पाथ और आरई SDK कोड पाथ, दोनों पर रूट करें. इस रणनीति का इस्तेमाल उन मामलों में करें जहां आपको तुलना करने के लिए, मौजूदा और नए, दोनों तरह के कोड पाथ का इस्तेमाल करना पड़े. उदाहरण के लिए, कन्वर्ज़न रिपोर्टिंग के नतीजों की तुलना करें.

  • सभी SDK टूल के कॉल को मौजूदा SDK कोड पाथ और आरई SDK कोड पाथ, दोनों पर रूट करने के लिए अपने कोड में बदलाव करें. आपको पुष्टि करनी होगी कि यह फ़ंक्शन, SDK टूल के रनटाइम पर काम करता है और आरई SDK टूल लोड हो गया है.

रूटिंग लॉजिक के लिए स्यूडो कोड:

void reportAttribution(AdRequest request) {
  if (request.isFeatureSupported() && isSdkLoaded() == true) {
    // Call RE SDK
  }

  // Call existing SDK code path
}

रनटाइम की सुविधा वाले SDK टूल डिस्ट्रिब्यूशन के लिए क्लोज़्ड बीटा

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