Android पर Topics API लागू करें

सेटअप

Topics API को लागू करने के लिए, आपको सबसे पहले अपना डेवलपमेंट एनवायरमेंट सेट अप करना होगा. इसके लिए, सेटअप के ये चरण पूरे करें:

  1. निजता बनाए रखने वाले एपीआई का सबसे नया वर्शन पाने के लिए, Android Privacy Sandbox SDK के सबसे नए वर्शन का इस्तेमाल करें.

  2. अपने मेनिफ़ेस्ट में यह जानकारी जोड़ें:

    • अनुमति: अपने ऐप्लिकेशन को Topics API ऐक्सेस करने की अनुमति देने के लिए, ACCESS_ADSERVICES_TOPICS अनुमति शामिल करें:

      <uses-permission android:name="android.permission.ACCESS_ADSERVICES_TOPICS" />
      
    • विज्ञापन सेवाओं का कॉन्फ़िगरेशन: अपने मेनिफ़ेस्ट के <application> एलिमेंट में, विज्ञापन सेवाओं के कॉन्फ़िगरेशन वाली फ़ाइल का रेफ़रंस शामिल करें.

      <property android:name="android.adservices.AD_SERVICES_CONFIG"
      android:resource="@xml/ad_services_config" />
      

      मेनिफ़ेस्ट में रेफ़रंस दिए गए, विज्ञापन सेवाओं के XML संसाधन के बारे में बताएं. जैसे, res/xml/ad_services_config.xml. सभी SDK टूल को ऐक्सेस देने के लिए, allowAllToAccess एट्रिब्यूट का इस्तेमाल करें. वहीं, अलग-अलग SDK टूल को ऐक्सेस देने के लिए, allowSdksToAccess एट्रिब्यूट का इस्तेमाल करें. विज्ञापन सेवाओं की अनुमतियों और SDK टूल के ऐक्सेस को कंट्रोल करने के बारे में ज़्यादा जानें.

      <ad-services-config>
          <topics allowAllToAccess="true"/>
      </ad-services-config>
      
  3. अपने SDK टूल में Topics API को कॉल करने के लिए, विज्ञापन टेक्नोलॉजी को Privacy Sandbox के साथ रजिस्टर करें. स्थानीय तौर पर टेस्टिंग के लिए, इन कमांड की मदद से, Topics के रजिस्ट्रेशन की जांच को बंद किया जा सकता है:

    adb shell setprop debug.adservices.disable_topics_enrollment_check true
    
  4. Topics API को ऐक्सेस करने की अनुमति दें. डिफ़ॉल्ट रूप से, Topics API बंद होता है. इसे चालू करने के लिए, ADB कमांड का इस्तेमाल करना होगा:

    adb shell device_config put adservices ppapi_app_signature_allow_list \"\*\"
    adb shell setprop debug.adservices.disable_topics_enrollment_check true
  5. डिवाइस पर विषयों को वापस पाने का तरीका जानने के लिए, सैंपल ऐप्लिकेशन के Java या Kotlin वर्शन को फ़ोर्क करके, इसे लागू करना शुरू करें.

विषयों के सेट का अनुरोध करना

Topics API का मुख्य फ़ंक्शन, getTopics() तरीका TopicsManager ऑब्जेक्ट में मौजूद है. जैसा कि इस उदाहरण में दिखाया गया है:

Kotlin

fun getTopics(
        getTopicsRequest: GetTopicsRequest,
        executor: Executor,
        callback: OutcomeReceiver<GetTopicsResponse, Exception>
    ) { }

Java

public void getTopics (@NonNull GetTopicsRequest getTopicsRequest,
    @NonNull Executor executor,
    @NonNull OutcomeReceiver<GetTopicsResponse, Exception> callback)

इस तरीके का इस्तेमाल करने के लिए, TopicsManager ऑब्जेक्ट और विषयों का डेटा पाने के लिए ज़रूरी पैरामीटर शुरू करें. GetTopicsRequest , Topics API का डेटा वापस पाने के लिए ज़रूरी जानकारी पास करता है. इसमें यह फ़्लैग भी शामिल होता है कि कॉलर, ऑब्ज़र्वर के तौर पर काम करेगा या नहीं. ऑब्ज़र्वर के तौर पर काम करने पर, getTopics कॉल, पिछले युग का कोई विषय दिखाता है. हालांकि, इससे अगले युग के विषयों के डेटा पर कोई असर नहीं पड़ेगा. OutcomeReceiver कॉलबैक, नतीजे को एसिंक्रोनस तरीके से हैंडल करता है. उदाहरण के लिए:

Kotlin

private fun topicGetter() {
    val mContext = baseContext
    val mTopicsManager = mContext.getSystemService(TopicsManager::class.java)
    val mExecutor: Executor = Executors.newCachedThreadPool()
    val shouldRecordObservation = false
    val mTopicsRequestBuilder: GetTopicsRequest.Builder = GetTopicsRequest.Builder()
    mTopicsRequestBuilder.setAdsSdkName(baseContext.packageName)
    mTopicsRequestBuilder.setShouldRecordObservation(shouldRecordObservation)
    mTopicsManager.getTopics(mTopicsRequestBuilder.build(), mExecutor,
        mCallback as OutcomeReceiver<GetTopicsResponse, Exception>)
}
private var mCallback: OutcomeReceiver<GetTopicsResponse, java.lang.Exception> =
object : OutcomeReceiver<GetTopicsResponse, java.lang.Exception> {
    override fun onResult(result: GetTopicsResponse) {
        // handle successful result
        val topicsResult = result.topics
        for (i in topicsResult.indices) {
            Log.i("Topic", topicsResult[i].getTopicId().toString())
        }
        if (topicsResult.size == 0) {
            Log.i("Topic", "Returned Empty")
        }
    }
    override fun onError(error: java.lang.Exception) {
        // handle error
        Log.i("Topic", "Error, did not return successfully")
    }
}

Java

public void TopicGetter() {
    @NonNull Context mContext = getBaseContext();
    TopicsManager mTopicsManager = mContext.getSystemService(TopicsManager.class);
    Executor mExecutor = Executors.newCachedThreadPool();
    boolean shouldRecordObservation = false;
    GetTopicsRequest.Builder mTopicsRequestBuilder = new GetTopicsRequest.Builder();
    mTopicsRequestBuilder.setAdsSdkName(getBaseContext().getPackageName());
    mTopicsRequestBuilder.setShouldRecordObservation(shouldRecordObservation);
    mTopicsManager.getTopics(mTopicsRequestBuilder.build(), mExecutor, mCallback);
}
OutcomeReceiver mCallback = new OutcomeReceiver<GetTopicsResponse, Exception>() {
    @Override
    public void onResult(@NonNull GetTopicsResponse result) {
        //Handle Successful Result
        List<Topic> topicsResult = result.getTopics();
        for (int i = 0; i < topicsResult.size(); i++) {
            Log.i("Topic", topicsResult.get(i).getTopicId().toString());
        }
        if (topicsResult.size() == 0) {
            Log.i("Topic", "Returned Empty");
        }
    }
    @Override
    public void onError(@NonNull Exception error) {
        // Handle error
        Log.i("Topic", "Experienced an error, and did not return successfully");
    }
};

सेटअप पूरा होने के बाद, सेटअप तैयार होने पर, GetTopicsResponse पाने के लिए, कॉल किया जा सकता है:getTopics()

Kotlin

mTopicsManager.getTopics(mTopicsRequestBuilder.build(), mExecutor,
        mCallback as OutcomeReceiver<GetTopicsResponse, java.lang.Exception>)

Java

mTopicsManager.getTopics(mTopicsRequestBuilder.build(), mExecutor, mCallback);

इस कॉल से, Topics ऑब्जेक्ट की सूची मिलेगी. इसमें आईडी की वे वैल्यू शामिल होंगी जो ओपन सोर्स टैक्सोनॉमी में मौजूद उन विषयों से जुड़ी होंगी जो उपयोगकर्ता के लिए काम के हैं . इसके अलावा, इससे काम की कोई गड़बड़ी भी मिल सकती है. विषय इस उदाहरण की तरह दिखेंगे:

/Internet & Telecom/Text & Instant Messaging

दिखाए जा सकने वाले विषयों की सूची के लिए, टैक्सोनॉमी देखें. यह टैक्सोनॉमी ओपन सोर्स है. इसमें बदलाव के सुझाव देने के लिए, इस पेज पर सबसे ऊपर मौजूद शिकायत, सुझाव या राय दें बटन का इस्तेमाल किया जा सकता है.

टेस्ट करना

Topics API, ऐप्लिकेशन के इस्तेमाल के आधार पर, काम के और नए विषय उपलब्ध कराता है. इस शुरुआती वर्शन में, एपीआई के काम करने के तरीके की झलक मिलती है. हम आने वाले समय में, विषयों की क्वालिटी को बेहतर बनाएंगे.

हमारा सुझाव है कि बेहतर अनुभव पाने के लिए, कई ऐप्लिकेशन वाले टेस्टिंग एनवायरमेंट का इस्तेमाल करें. इसमें getTopics() को कॉल करके देखें कि विषयों को कैसे चुना जाता है. GitHub पर मौजूद, SDK टूल के रनटाइम और निजता बनाए रखने वाले एपीआई के डेटा स्टोर में, Android Studio के अलग-अलग प्रोजेक्ट का सेट मौजूद है. इससे आपको शुरू करने में मदद मिलेगी. इसमें ऐसे सैंपल भी शामिल हैं जिनसे पता चलता है कि Topics API को कैसे शुरू और कॉल किया जाता है.

विषयों की गिनती, युग के खत्म होने पर की जाती है. डिफ़ॉल्ट रूप से, हर युग सात दिनों का होता है. हालांकि, नतीजे पाने के लिए, इस इंटरवल को बदला जा सकता है. Android Debug Bridge का यह शेल कमांड, युग की अवधि को पांच मिनट तक कम कर देता है:

adb shell device_config put adservices topics_epoch_job_period_ms 300000

get की मदद से, topics_epoch_job_period_ms वैल्यू की पुष्टि की जा सकती है:

adb shell device_config get adservices topics_epoch_job_period_ms

युग की गिनती को मैन्युअल तरीके से ट्रिगर करने के लिए, यह कमांड चलाएं:

adb shell cmd jobscheduler run -f com.google.android.adservices.api 2

सैंपल ऐप्लिकेशन का इस्तेमाल करने के अलावा, एक कोलाब भी है. इसका इस्तेमाल, विषयों को अलग-अलग कैटगरी में बांटने वाले टूल के हिसाब से, ऐप्लिकेशन की जानकारी के अलग-अलग कॉम्बिनेशन की जांच करने के लिए किया जा सकता है. getTopics को कॉल करने पर, आपके ऐप्लिकेशन को किस तरह के नतीजे मिल सकते हैं, यह देखने के लिए इस कोलाब का इस्तेमाल करें.

एन्क्रिप्शन की जानकारी

एन्क्रिप्शन की सुविधा शुरू होने के बाद, GetTopics() को कॉल करने पर, ऑब्जेक्ट की सूची वाला जवाब मिलेगा.EncryptedTopic इन नतीजों को डिक्रिप्ट करने पर, ऐसा ऑब्जेक्ट मिलेगा जिसका JSON फ़ॉर्मैट, पिछले Topic ऑब्जेक्ट के JSON फ़ॉर्मैट जैसा ही होगा.

Topics API, HPKE (हाइब्रिड पब्लिक की एन्क्रिप्शन) को एक बार लागू करने की सुविधा देता है. हमारा मानना है कि रजिस्टर किया गया कॉलर, रजिस्ट्रेशन के दौरान दिए गए सार्वजनिक एन्क्रिप्शन यूआरएल एंडपॉइंट पर, 32-बिट की सार्वजनिक कुंजी होस्ट करेगा. उम्मीद है कि ये कुंजियां, Base64 के कोड में होंगी.

EncryptedTopic ऑब्जेक्ट में तीन फ़ील्ड होते हैं. दिखाए गए विषयों की सूची पाने के लिए, सार्वजनिक कुंजी के लिए निजी कुंजी का इस्तेमाल किया जा सकता है.

डेवलपमेंट के लिए, रजिस्ट्रेशन की जांच को बंद करके, Topics API के एन्क्रिप्शन की जांच की जा सकती है. इससे, एपीआई आपके जवाबों को एन्क्रिप्ट करने के लिए, टेस्ट के लिए इस्तेमाल की जाने वाली सार्वजनिक कुंजी का इस्तेमाल करेगा. एन्क्रिप्ट किए गए विषयों को डिक्रिप्ट करने के लिए, निजी कुंजी का इस्तेमाल किया जा सकता है.

सीमाएं

Topics API के लिए, फ़िलहाल काम की जा रही सुविधाओं की सूची देखने के लिए, रिलीज़ नोट देखें.

गड़बड़ियों और समस्याओं की शिकायत करना

आपकी राय, Android पर Privacy Sandbox का अहम हिस्सा है. Android पर Privacy Sandbox को बेहतर बनाने के लिए, अगर आपको कोई समस्या दिखती है या आपके पास कोई सुझाव है, तो हमें बताएं.

आगे क्या करना होगा

जानें कि उपयोगकर्ता और डेवलपर, Topics API को अपनी प्राथमिकताओं और ज़रूरतों के हिसाब से कैसे मैनेज और पसंद के मुताबिक बना सकते हैं.
जानें कि Topics, Android पर कैसे काम करता है. साथ ही, एपीआई फ़्लो के मुख्य चरणों के बारे में जानें.

इन्हें भी देखें

Android पर Topics API को बेहतर तरीके से समझने के लिए, हमारे संसाधन देखें.