Pour démarrer avec FCM, créez le cas d'utilisation le plus simple : envoyer un message de notification de test du compositeur de notifications à un appareil de développement lorsque l'application est en arrière-plan sur l'appareil. Cette page répertorie toutes les étapes pour y parvenir, de la configuration à la vérification. Elle peut couvrir les étapes que vous avez déjà effectuées si vous avez configuré une application client Android pour FCM.
Configurer le SDK
Cette section couvre les tâches que vous avez peut-être effectuées si vous avez déjà activé d'autres fonctionnalités Firebase pour votre application.
Avant que tu commences
Installez ou mettez à jour Android Studio vers sa dernière version.
Assurez-vous que votre projet répond à ces exigences :
- Cible le niveau d'API 19 (KitKat) ou supérieur
- Utilise Android 4.4 ou supérieur
- Utilise Jetpack (AndroidX) , qui inclut le respect de ces exigences de version :
-
com.android.tools.build:gradle
v7.3.0 ou version ultérieure -
compileSdkVersion
28 ou ultérieure
-
Configurez un appareil physique ou utilisez un émulateur pour exécuter votre application.
Notez que les SDK Firebase dépendant des services Google Play nécessitent que les services Google Play soient installés sur l'appareil ou l'émulateur.Connectez-vous à Firebase à l'aide de votre compte Google.
Si vous n'avez pas encore de projet Android et que vous souhaitez simplement essayer un produit Firebase, vous pouvez télécharger l'un de nos exemples de démarrage rapide .
Créer un projet Firebase
Avant de pouvoir ajouter Firebase à votre application Android, vous devez créer un projet Firebase pour vous connecter à votre application Android. Consultez Comprendre les projets Firebase pour en savoir plus sur les projets Firebase.
Enregistrez votre application avec Firebase
Pour utiliser Firebase dans votre application Android, vous devez enregistrer votre application avec votre projet Firebase. L'enregistrement de votre application est souvent appelé « ajouter » votre application à votre projet.
Accédez à la console Firebase .
Au centre de la page de présentation du projet, cliquez sur l'icône Android (
) ou sur Ajouter une application pour lancer le workflow de configuration.Saisissez le nom du package de votre application dans le champ Nom du package Android .
Un nom de package identifie de manière unique votre application sur l'appareil et dans le Google Play Store.
Un nom de package est souvent appelé ID d'application .
Recherchez le nom du package de votre application dans le fichier Gradle de votre module (au niveau de l'application), généralement
app/build.gradle
(exemple de nom de package :com.yourcompany.yourproject
).Sachez que la valeur du nom du package est sensible à la casse et qu'elle ne peut pas être modifiée pour cette application Firebase Android une fois qu'elle est enregistrée dans votre projet Firebase.
(Facultatif) Saisissez d'autres informations sur l'application : pseudonyme de l'application et certificat de signature de débogage SHA-1 .
Pseudonyme de l'application : un identifiant interne pratique qui n'est visible que par vous dans la console Firebase
Certificat de signature de débogage SHA-1 : un hachage SHA-1 est requis par l'authentification Firebase (lors de l'utilisation de la connexion Google ou de la connexion par numéro de téléphone ) et des liens dynamiques Firebase .
Cliquez sur Enregistrer l'application .
Ajouter un fichier de configuration Firebase
Téléchargez puis ajoutez le fichier de configuration Firebase Android (
) à votre application :google-services.json Cliquez sur Télécharger google-services.json pour obtenir votre fichier de configuration Firebase Android.
Déplacez votre fichier de configuration dans le répertoire racine du module (au niveau de l'application) de votre application.
Le fichier de configuration Firebase contient des identifiants uniques mais non secrets pour votre projet. Pour en savoir plus sur ce fichier de configuration, visitez Comprendre les projets Firebase .
Vous pouvez télécharger à nouveau votre fichier de configuration Firebase à tout moment.
Assurez-vous que le nom du fichier de configuration n'est pas suivi de caractères supplémentaires, comme
(2)
.
Pour rendre les valeurs de votre fichier de configuration
accessibles aux SDK Firebase, vous avez besoin du plugin Gradle des services Google (google-services.json google-services
).Dans votre fichier Gradle au niveau racine (au niveau du projet) (
<project>/build.gradle.kts
ou<project>/build.gradle
), ajoutez le plug-in des services Google en tant que dépendance :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 }
Dans le fichier Gradle de votre module (au niveau de l'application) (généralement
<project>/<app-module>/build.gradle.kts
ou<project>/<app-module>/build.gradle
), ajoutez le plugin des services 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' // ... }
Ajouter des SDK Firebase à votre application
Dans le fichier Gradle de votre module (au niveau de l'application) (généralement
<project>/<app-module>/build.gradle.kts
ou<project>/<app-module>/build.gradle
), ajoutez la dépendance pour le Cloud Firebase Bibliothèque de messagerie pour Android. Nous vous recommandons d'utiliser la BoM Android Firebase pour contrôler la gestion des versions de la bibliothèque.Pour une expérience optimale avec Firebase Cloud Messaging, nous vous recommandons d'activer Google Analytics dans votre projet Firebase et d'ajouter le SDK Firebase pour Google Analytics à votre application.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:32.8.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") }
En utilisant Firebase Android BoM , votre application utilisera toujours des versions compatibles des bibliothèques Firebase Android.
Vous recherchez un module de bibliothèque spécifique à Kotlin ? À partir d' octobre 2023 (Firebase BoM 32.5.0) , les développeurs Kotlin et Java peuvent s'appuyer sur le module de bibliothèque principal (pour plus de détails, consultez la FAQ sur cette initiative ).(Alternative) Ajouter des dépendances de la bibliothèque Firebase sans utiliser la BoM
Si vous choisissez de ne pas utiliser la BoM Firebase, vous devez spécifier chaque version de la bibliothèque Firebase dans sa ligne de dépendance.
Notez que si vous utilisez plusieurs bibliothèques Firebase dans votre application, nous vous recommandons fortement d'utiliser la BoM pour gérer les versions de bibliothèque, ce qui garantit que toutes les versions sont compatibles.
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:23.4.1") implementation("com.google.firebase:firebase-analytics:21.6.1") }
Synchronisez votre projet Android avec les fichiers Gradle.
Les versions Gradle qui utilisent le plug-in Android Gradle (AGP) v4.2 ou une version antérieure doivent activer la prise en charge de Java 8. Sinon, ces projets Android obtiennent un échec de construction lors de l'ajout d'un SDK Firebase.
Pour corriger cet échec de build, vous pouvez suivre l'une des deux options suivantes :
- Ajoutez les
compileOptions
répertoriées dans le message d'erreur à votre fichierbuild.gradle.kts
oubuild.gradle
au niveau de l'application . - Augmentez le
minSdk
de votre projet Android à 26 ou plus.
Apprenez-en plus sur cet échec de build dans cette FAQ .
- Ajoutez les
Accéder au jeton d'inscription
Pour envoyer un message à un appareil spécifique, vous devez connaître le jeton d'enregistrement de cet appareil. Étant donné que vous devrez saisir le jeton dans un champ de la console de notifications pour terminer ce didacticiel, assurez-vous de copier le jeton ou de le stocker en toute sécurité après l'avoir récupéré.
Au démarrage initial de votre application, le SDK FCM génère un jeton d'enregistrement pour l'instance d'application client. Si vous souhaitez cibler des appareils uniques ou créer des groupes d'appareils, vous devrez accéder à ce jeton en étendant FirebaseMessagingService
et en remplaçant onNewToken
.
Cette section décrit comment récupérer le jeton et comment surveiller les modifications apportées au jeton. Étant donné que le jeton peut subir une rotation après le démarrage initial, il est fortement recommandé de récupérer le dernier jeton d'enregistrement mis à jour.
Le jeton d'enregistrement peut changer lorsque :
- L'application est restaurée sur un nouvel appareil
- L'utilisateur désinstalle/réinstalle l'application
- L'utilisateur efface les données de l'application.
Récupérer le jeton d'enregistrement actuel
Lorsque vous devez récupérer le jeton actuel, appelez 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(); } });
Surveiller la génération de jetons
Le rappel onNewToken
se déclenche chaque fois qu'un nouveau jeton est généré.
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); }
Après avoir obtenu le jeton, vous pouvez l'envoyer à votre serveur d'applications et le stocker en utilisant votre méthode préférée.
Envoyer un message de notification de test
Installez et exécutez l'application sur l'appareil cible. Sur les appareils Apple, vous devrez accepter la demande d'autorisation pour recevoir des notifications à distance.
Assurez-vous que l'application est en arrière-plan sur l'appareil.
Dans la console Firebase, ouvrez la page Messagerie .
S'il s'agit de votre premier message, sélectionnez Créer votre première campagne .
- Sélectionnez Messages de notification Firebase et sélectionnez Créer .
Sinon, sous l'onglet Campagnes , sélectionnez Nouvelle campagne puis Notifications .
Saisissez le texte du message. Tous les autres champs sont facultatifs.
Sélectionnez Envoyer un message test dans le volet de droite.
Dans le champ intitulé Ajouter un jeton d'enregistrement FCM , saisissez le jeton d'enregistrement que vous avez obtenu dans une section précédente de ce guide.
Sélectionnez Tester .
Après avoir sélectionné Test , l'appareil client ciblé (avec l'application en arrière-plan) devrait recevoir la notification.
Pour obtenir un aperçu de la transmission des messages à votre application, consultez le tableau de bord de reporting FCM , qui enregistre le nombre de messages envoyés et ouverts sur les appareils Apple et Android, ainsi que les données sur les « impressions » (notifications vues par les utilisateurs) pour les applications Android.
Prochaines étapes
Envoyer des messages aux applications au premier plan
Une fois que vous avez envoyé avec succès des messages de notification alors que votre application est en arrière-plan, consultez Recevoir des messages dans une application Android pour commencer à envoyer vers des applications au premier plan.
Allez au-delà des messages de notification
Pour aller au-delà des messages de notification et ajouter d'autres comportements plus avancés à votre application, consultez :