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

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

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

शब्दावली

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

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

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

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

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

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

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

      

    • PersonEntity: PersonEntity किसी व्यक्ति के बारे में जानकारी देता है. हमारा सुझाव है कि आप एक कोच या स्वास्थ्य और फ़िटनेस से जुड़े किसी व्यक्ति को हाइलाइट करें.

      

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

      

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

  वीडियो के आगे का कॉन्टेंट इस स्ट्रक्चर में हो सकता है:

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

    

  • EventReservationEntity: EventReservationEntity, किसी इवेंट के लिए किए गए रिज़र्वेशन की जानकारी दिखाती है. साथ ही, यह उपयोगकर्ताओं को आने वाले समय में होने वाले या चल रहे फ़िटनेस और सेहत से जुड़े इवेंट के रिज़र्वेशन को ट्रैक करने में मदद करती है. उदाहरण: ट्रेनिंग सेशन

    

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

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

    

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

कम से कम एपीआई लेवल: 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.5.2'
}

खास जानकारी

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

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

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

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. लेखEntity और जेनेरिक सुविधाओं वाली इकाई जैसी कुछ इकाइयां, किसी भी कॉन्टेंट कैटगरी का इस्तेमाल कर सकती हैं. EventEntity, EventReservationEntity, PersonEntity जैसी अन्य इकाइयों के लिए, इन कैटगरी का सिर्फ़ एक सबसेट ज़रूरी शर्तें पूरी करता है. सूची में जानकारी भरने से पहले, इकाई के टाइप के लिए ज़रूरी शर्तें पूरी करने वाली कैटगरी की सूची देखें.

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

   • TYPE_MOVIES_AND_TV_SHOWS - सामान्य इकाइयों का इस्तेमाल करने से पहले, Watch के साथ इंटिग्रेशन की गाइड में दी गई इकाइयों को देखें.
   • 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

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

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 PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    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 साइन इन कार्ड पब्लिश करने का सुझाव देगा. अगर किसी वजह से, सेवा देने वाली कंपनियां साइन इन कार्ड पब्लिश नहीं कर पा रही हैं, तो हमारा सुझाव है कि वे updatePublishStatus एपीआई को कॉल करें. इसके लिए, स्टेटस कोड के तौर पर NOT_PUBLISHED_REQUIRES_SIGN_IN का इस्तेमाल करें

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());

deleteRecommendationClusters

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

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

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

deleteFeaturedCluster

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

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

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

deleteContinuationCluster

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

client.deleteContinuationCluster()

client.deleteContinuationCluster();

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

deleteUserManagementCluster

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

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 के तौर पर दिखाया जाता है. साथ ही, गड़बड़ी की वजह को गड़बड़ी कोड के तौर पर शामिल किया जाता है.

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

किसी जॉब के ज़रिए कॉन्टेंट पब्लिश करने के लिए Content API कॉल करने के अलावा, कॉन्टेंट पब्लिश करने का अनुरोध पाने के लिए, 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))

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))

// Register Continuation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION))
}

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));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION));

}

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

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      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 कॉल शुरू करें.

एकीकरण वर्कफ़्लो

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

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

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

संपर्क

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

अगले चरण

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

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