FCM का इस्तेमाल शुरू करने के लिए, सबसे आसान यूज़ केस बनाएं: जब ऐप्लिकेशन डिवाइस पर बैकग्राउंड में हो, तब सूचनाएं कंपोज़र से, डिवाइस पर टेस्ट सूचना मैसेज भेजें. इस पेज पर, सेटअप से लेकर पुष्टि तक के सभी चरणों की जानकारी दी गई है. अगर आपने FCM के लिए Android क्लाइंट ऐप्लिकेशन सेट अप कर लिया है, तो हो सकता है कि इसमें वे चरण भी शामिल हों जिन्हें आपने पहले ही पूरा कर लिया है.
SDK टूल सेट अप करें
अगर आपने अपने ऐप्लिकेशन के लिए Firebase की अन्य सुविधाएं पहले से ही चालू कर ली हैं, तो हो सकता है कि आपने इस सेक्शन में दिए गए टास्क पूरे कर लिए हों.
शुरू करने से पहले
Android Studio को इंस्टॉल करें या उसके नए वर्शन पर अपडेट करें.
पक्का करें कि आपका प्रोजेक्ट इन ज़रूरी शर्तों को पूरा करता हो. ध्यान दें कि कुछ प्रॉडक्ट के लिए ज़्यादा सख्त शर्तें हो सकती हैं:
- एपीआई लेवल 21 (Lollipop) या उसके बाद के वर्शन को टारगेट करता हो
- जो Android 5.0 या इसके बाद वाले वर्शन पर काम करते हों
- Jetpack (AndroidX) का इस्तेमाल करता है. इसमें वर्शन की इन ज़रूरी शर्तों को पूरा करना शामिल है:
com.android.tools.build:gradle
v7.3.0 या उसके बाद का वर्शनcompileSdkVersion
28 या उसके बाद का वर्शन
अपने ऐप्लिकेशन को चलाने के लिए, कोई फ़िज़िकल डिवाइस सेट अप करें या एम्युलेटर का इस्तेमाल करें.
ध्यान दें कि Google Play services पर निर्भर Firebase SDK टूल के लिए, डिवाइस या एम्युलेटर पर Google Play services इंस्टॉल होना ज़रूरी है.अपने Google खाते का इस्तेमाल करके, Firebase में साइन इन करें.
अगर आपके पास पहले से कोई Android प्रोजेक्ट नहीं है और आपको सिर्फ़ Firebase प्रॉडक्ट आज़माना है, तो हमारे क्विकस्टार्ट सैंपल में से कोई एक डाउनलोड किया जा सकता है.
Firebase प्रोजेक्ट बनाना
अपने Android ऐप्लिकेशन में Firebase जोड़ने से पहले, आपको अपने Android ऐप्लिकेशन से कनेक्ट करने के लिए Firebase प्रोजेक्ट बनाना होगा. Firebase प्रोजेक्ट के बारे में ज़्यादा जानने के लिए, Firebase प्रोजेक्ट के बारे में जानकारी लेख पढ़ें.
अपने ऐप्लिकेशन को Firebase के साथ रजिस्टर करना
अपने Android ऐप्लिकेशन में Firebase का इस्तेमाल करने के लिए, आपको अपने ऐप्लिकेशन को अपने Firebase प्रोजेक्ट के साथ रजिस्टर करना होगा. अपने ऐप्लिकेशन को रजिस्टर करने को, अक्सर अपने प्रोजेक्ट में ऐप्लिकेशन को "जोड़ना" कहा जाता है.
Firebase कंसोल पर जाएं.
सेटअप वर्कफ़्लो को लॉन्च करने के लिए, प्रोजेक्ट की खास जानकारी देने वाले पेज के बीच में मौजूद, Android आइकॉन (
) या ऐप्लिकेशन जोड़ें पर क्लिक करें.Android पैकेज का नाम फ़ील्ड में, अपने ऐप्लिकेशन का पैकेज नाम डालें.
(ज़रूरी नहीं) ऐप्लिकेशन की अन्य जानकारी डालें: ऐप्लिकेशन का कोई दूसरा नाम और डीबग साइनिंग सर्टिफ़िकेट SHA-1.
ऐप्लिकेशन रजिस्टर करें पर क्लिक करें.
Firebase कॉन्फ़िगरेशन फ़ाइल जोड़ना
डाउनलोड करें और फिर अपने ऐप्लिकेशन में Firebase Android कॉन्फ़िगरेशन फ़ाइल (
) जोड़ें:google-services.json Firebase की Android कॉन्फ़िगरेशन फ़ाइल पाने के लिए, google-services.json डाउनलोड करें पर क्लिक करें.
अपनी कॉन्फ़िगरेशन फ़ाइल को ऐप्लिकेशन के मॉड्यूल (ऐप्लिकेशन-लेवल) रूट डायरेक्ट्री में ले जाएं.
अपनी
कॉन्फ़िगरेशन फ़ाइल में मौजूद वैल्यू को Firebase SDK टूल के लिए ऐक्सेस करने के लिए, आपके पास Google services Gradle प्लग इन (google-services.json google-services
) होना चाहिए.अपनी रूट-लेवल (प्रोजेक्ट-लेवल) की Gradle फ़ाइल (
<project>/build.gradle.kts
या<project>/build.gradle
) में, डिपेंडेंसी के तौर पर Google सेवाएं प्लगिन जोड़ें:Kotlin
plugins { id("com.android.application") version "7.3.0" apply false // ... // Add the dependency for the Google services Gradle plugin id("com.google.gms.google-services") version "4.4.2" apply false }
Groovy
plugins { id 'com.android.application' version '7.3.0' apply false // ... // Add the dependency for the Google services Gradle plugin id 'com.google.gms.google-services' version '4.4.2' apply false }
अपने मॉड्यूल (ऐप्लिकेशन-लेवल) Gradle फ़ाइल (आम तौर पर
<project>/<app-module>/build.gradle.kts
या<project>/<app-module>/build.gradle
) में, Google की सेवाएं प्लगिन जोड़ें:Kotlin
plugins { id("com.android.application") // Add the Google services Gradle plugin id("com.google.gms.google-services") // ... }
Groovy
plugins { id 'com.android.application' // Add the Google services Gradle plugin id 'com.google.gms.google-services' // ... }
अपने ऐप्लिकेशन में Firebase SDK टूल जोड़ना
अपनी मॉड्यूल (ऐप्लिकेशन-लेवल) Gradle फ़ाइल (आम तौर पर
<project>/<app-module>/build.gradle.kts
या<project>/<app-module>/build.gradle
) में, Android के लिए Firebase Cloud Messaging लाइब्रेरी की डिपेंडेंसी जोड़ें. लाइब्रेरी के वर्शन को कंट्रोल करने के लिए, हमारा सुझाव है कि आप Firebase Android BoM का इस्तेमाल करें.Firebase Cloud Messaging का बेहतर अनुभव पाने के लिए, हमारा सुझाव है कि आप अपने Firebase प्रोजेक्ट में Google Analytics को चालू करें और अपने ऐप्लिकेशन में Firebase के लिए Google Analytics SDK टूल जोड़ें.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.5.1")) // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging") implementation("com.google.firebase:firebase-analytics") }
Firebase Android BoM का इस्तेमाल करने पर, आपका ऐप्लिकेशन हमेशा Firebase Android लाइब्रेरी के काम करने वाले वर्शन का इस्तेमाल करेगा.
(विकल्प) BoM का इस्तेमाल किए बिना Firebase लाइब्रेरी की डिपेंडेंसी जोड़ें
अगर आपको Firebase BoM का इस्तेमाल नहीं करना है, तो आपको उसकी डिपेंडेंसी लाइन में, Firebase लाइब्रेरी के हर वर्शन की जानकारी देनी होगी.
ध्यान दें कि अगर आपके ऐप्लिकेशन में एक से ज़्यादा Firebase लाइब्रेरी का इस्तेमाल किया जाता है, तो हमारा सुझाव है कि आप लाइब्रेरी के वर्शन मैनेज करने के लिए BoM का इस्तेमाल करें. इससे यह पक्का होता है कि सभी वर्शन काम करते हों.
dependencies { // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging:24.0.3") implementation("com.google.firebase:firebase-analytics:22.1.2") }
अपने Android प्रोजेक्ट को Gradle फ़ाइलों के साथ सिंक करें.
रजिस्ट्रेशन टोकन ऐक्सेस करना
किसी डिवाइस पर मैसेज भेजने के लिए, आपको उस डिवाइस का रजिस्टरेशन टोकन पता होना चाहिए. इस ट्यूटोरियल को पूरा करने के लिए, आपको सूचना कंसोल में मौजूद किसी फ़ील्ड में टोकन डालना होगा. इसलिए, टोकन को कॉपी करना न भूलें या वापस पाने के बाद उसे सुरक्षित तरीके से सेव करें.
आपके ऐप्लिकेशन के शुरू होने पर, FCM SDK टूल, क्लाइंट ऐप्लिकेशन इंस्टेंस के लिए रजिस्ट्रेशन टोकन जनरेट करता है. अगर आपको किसी एक डिवाइस को टारगेट करना है या
डिवाइस ग्रुप बनाना है, तो आपको
FirebaseMessagingService
की समयसीमा बढ़ाकर और onNewToken
को ओवरराइड करके, इस टोकन को ऐक्सेस करना होगा.
इस सेक्शन में, टोकन को फिर से पाने और उसमें हुए बदलावों को मॉनिटर करने का तरीका बताया गया है. शुरुआती स्टार्टअप के बाद, टोकन को बदला जा सकता है. इसलिए, हमारा सुझाव है कि आप अपडेट किया गया नया रजिस्ट्रेशन टोकन पाएं.
रजिस्ट्रेशन टोकन तब बदल सकता है, जब:
- ऐप्लिकेशन को नए डिवाइस पर वापस लाया गया हो
- जब उपयोगकर्ता ऐप्लिकेशन को अनइंस्टॉल करता है/फिर से इंस्टॉल करता है
- उपयोगकर्ता, ऐप्लिकेशन का डेटा मिटाता है.
मौजूदा रजिस्ट्रेशन टोकन वापस पाएं
जब आपको मौजूदा टोकन वापस पाना हो, तो
FirebaseMessaging.getInstance().getToken()
को कॉल करें:
Kotlin+KTX
FirebaseMessaging.getInstance().token.addOnCompleteListener(OnCompleteListener { task -> if (!task.isSuccessful) { Log.w(TAG, "Fetching FCM registration token failed", task.exception) return@OnCompleteListener } // Get new FCM registration token val token = task.result // Log and toast val msg = getString(R.string.msg_token_fmt, token) Log.d(TAG, msg) Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show() })
Java
FirebaseMessaging.getInstance().getToken() .addOnCompleteListener(new OnCompleteListener<String>() { @Override public void onComplete(@NonNull Task<String> task) { if (!task.isSuccessful()) { Log.w(TAG, "Fetching FCM registration token failed", task.getException()); return; } // Get new FCM registration token String token = task.getResult(); // Log and toast String msg = getString(R.string.msg_token_fmt, token); Log.d(TAG, msg); Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show(); } });
टोकन जनरेशन को मॉनिटर करना
नया टोकन जनरेट होने पर, onNewToken
कॉलबैक ट्रिगर होता है.
Kotlin+KTX
/** * 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. sendRegistrationToServer(token) }
Java
/** * There are two scenarios when onNewToken is called: * 1) When a new token is generated on initial app startup * 2) Whenever an existing token is changed * Under #2, there are three scenarios when the existing token is changed: * A) App is restored to a new device * B) User uninstalls/reinstalls the app * C) User clears app data */ @Override public void onNewToken(@NonNull String token) { 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. sendRegistrationToServer(token); }
टोकन मिलने के बाद, उसे अपने ऐप्लिकेशन सर्वर पर भेजा जा सकता है और अपने पसंदीदा तरीके का इस्तेमाल करके उसे सेव किया जा सकता है.
सूचना भेजने की सुविधा की जांच करने के लिए मैसेज भेजना
टारगेट किए गए डिवाइस पर ऐप्लिकेशन इंस्टॉल करें और चलाएं. Apple डिवाइसों पर, रिमोट नोटिफ़िकेशन पाने के लिए आपको अनुरोध स्वीकार करना होगा.
पक्का करें कि ऐप्लिकेशन, डिवाइस के बैकग्राउंड में चल रहा हो.
Firebase कंसोल में, मैसेज सेवा वाला पेज खोलें.
अगर यह आपका पहला मैसेज है, तो अपना पहला कैंपेन बनाएं चुनें.
- Firebase सूचना मैसेज चुनें और बनाएं चुनें.
इसके अलावा, कैंपेन टैब में, नया कैंपेन चुनें. इसके बाद, सूचनाएं चुनें.
मैसेज का टेक्स्ट डालें. बाकी सभी फ़ील्ड ज़रूरी नहीं हैं.
दाएं पैनल से, टेस्ट मैसेज भेजें को चुनें.
FCM रजिस्ट्रेशन टोकन जोड़ें लेबल वाले फ़ील्ड में, इस गाइड के पिछले सेक्शन में मिला रजिस्ट्रेशन टोकन डालें.
जांचें को चुनें.
जांच करें चुनने के बाद, टारगेट किए गए क्लाइंट डिवाइस (जिस पर ऐप्लिकेशन बैकग्राउंड में चल रहा है) को सूचना मिलनी चाहिए.
अपने ऐप्लिकेशन पर मैसेज डिलीवरी की अहम जानकारी पाने के लिए, FCM रिपोर्टिंग डैशबोर्ड देखें. इसमें, Apple और Android डिवाइसों पर भेजे गए और खोले गए मैसेज की संख्या के साथ-साथ, Android ऐप्लिकेशन के लिए "इंप्रेशन" (उपयोगकर्ताओं को मिली सूचनाएं) का डेटा भी रिकॉर्ड किया जाता है.
अगले चरण
फ़ोरग्राउंड में चलने वाले ऐप्लिकेशन पर मैसेज भेजें
ऐप्लिकेशन बैकग्राउंड में होने पर सूचना मैसेज भेजने के बाद, फ़ोरग्राउंड में मौजूद ऐप्लिकेशन पर मैसेज भेजने के लिए, Android ऐप्लिकेशन में मैसेज पाना लेख पढ़ें.
सूचना वाले मैसेज के अलावा अन्य सुविधाएं भी पाएं
सूचना मैसेज के अलावा, अपने ऐप्लिकेशन में और भी बेहतर सुविधाएं जोड़ने के लिए, यह लेख पढ़ें: