SDK टूल की डेटिंग से जुड़ाव: तीसरे पक्ष के तकनीकी इंटिग्रेशन के निर्देश

Google, उपयोगकर्ता के डिवाइस पर एक ऐसा प्लैटफ़ॉर्म बना रहा है जो उपयोगकर्ताओं के ऐप्लिकेशन को वर्टिकल के हिसाब से व्यवस्थित करता है. साथ ही, यह ऐप्लिकेशन के कॉन्टेंट को खोजने और उसे अपनी पसंद के मुताबिक इस्तेमाल करने का एक नया और शानदार अनुभव देता है. फ़ुलस्क्रीन पर दिखने वाले इस अनुभव की मदद से, डेवलपर पार्टनर को अपने ऐप्लिकेशन के बाहर एक खास चैनल में, अपना सबसे अच्छा रिच कॉन्टेंट दिखाने का मौका मिलता है. इस गाइड में, डेवलपर पार्टनर के लिए निर्देश दिए गए हैं. इनमें बताया गया है कि Engage SDK का इस्तेमाल करके, डेटिंग से जुड़े अपने कॉन्टेंट को कैसे इंटिग्रेट किया जा सकता है, ताकि इस नए प्लैटफ़ॉर्म पर कॉन्टेंट दिखाया जा सके.

इंटिग्रेशन की जानकारी

इस सेक्शन में, डेटिंग कॉन्टेंट के लिए Engage SDK टूल को इंटिग्रेट करने के तरीके, डेटा मॉडल, और शब्दावली के बारे में बताया गया है.

शब्दावली

इस इंटिग्रेशन में, ये तीन क्लस्टर टाइप शामिल हैं: सुझाव, सुझाया गया, और जारी रखें.

• सुझाव के क्लस्टर, किसी एक डेवलपर पार्टनर के कॉन्टेंट में से आपकी दिलचस्पी के हिसाब से डेटिंग के सुझाव दिखाते हैं. ये सुझाव, उपयोगकर्ता के हिसाब से दिखाए जा सकते हैं.

  • सुझाव का क्लस्टर ArticleEntity, PersonEntity या EventEntity से बनाया जा सकता है. हालांकि, इसमें अलग-अलग तरह के एलिमेंट को नहीं मिलाया जा सकता.

  आपके सुझावों का स्ट्रक्चर इस तरह का होता है:

  • सुझाव के क्लस्टर: एक यूज़र इंटरफ़ेस (यूआई) दिखता है. इसमें एक ही डेवलपर पार्टनर के कॉन्टेंट में सुझाव दिखाए जाते हैं.

  • इकाई: इसमें एक कॉन्टेंट दिखता है. इस इंटिग्रेशन से, कुछ ऐसी इकाइयां मिलती हैं जिन्हें सुझावों के क्लस्टर का इस्तेमाल करके दिखाया जाएगा:

    • ArticleEntity: ArticleEntity, डेटिंग से जुड़े टेक्स्ट वाले कॉन्टेंट के लिए सुझाव दिखाता है. ArticleEntity आइटम की मदद से, डेवलपर ज़्यादा मेटाडेटा के साथ कई तरह का टेक्स्ट और इमेज कॉन्टेंट उपलब्ध करा सकते हैं. इससे उपयोगकर्ताओं को जानकारी को बेहतर तरीके से समझने में मदद मिलती है.

      

    • PersonEntity: PersonEntity से किसी व्यक्ति के बारे में पता चलता है. सुझावों में, डेटिंग के लिए किसी व्यक्ति को हाइलाइट किया जा सकता है.

      

    • EventEntity: EventEntity, आने वाले समय में होने वाले किसी इवेंट को दिखाता है. इवेंट शुरू होने का समय एक अहम जानकारी है, जो उपयोगकर्ताओं को दी जानी चाहिए.

      

• जारी रखने वाला क्लस्टर, एक ही यूज़र इंटरफ़ेस (यूआई) ग्रुपिंग में, कई डेवलपर पार्टनर के ऐसे कॉन्टेंट को दिखाता है जिसमें उपयोगकर्ताओं ने हाल ही में दिलचस्पी दिखाई है. हर डेवलपर पार्टनर को, जारी रखने वाले क्लस्टर में ज़्यादा से ज़्यादा 10 इकाइयां ब्रॉडकास्ट करने की अनुमति होगी.

  कॉन्टेंट को इस तरह से स्ट्रक्चर किया जा सकता है:

  • ArticleEntity: ArticleEntity, डेटिंग से जुड़े टेक्स्ट वाले कॉन्टेंट के लिए सुझाव दिखाता है. इस इकाई का इस्तेमाल, अधूरी समाचार रिपोर्टों या अन्य कॉन्टेंट को दिखाने के लिए किया जा सकता है. इससे उपयोगकर्ता, कॉन्टेंट को वहीं से पढ़ना या देखना जारी रख सकता है जहां उसने उसे छोड़ा था.

    

  • EventReservationEntity: EventReservationEntity, किसी इवेंट के लिए की गई बुकिंग को दिखाती है. इससे उपयोगकर्ताओं को डेटिंग और मीटअप इवेंट के लिए की गई बुकिंग को ट्रैक करने में मदद मिलती है.

    

• चुनिंदा क्लस्टर, एक यूज़र इंटरफ़ेस (यूआई) व्यू है. इसमें कई डेवलपर पार्टनर के चुने गए हीरो GenericFeaturedEntity को एक ही यूज़र इंटरफ़ेस (यूआई) ग्रुपिंग में दिखाया जाता है. एक ही 'चुनिंदा' क्लस्टर होता है, जो यूज़र इंटरफ़ेस (यूआई) के सबसे ऊपरी हिस्से के पास दिखता है. इसे सुझाव वाले सभी क्लस्टर के ऊपर प्राथमिकता के साथ दिखाया जाता है. हर डेवलपर पार्टनर को, 'चुनिंदा' क्लस्टर में, काम करने वाले टाइप की सिर्फ़ एक इकाई ब्रॉडकास्ट करने की अनुमति है. हालांकि, इस क्लस्टर में कई ऐप्लिकेशन डेवलपर की कई इकाइयां (अलग-अलग टाइप की हो सकती हैं) शामिल हो सकती हैं.

  • GenericFeaturedEntity: GenericFeaturedEntity, सुझाव वाले आइटम से अलग होता है. ऐसा इसलिए, क्योंकि हाइलाइट किए गए आइटम का इस्तेमाल, डेवलपर के सबसे अच्छे कॉन्टेंट के लिए किया जाना चाहिए. साथ ही, इसमें सबसे अहम कॉन्टेंट को दिखाया जाना चाहिए, जो उपयोगकर्ताओं के लिए दिलचस्प और काम का हो.

    

सेशन की तैयारी

कम से कम एपीआई लेवल: 19

अपने ऐप्लिकेशन में com.google.android.engage:engage-core लाइब्रेरी जोड़ें:

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.6.0'
}

खास जानकारी

यह डिज़ाइन, सीमित सेवा को लागू करने पर आधारित है.

कोई क्लाइंट, अलग-अलग क्लस्टर टाइप के लिए, इस सीमा तक डेटा पब्लिश कर सकता है:

पहला चरण: इकाई का डेटा देना

SDK टूल ने हर तरह के आइटम को दिखाने के लिए, अलग-अलग इकाइयां तय की हैं. हम डेटिंग कैटगरी के लिए, इन इकाइयों के साथ काम करते हैं:

1. GenericFeaturedEntity
2. ArticleEntity
3. PersonEntity
4. EventEntity
5. EventReservationEntity

यहां दिए गए चार्ट में, हर तरह के प्रॉडक्ट के लिए उपलब्ध एट्रिब्यूट और ज़रूरी शर्तों के बारे में बताया गया है.

GenericFeaturedEntity

ArticleEntity

PersonEntity

EventEntity

EventReservationEntity

इमेज की जानकारी

इमेज ऐसेट के लिए ज़रूरी शर्तें इस टेबल में दी गई हैं:

इमेज को सार्वजनिक सीडीएन पर होस्ट किया जाना चाहिए, ताकि Google उन्हें ऐक्सेस कर सके.

फ़ाइल फ़ॉर्मैट

PNG, JPG, स्टैटिक GIF, WebP

फ़ाइल का ज़्यादा से ज़्यादा साइज़

5120 केबी

कुछ और सुझाव

• इमेज के लिए सुझाया गया सेफ़ एरिया: अपने मुख्य कॉन्टेंट को इमेज के बीच वाले 80% हिस्से में रखें.
• पारदर्शी बैकग्राउंड का इस्तेमाल करें, ताकि इमेज गहरे और हल्के रंग वाली थीम की सेटिंग में सही तरीके से दिखे.

कॉन्टेंट कैटगरी

कॉन्टेंट की कैटगरी की मदद से, ऐप्लिकेशन कई कैटगरी का कॉन्टेंट पब्लिश कर सकते हैं. यह कॉन्टेंट को पहले से तय की गई कुछ कैटगरी के साथ मैप करता है. जैसे:

• TYPE_EDUCATION
• TYPE_SPORTS
• TYPE_MOVIES_AND_TV_SHOWS
• TYPE_BOOKS
• TYPE_AUDIOBOOKS
• TYPE_MUSIC
• TYPE_DIGITAL_GAMES
• TYPE_TRAVEL_AND_LOCAL
• TYPE_HOME_AND_AUTO
• TYPE_BUSINESS
• TYPE_NEWS
• TYPE_FOOD_AND_DRINK
• TYPE_SHOPPING
• TYPE_HEALTH_AND_FITENESS
• TYPE_MEDICAL
• TYPE_PARENTING
• TYPE_DATING

इमेज को सार्वजनिक सीडीएन पर होस्ट किया जाना चाहिए, ताकि Google उन्हें ऐक्सेस कर सके.

कॉन्टेंट की कैटगरी इस्तेमाल करने के दिशा-निर्देश

1. ArticleEntity और GenericFeaturedEntity जैसी कुछ इकाइयां, कॉन्टेंट की किसी भी कैटगरी का इस्तेमाल कर सकती हैं. EventEntity, EventReservationEntity, PersonEntity जैसी अन्य इकाइयों के लिए, इन कैटगरी का सिर्फ़ एक सबसेट ही ज़रूरी शर्तें पूरी करता है. सूची में जानकारी भरने से पहले, किसी इकाई के टाइप के लिए ज़रूरी शर्तें पूरी करने वाली कैटगरी की सूची देखें.

2. कॉन्टेंट की कुछ कैटगरी के लिए, सामान्य इकाइयों और ContentCategory के कॉम्बिनेशन के बजाय, खास इकाई टाइप का इस्तेमाल करें:

   • TYPE_MOVIES_AND_TV_SHOWS - सामान्य इकाइयों का इस्तेमाल करने से पहले, वॉच इंटिग्रेशन गाइड में मौजूद इकाइयां देखें.
   • TYPE_BOOKS - सामान्य इकाइयों का इस्तेमाल करने से पहले, EbookEntity देखें.
   • TYPE_AUDIOBOOKS - सामान्य इकाइयों का इस्तेमाल करने से पहले, AudiobookEntity देखें.
   • TYPE_SHOPPING - सामान्य इकाइयों का इस्तेमाल करने से पहले, ShoppingEntity देखें.
   • TYPE_FOOD_AND_DRINK - सामान्य इकाइयों का इस्तेमाल करने से पहले, फ़ूड इंटिग्रेशन गाइड में मौजूद इकाइयां देखें.

3. ContentCategory फ़ील्ड भरना ज़रूरी नहीं है. अगर कॉन्टेंट, पहले बताई गई किसी भी कैटगरी से जुड़ा नहीं है, तो इसे खाली छोड़ देना चाहिए.

4. अगर कॉन्टेंट की एक से ज़्यादा कैटगरी दी गई हैं, तो उन्हें कॉन्टेंट के हिसाब से क्रम में लगाएं. सबसे काम की कैटगरी को सूची में सबसे ऊपर रखें.

दूसरा चरण: क्लस्टर डेटा उपलब्ध कराना

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

AppEngagePublishClient, क्लस्टर पब्लिश करने के लिए ज़िम्मेदार है.

क्लाइंट में क्लस्टर पब्लिश करने के लिए, ये एपीआई उपलब्ध हैं:

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishContinuationCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteContinuationCluster
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

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

Engage SDK टूल के वर्शन 1.6.0 और इसके बाद के वर्शन के लिए (सुझाया गया)

android skills add engage-sdk-integration

Use the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.

आपके पास हर उस क्लस्टर टाइप के लिए सेवा की उपलब्धता देखने का विकल्प है जिसे आपको पब्लिश करना है. isServiceAvailable एपीआई, अनुरोध ऑब्जेक्ट ServiceAvailabilityRequest को स्वीकार करता है. इसमें क्लस्टर टाइप शामिल होते हैं. इनके लिए, सेवा की उपलब्धता की जांच करनी होती है. ServiceAvailabilityRequest के लिए ज़रूरी ClusterType enum वैल्यू, इस टेबल में देखी जा सकती हैं.

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
});

शर्तों के साथ सेवा की उपलब्धता की सुविधा

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

Engage SDK के वर्शन 1.6.0 से, खास क्लस्टर टाइप की उपलब्धता की जांच की जा सकती है. अगर आपका ऐप्लिकेशन, रुक-रुककर डेटा डालने की सुविधा का इस्तेमाल करता है, तो:

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

अगर यह डिफ़ॉल्ट कॉन्फ़िगरेशन आपकी ज़रूरतों के मुताबिक नहीं है, तो engage-developers@google.com पर संपर्क करें.

SDK टूल के 1.6.0 से पहले के वर्शन के लिए (अब सेवा में नहीं है)

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

इस एपीआई का इस्तेमाल, RecommendationCluster ऑब्जेक्ट की सूची पब्लिश करने के लिए किया जाता है.

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

जब सेवा को अनुरोध मिलता है, तो एक लेन-देन के अंदर ये कार्रवाइयां होती हैं:

• डेवलपर पार्टनर का मौजूदा RecommendationCluster डेटा हटा दिया जाता है.
• अनुरोध से मिले डेटा को पार्स करके, अपडेट किए गए 'सुझाव वाले क्लस्टर' में सेव किया जाता है.

किसी गड़बड़ी के मामले में, पूरा अनुरोध अस्वीकार कर दिया जाता है और मौजूदा स्थिति को बनाए रखा जाता है.

publishFeaturedCluster

इस एपीआई का इस्तेमाल, FeaturedCluster ऑब्जेक्ट की सूची पब्लिश करने के लिए किया जाता है.

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

client.publishFeaturedCluster(
            new PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

जब सेवा को अनुरोध मिलता है, तो एक लेन-देन के अंदर ये कार्रवाइयां होती हैं:

• डेवलपर पार्टनर का मौजूदा FeaturedCluster डेटा हटा दिया जाता है.
• अनुरोध से मिले डेटा को पार्स करके, अपडेट किए गए 'चुनिंदा क्लस्टर' में सेव किया जाता है.

किसी गड़बड़ी के मामले में, पूरा अनुरोध अस्वीकार कर दिया जाता है और मौजूदा स्थिति को बनाए रखा जाता है.

publishContinuationCluster

इस एपीआई का इस्तेमाल, ContinuationCluster ऑब्जेक्ट को पब्लिश करने के लिए किया जाता है.

client.publishContinuationCluster(
    PublishContinuationClusterRequest.Builder()
      .setContinuationCluster(
        ContinuationCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

जब सेवा को अनुरोध मिलता है, तो एक लेन-देन के अंदर ये कार्रवाइयां होती हैं:

• डेवलपर पार्टनर का मौजूदा ContinuationCluster डेटा हटा दिया जाता है.
• अनुरोध से मिले डेटा को पार्स करके, अपडेट किए गए 'जारी रखने वाले क्लस्टर' में सेव किया जाता है.

किसी गड़बड़ी के मामले में, पूरा अनुरोध अस्वीकार कर दिया जाता है और मौजूदा स्थिति को बनाए रखा जाता है.

publishUserAccountManagementRequest

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

साइन इन कार्ड में यह मेटाडेटा शामिल होता है -

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

जब सेवा को अनुरोध मिलता है, तो एक लेन-देन के अंदर ये कार्रवाइयां होती हैं:

• डेवलपर पार्टनर से मिला मौजूदा UserAccountManagementCluster डेटा हटा दिया जाता है.
• अनुरोध से मिले डेटा को पार्स करके, अपडेट किए गए UserAccountManagementCluster क्लस्टर में सेव किया जाता है.

किसी गड़बड़ी के मामले में, पूरा अनुरोध अस्वीकार कर दिया जाता है और मौजूदा स्थिति को बनाए रखा जाता है.

updatePublishStatus

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

• सभी स्थितियों में स्टेटस की जानकारी देना ज़रूरी है. भले ही, कॉन्टेंट पब्लिश हो गया हो (STATUS == PUBLISHED). इससे उन डैशबोर्ड को पॉप्युलेट करने में मदद मिलती है जो आपके इंटिग्रेशन की परफ़ॉर्मेंस और अन्य मेट्रिक की जानकारी देने के लिए, इस स्टेटस का इस्तेमाल करते हैं.
• अगर कोई कॉन्टेंट पब्लिश नहीं किया गया है, लेकिन इंटिग्रेशन की स्थिति नहीं टूटी है (STATUS == NOT_PUBLISHED), तो Google, ऐप्लिकेशन की परफ़ॉर्मेंस के डैशबोर्ड में सूचनाएं ट्रिगर करने से बच सकता है. इससे यह पुष्टि होती है कि कॉन्टेंट को पब्लिश न करने की वजह, सेवा देने वाली कंपनी की ओर से उम्मीद के मुताबिक स्थिति है.
• इससे डेवलपर को यह जानकारी मिलती है कि डेटा कब पब्लिश किया गया और कब नहीं.
• Google, स्टेटस कोड का इस्तेमाल करके उपयोगकर्ता को ऐप्लिकेशन में कुछ कार्रवाइयां करने के लिए कह सकता है, ताकि वह ऐप्लिकेशन का कॉन्टेंट देख सके या समस्या को हल कर सके.

पब्लिश करने की ज़रूरी शर्तें पूरी करने वाले स्टेटस कोड की सूची :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

अगर उपयोगकर्ता के लॉग इन न होने की वजह से कॉन्टेंट पब्लिश नहीं होता है, तो Google, साइन इन कार्ड पब्लिश करने का सुझाव देगा. अगर किसी वजह से सेवा देने वाली कंपनियां, साइन इन कार्ड पब्लिश नहीं कर पाती हैं, तो हमारा सुझाव है कि वे स्टेटस कोड NOT_PUBLISHED_REQUIRES_SIGN_IN के साथ updatePublishStatus एपीआई को कॉल करें

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationsClusters

इस एपीआई का इस्तेमाल, सुझाव वाले क्लस्टर का कॉन्टेंट मिटाने के लिए किया जाता है.

client.deleteRecommendationsClusters()

client.deleteRecommendationsClusters();

अनुरोध मिलने पर, सेवा सुझाव क्लस्टर से मौजूदा डेटा को हटा देती है. किसी गड़बड़ी के मामले में, पूरा अनुरोध अस्वीकार कर दिया जाता है और मौजूदा स्थिति बनी रहती है.

deleteFeaturedCluster

इस एपीआई का इस्तेमाल, 'चुनिंदा क्लस्टर' का कॉन्टेंट मिटाने के लिए किया जाता है.

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

अनुरोध मिलने पर, सेवा, चुनिंदा क्लस्टर से मौजूदा डेटा को हटा देती है. किसी गड़बड़ी के मामले में, पूरा अनुरोध अस्वीकार कर दिया जाता है और मौजूदा स्थिति बनी रहती है.

deleteContinuationCluster

इस एपीआई का इस्तेमाल, 'जारी रखने वाले क्लस्टर' का कॉन्टेंट मिटाने के लिए किया जाता है.

client.deleteContinuationCluster()

client.deleteContinuationCluster();

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

deleteUserManagementCluster

इस एपीआई का इस्तेमाल, UserAccountManagement क्लस्टर का कॉन्टेंट मिटाने के लिए किया जाता है.

client.deleteUserManagementCluster()

client.deleteUserManagementCluster();

अनुरोध मिलने पर, सेवा UserAccountManagement क्लस्टर से मौजूदा डेटा को हटा देती है. कोई गड़बड़ी होने पर, पूरा अनुरोध अस्वीकार कर दिया जाता है और मौजूदा स्थिति बनी रहती है.

deleteClusters

इस एपीआई का इस्तेमाल, किसी क्लस्टर टाइप का कॉन्टेंट मिटाने के लिए किया जाता है.

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_CONTINUATION)
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      .build())

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_CONTINUATION)
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                .build());

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

गड़बड़ी ठीक करना

हमारा सुझाव है कि पब्लिश एपीआई से टास्क के नतीजे को सुनें, ताकि टास्क को फिर से सबमिट करने और उसे पूरा करने के लिए फ़ॉलो-अप कार्रवाई की जा सके.

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

गड़बड़ी को AppEngageException के तौर पर दिखाया जाता है. इसमें गड़बड़ी की वजह को गड़बड़ी के कोड के तौर पर शामिल किया जाता है.

तीसरा चरण: ब्रॉडकास्ट इंटेंट को मैनेज करना

किसी जॉब के ज़रिए कॉन्टेंट पब्लिश करने वाले एपीआई कॉल करने के अलावा, कॉन्टेंट पब्लिश करने का अनुरोध पाने के लिए, BroadcastReceiver सेट अप करना भी ज़रूरी है.

ब्रॉडकास्ट इंटेंट का मकसद, मुख्य रूप से ऐप्लिकेशन को फिर से चालू करना और डेटा को सिंक करने के लिए मजबूर करना है. ब्रॉडकास्ट इंटेंट को बार-बार भेजने के लिए डिज़ाइन नहीं किया गया है. यह सिर्फ़ तब ट्रिगर होता है, जब Engage Service को लगता है कि कॉन्टेंट पुराना हो सकता है. उदाहरण के लिए, एक हफ़्ते पुराना. इससे यह भरोसा बढ़ता है कि उपयोगकर्ता को नया कॉन्टेंट देखने को मिलेगा. भले ही, ऐप्लिकेशन को लंबे समय से इस्तेमाल न किया गया हो.

BroadcastReceiver को इन दो तरीकों से सेट अप करना ज़रूरी है:

• Context.registerReceiver() का इस्तेमाल करके, BroadcastReceiver क्लास के इंस्टेंस को डाइनैमिक तरीके से रजिस्टर करें. इससे उन ऐप्लिकेशन से बातचीत की जा सकती है जो अब भी मेमोरी में लाइव हैं.

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
  // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
  // received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Continuation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)
}

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
// received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                          new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
                          com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                          /*scheduler=*/null);

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

}

• अपनी AndroidManifest.xml फ़ाइल में, <receiver> टैग के साथ स्टैटिक तौर पर एलान करें कि आपने इस सुविधा को लागू किया है. इससे ऐप्लिकेशन को ब्रॉडकास्ट इंटेंट मिलते हैं, भले ही वह चालू न हो. साथ ही, ऐप्लिकेशन को कॉन्टेंट पब्लिश करने की अनुमति भी मिलती है.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
      </intent-filter>
   </receiver>
</application>

सेवा, ये इंटेंट भेजती है:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION यह इंटेंट मिलने पर, publishRecommendationClusters कॉल शुरू करने का सुझाव दिया जाता है.
• com.google.android.engage.action.PUBLISH_FEATURED हमारा सुझाव है कि यह इंटेंट मिलने पर, publishFeaturedCluster कॉल शुरू करें.
• com.google.android.engage.action.PUBLISH_CONTINUATION हमारा सुझाव है कि यह इंटेंट मिलने पर, publishContinuationCluster कॉल शुरू करें.

इंटिग्रेशन वर्कफ़्लो

इंटिग्रेशन पूरा होने के बाद, उसकी पुष्टि करने के सिलसिलेवार निर्देशों के लिए, Engage डेवलपर इंटिग्रेशन वर्कफ़्लो देखें.

अक्सर पूछे जाने वाले सवाल

अक्सर पूछे जाने वाले सवालों के लिए, Engage SDK के बारे में अक्सर पूछे जाने वाले सवाल देखें.

संपर्क

अगर इंटिग्रेशन की प्रोसेस के दौरान आपको कोई सवाल पूछना है, तो engage-developers@google.com से संपर्क करें.

अगले चरण

इस इंटिग्रेशन को पूरा करने के बाद, आपको ये काम करने होंगे:

• engage-developers@google.com पर ईमेल भेजें और इंटिग्रेट किया गया अपना APK अटैच करें, ताकि Google उसकी जांच कर सके.
• Google, इंटिग्रेशन की पुष्टि करता है और इसकी समीक्षा करता है, ताकि यह पक्का किया जा सके कि इंटिग्रेशन उम्मीद के मुताबिक काम कर रहा है. अगर बदलावों की ज़रूरत होगी, तो Google आपसे संपर्क करेगा और ज़रूरी जानकारी देगा.
• जांच पूरी होने और कोई बदलाव न होने पर, Google आपसे संपर्क करके आपको सूचना देता है कि अपडेट किए गए और इंटिग्रेट किए गए APK को Play Store पर पब्लिश किया जा सकता है.
• जब Google इस बात की पुष्टि कर देगा कि आपका अपडेट किया गया APK, Play Store पर पब्लिश हो गया है, तो आपके सुझाव, चुनिंदा, और जारी रखें क्लस्टर पब्लिश किए जा सकते हैं. साथ ही, ये उपयोगकर्ताओं को दिख सकते हैं.