FCM का इस्तेमाल शुरू करने के लिए, इस्तेमाल का सबसे आसान उदाहरण बनाएं: डिवाइस पर बैकग्राउंड में ऐप्लिकेशन होने पर, सूचनाएं देने वाले की ओर से डेवलपमेंट डिवाइस को टेस्ट की सूचना वाला मैसेज भेजें. इस पेज पर, सेट अप करने से लेकर पुष्टि करने तक के सभी चरण बताए गए हैं. अगर आपने FCM के लिए Android क्लाइंट ऐप्लिकेशन सेट अप किया है, तो इसमें उन चरणों को शामिल किया जा सकता है जिन्हें आपने पहले ही पूरा कर लिया है.
SDK टूल सेट अप करना
इस सेक्शन में ऐसे टास्क होते हैं जिन्हें आपने पहले ही पूरा कर लिया है. ऐसा तब होता है, जब आपने अपने ऐप्लिकेशन के लिए Firebase की दूसरी सुविधाएं पहले से चालू की हों.
शुरू करने से पहले
Android Studio को इसके सबसे नए वर्शन में इंस्टॉल या अपडेट करें.
पक्का करें कि आपका प्रोजेक्ट इन शर्तों को पूरा करता हो (ध्यान दें कि कुछ प्रॉडक्ट की शर्तें ज़्यादा सख्त हो सकती हैं):
- टारगेट एपीआई लेवल 19 (KitKat) या उससे बाद का टारगेट
- जो Android 4.4 या इसके बाद वाले वर्शन पर काम करते हों
- Jetpack (AndroidX) का इस्तेमाल करता है. इसमें ये वर्शन शामिल हैं:
com.android.tools.build:gradle
v7.3.0 या उसके बाद के वर्शनcompileSdkVersion
28 या उसके बाद
अपने ऐप्लिकेशन को चलाने के लिए, फ़िज़िकल डिवाइस सेट अप करें या एम्युलेटर का इस्तेमाल करें.
ध्यान दें कि Google Play services पर निर्भर रहने वाले Firebase SDK टूल के लिए डिवाइस या एम्युलेटर का इस्तेमाल करना ज़रूरी है.अपने 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 services प्लगिन को डिपेंडेंसी के तौर पर जोड़ें: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.1" 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.1' 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 क्लाउड से मैसेज लाइब्रेरी के लिए डिपेंडेंसी जोड़ें. लाइब्रेरी वर्शन को कंट्रोल करने के लिए, Firebase Android BoM का इस्तेमाल करने का सुझाव दिया जाता है.'Firebase क्लाउड से मैसेज' का बेहतर अनुभव पाने के लिए, हमारा सुझाव है कि अपने Firebase प्रोजेक्ट में Google Analytics चालू करें. साथ ही, अपने ऐप्लिकेशन में Google Analytics के लिए Firebase SDK टूल जोड़ें.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.0.0")) // 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.0") implementation("com.google.firebase:firebase-analytics:22.0.0") }
अपने 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 ऐप्लिकेशन में Messages पाएं देखें.
सूचना वाले मैसेज के अलावा भी बहुत कुछ करें
सूचना वाले मैसेज के अलावा, अपने ऐप्लिकेशन में अन्य बेहतर सुविधाएं जोड़ने के लिए, यहां देखें: