FCM रजिस्ट्रेशन टोकन को मैनेज करने के सबसे सही तरीके

अगर आपने प्रोग्राम के हिसाब से अनुरोध भेजने के लिए FCM एपीआई का इस्तेमाल किया है, तो आपको समय के साथ यह पता चल सकता है कि आपने ऐसे डिवाइसों को मैसेज भेजकर संसाधनों को बर्बाद किया है जो अब इस्तेमाल में नहीं हैं. ऐसा इसलिए, क्योंकि उनके रजिस्ट्रेशन टोकन पुराने हो चुके हैं. इस वजह से, Firebase कंसोल में रिपोर्ट किए गए मैसेज की डिलीवरी के डेटा या BigQuery में एक्सपोर्ट किए गए डेटा पर असर पड़ सकता है. इससे डिलीवरी रेट में अचानक (लेकिन असल में मान्य नहीं) गिरावट दिख सकती है. इस गाइड में, मैसेज को सही लोगों तक पहुंचाने और डिलीवरी की मान्य रिपोर्टिंग के लिए, कुछ तरीके बताए गए हैं.

पुराने और समयसीमा खत्म हो चुके रजिस्ट्रेशन टोकन

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

टोकन के पुराने होने की कई वजहें हो सकती हैं. उदाहरण के लिए, जिस डिवाइस से टोकन जुड़ा है वह खो सकता है, खराब हो सकता है या उसे किसी जगह पर रखा जा सकता है और फिर उसे भूल जाया जा सकता है.

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

सबसे सही तरीके

ऐसे किसी भी ऐप्लिकेशन में आपको कुछ बुनियादी तरीकों का पालन करना चाहिए जो प्रोग्राम के हिसाब से अनुरोध भेजने के लिए FCM एपीआई का इस्तेमाल करता है. सबसे सही तरीके ये हैं:

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

रजिस्ट्रेशन टोकन वापस पाना और उन्हें सेव करना

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

हमारा सुझाव है कि आपका ऐप्लिकेशन, शुरुआती स्टार्टअप पर इस टोकन को वापस पाए और इसे अपने ऐप्लिकेशन सर्वर पर टाइमस्टैंप के साथ सेव करे. इस टाइमस्टैंप को आपके कोड और सर्वर से लागू किया जाना चाहिए, क्योंकि FCM SDK टूल इसे आपके लिए उपलब्ध नहीं कराते हैं.

साथ ही, टोकन को सर्वर पर सेव करना और जब भी इसमें बदलाव हो, तब टाइमस्टैंप अपडेट करना ज़रूरी है. जैसे:

  • ऐप्लिकेशन को किसी नए डिवाइस पर वापस लाया गया हो
  • जब उपयोगकर्ता ऐप्लिकेशन को अनइंस्टॉल या फिर से इंस्टॉल करता है
  • उपयोगकर्ता, ऐप्लिकेशन का डेटा मिटाता है
  • ऐप्लिकेशन, FCM के मौजूदा टोकन की समयसीमा खत्म होने के बाद फिर से ऐक्टिव हो जाता है

उदाहरण: स्टोर टोकन और टाइमस्टैंप को Cloud Firestore में सेव करना

उदाहरण के लिए, fcmTokens नाम के कलेक्शन में टोकन सेव करने के लिए, Cloud Firestore का इस्तेमाल किया जा सकता है. संग्रह में मौजूद हर दस्तावेज़ आईडी, किसी उपयोगकर्ता आईडी से जुड़ा होता है. साथ ही, दस्तावेज़ में मौजूदा रजिस्ट्रेशन टोकन और उसके अपडेट होने का टाइमस्टैंप सेव होता है. set फ़ंक्शन का इस्तेमाल करें. जैसा कि Kotlin के इस उदाहरण में दिखाया गया है:

    /**
     * Persist token to third-party servers.
     *
     * Modify this method to associate the user's FCM registration token with any server-side account
     * maintained by your application.
     *
     * @param token The new token.
     */
    private fun sendTokenToServer(token: String?) {
        // If you're running your own server, call API to send token and today's date for the user

        // Example shown below with Firestore
        // Add token and timestamp to Firestore for this user
        val deviceToken = hashMapOf(
            "token" to token,
            "timestamp" to FieldValue.serverTimestamp(),
        )
        // Get user ID from Firebase Auth or your own server
        Firebase.firestore.collection("fcmTokens").document("myuserid")
            .set(deviceToken)
    }
MyFirebaseMessagingService.kt

जब भी कोई टोकन वापस पाया जाता है, तो उसे Cloud Firestore में सेव किया जाता है. इसके लिए, sendTokenToServer को कॉल किया जाता है:

    /**
     * Called if the FCM registration token is updated. This may occur if the security of
     * the previous token had been compromised. Note that this is called when the
     * FCM registration token is initially generated so this is where you would retrieve the token.
     */
    override fun onNewToken(token: String) {
        Log.d(TAG, "Refreshed token: $token")

        // If you want to send messages to this application instance or
        // manage this apps subscriptions on the server side, send the
        // FCM registration token to your app server.
        sendTokenToServer(token)
    }
MyFirebaseMessagingService.kt

        var token = Firebase.messaging.token.await()

        // Check whether the retrieved token matches the one on your server for this user's device
        val preferences = this.getPreferences(Context.MODE_PRIVATE)
        val tokenStored = preferences.getString("deviceToken", "")
        lifecycleScope.launch {
            if (tokenStored == "" || tokenStored != token)
            {
                // If you have your own server, call API to send the above token and Date() for this user's device

                // Example shown below with Firestore
                // Add token and timestamp to Firestore for this user
                val deviceToken = hashMapOf(
                    "token" to token,
                    "timestamp" to FieldValue.serverTimestamp(),
                )

                // Get user ID from Firebase Auth or your own server
                Firebase.firestore.collection("fcmTokens").document("myuserid")
                    .set(deviceToken).await()
            }
        }

MainActivity.kt

टोकन को अपडेट रखना और पुराने टोकन हटाना

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

आपके इस्तेमाल के हिसाब से, एक महीना बहुत कम या बहुत ज़्यादा हो सकता है. इसलिए, यह तय करना आपका काम है कि आपके लिए कौनसी शर्तें सही हैं.

FCM बैकएंड से मिले अमान्य टोकन रिस्पॉन्स का पता लगाना

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

  • UNREGISTERED (एचटीटीपी 404)
  • INVALID_ARGUMENT (एचटीटीपी 400)

अगर आपको लगता है कि मैसेज पेलोड मान्य है और आपको टारगेट किए गए टोकन के लिए इनमें से कोई एक जवाब मिलता है, तो इस टोकन का रिकॉर्ड मिटाना सुरक्षित है. ऐसा इसलिए, क्योंकि यह टोकन कभी भी मान्य नहीं होगा. उदाहरण के लिए, Cloud Firestore से अमान्य टोकन मिटाने के लिए, इस तरह के फ़ंक्शन को डिप्लॉय और चलाया जा सकता है:

    // Registration token comes from the client FCM SDKs
    const registrationToken = 'YOUR_REGISTRATION_TOKEN';

    const message = {
    data: {
        // Information you want to send inside of notification
    },
    token: registrationToken
    };

    // Send message to device with provided registration token
    getMessaging().send(message)
    .then((response) => {
        // Response is a message ID string.
    })
    .catch((error) => {
        // Delete token for user if error code is UNREGISTERED or INVALID_ARGUMENT.
        if (errorCode == "messaging/registration-token-not-registered") {
            // If you're running your own server, call API to delete the
            token for the user

            // Example shown below with Firestore
            // Get user ID from Firebase Auth or your own server
            Firebase.firestore.collection("fcmTokens").document(user.uid).delete()
        }
    });

FCM सिर्फ़ तब अमान्य टोकन का जवाब देगा, जब टोकन 270 दिनों के बाद खत्म हो गया हो या क्लाइंट ने साफ़ तौर पर अनरजिस्टर कर दिया हो. अगर आपको अपनी परिभाषाओं के हिसाब से, स्टेलनेस को ज़्यादा सटीक तरीके से ट्रैक करना है, तो पुराने रजिस्ट्रेशन टोकन हटाएं.

टोकन को नियमित तौर पर अपडेट करना

हमारा सुझाव है कि आप समय-समय पर अपने सर्वर पर सभी रजिस्ट्रेशन टोकन वापस पाएं और उन्हें अपडेट करें. इसके लिए, आपको यह करना होगा:

  • अपने क्लाइंट ऐप्लिकेशन में ऐप्लिकेशन लॉजिक जोड़ें. इससे सही एपीआई कॉल (जैसे, Apple प्लैटफ़ॉर्म के लिए token(completion): या Android के लिए getToken()) का इस्तेमाल करके, मौजूदा टोकन को वापस पाया जा सकेगा. इसके बाद, मौजूदा टोकन को अपने ऐप्लिकेशन सर्वर पर भेजें, ताकि उसे टाइमस्टैंप के साथ सेव किया जा सके. यह हर महीने चलने वाली ऐसी प्रोसेस हो सकती है जिसे सभी क्लाइंट या टोकन को कवर करने के लिए कॉन्फ़िगर किया गया हो.
  • सर्वर लॉजिक जोड़कर, टोकन के टाइमस्टैंप को नियमित अंतराल पर अपडेट करें. भले ही, टोकन में बदलाव हुआ हो या नहीं.

WorkManager का इस्तेमाल करके टोकन अपडेट करने के लिए, Android लॉजिक का उदाहरण देखने के लिए, Firebase ब्लॉग पर Managing Cloud Messaging Tokens देखें.

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

पुराने रजिस्ट्रेशन टोकन हटाना

किसी डिवाइस को मैसेज भेजने से पहले, पक्का करें कि डिवाइस के रजिस्ट्रेशन टोकन का टाइमस्टैंप, स्टेलनेस विंडो की अवधि के अंदर हो. उदाहरण के लिए, Cloud Functions for Firebase को लागू करके हर दिन यह जांच की जा सकती है कि टाइमस्टैंप, const EXPIRATION_TIME = 1000 * 60 * 60 * 24 * 30; जैसी तय की गई स्टेलनेस विंडो की अवधि में है या नहीं. इसके बाद, पुराने टोकन हटाए जा सकते हैं:

exports.pruneTokens = functions.pubsub.schedule('every 24 hours').onRun(async (context) => {
  // Get all documents where the timestamp exceeds is not within the past month
  const staleTokensResult = await admin.firestore().collection('fcmTokens')
      .where("timestamp", "<", Date.now() - EXPIRATION_TIME)
      .get();
  // Delete devices with stale tokens
  staleTokensResult.forEach(function(doc) { doc.ref.delete(); });
});
index.js

विषयों से पुराने टोकन की सदस्यता छोड़ना

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

  1. आपका ऐप्लिकेशन, हर महीने एक बार और रजिस्ट्रेशन टोकन में बदलाव होने पर, विषयों के लिए फिर से सदस्यता लेगा. इससे एक ऐसा समाधान तैयार होता है जो खुद ठीक हो जाता है. इसमें, ऐप्लिकेशन के फिर से चालू होने पर सदस्यताएं अपने-आप दिखने लगती हैं.
  2. अगर कोई ऐप्लिकेशन इंस्टेंस एक महीने तक (या आपकी तय की गई अवधि तक) इस्तेमाल नहीं किया जाता है, तो आपको उसे विषयों से अनसब्सक्राइब करना चाहिए. इसके लिए, Firebase Admin SDK का इस्तेमाल करें. इससे FCM बैकएंड से, टोकन से विषय की मैपिंग मिट जाएगी.

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

डिलीवरी की सफलता का आकलन करना

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

किसी टोकन को मैसेज टारगेट करने से पहले, इन बातों का ध्यान रखें:

  • क्या Google Analytics, BigQuery में कैप्चर किया गया डेटा या अन्य ट्रैकिंग सिग्नल से पता चलता है कि टोकन चालू है?
  • क्या डिलीवरी करने की पिछली कोशिशें, तय समय में लगातार फ़ेल हुई हैं?
  • क्या पिछले महीने आपके सर्वर पर रजिस्ट्रेशन टोकन अपडेट किया गया था?
  • क्या Android डिवाइसों के लिए, FCM Data API, droppedDeviceInactive की वजह से मैसेज डिलीवर न होने की ज़्यादा दर रिपोर्ट करता है?

डिलीवरी के बारे में ज़्यादा जानकारी के लिए, मैसेज की डिलीवरी के बारे में जानकारी लेख पढ़ें.