Prérequis
Installez ou mettez à jour Android Studio vers sa dernière version.
Assurez-vous que votre projet répond à ces exigences (notez que certains produits peuvent avoir des exigences plus strictes):
- Cible le niveau d'API 21 (Lollipop) ou version ultérieure
- Utilise Android 5.0 ou version ultérieure
- Utilise Jetpack (AndroidX), ce qui implique de respecter les exigences de version suivantes :
com.android.tools.build:gradle
v7.3.0 ou version ultérieurecompileSdkVersion
28 ou version 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 avec votre compte Google.
Si vous ne disposez pas encore d'un 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.
Vous pouvez connecter votre application Android à Firebase à l'aide de l'une des options suivantes:
- Option 1: (recommandé) Utilisez le workflow de configuration de la console Firebase.
- Option 2: Utiliser Firebase Assistant dans Android Studio (peut nécessiter une configuration supplémentaire).
Option 1: Ajouter Firebase à l'aide de la console Firebase
L'ajout de Firebase à votre application implique des tâches à la fois dans la console Firebase et dans votre projet Android ouvert (par exemple, vous téléchargez des fichiers de configuration Firebase à partir de la console, puis les déplacez dans votre projet Android).
Étape 1: Créez un projet Firebase
Avant de pouvoir ajouter Firebase à votre application Android, vous devez créer un projet Firebase pour vous y connecter. Pour en savoir plus sur les projets Firebase, consultez la page Comprendre les projets Firebase.
Créer un projet Firebase
-
Dans la console Firebase, cliquez sur Ajouter un projet.
-
Pour ajouter des ressources Firebase à un projet Google Cloud existant, saisissez son nom ou sélectionnez-le dans le menu déroulant.
-
Pour créer un projet, saisissez le nom souhaité. Vous pouvez également modifier l'ID du projet affiché sous le nom du projet.
-
-
Si vous y êtes invité, lisez et acceptez les Conditions d'utilisation de Firebase.
-
Cliquez sur Continuer.
-
(Facultatif) Configurez Google Analytics pour votre projet, ce qui vous permet de profiter d'une expérience optimale avec l'un des produits Firebase suivants:
Sélectionnez un compte Google Analytics existant ou créez-en un.
Si vous créez un compte, sélectionnez votre emplacement de création de rapports Analytics, puis acceptez les paramètres de partage des données et les conditions Google Analytics pour votre projet.
-
Cliquez sur Créer un projet (ou sur Ajouter Firebase si vous utilisez un projet Google Cloud existant).
Firebase provisionne automatiquement des ressources pour votre projet Firebase. Une fois le processus terminé, vous êtes redirigé vers la page de présentation de votre projet Firebase dans la console Firebase.
Étape 2: Enregistrer votre application auprès de Firebase
Pour utiliser Firebase dans votre application Android, vous devez enregistrer votre application auprès de votre projet Firebase. L'enregistrement de votre application est souvent appelé "ajout" de 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 processus de configuration.Saisissez le nom du package de votre application dans le champ Nom du package Android.
Qu'est-ce qu'un nom de package et où le trouver ?
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
).Notez que la valeur du nom du package est sensible à la casse et qu'elle ne peut pas être modifiée pour cette application Android pour Firebase une fois qu'elle est enregistrée dans votre projet Firebase.
(Facultatif) Saisissez d'autres informations sur l'application : Pseudo de l'application et Certificat de signature de débogage SHA-1.
Comment le pseudo de l'application et le certificat de signature de débogage SHA-1 sont-ils utilisés dans Firebase ?
Pseudo de l'application: identifiant interne pratique que vous seul pouvez voir dans la console Firebase.
Certificat de signature de débogage SHA-1: Firebase Authentication (lorsque vous utilisez Connexion avec Google ou Connexion avec un numéro de téléphone) et Firebase Dynamic Links nécessitent un hachage SHA-1.
Cliquez sur Enregistrer l'application.
Étape 3: 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.
Que devez-vous savoir sur ce fichier de configuration ?
Le fichier de configuration Firebase contient des identifiants uniques, mais pas secrets, pour votre projet. Pour en savoir plus sur ce fichier de configuration, consultez Comprendre les projets Firebase.
Vous pouvez télécharger à nouveau votre fichier de configuration Firebase à tout moment.
Veillez à ne pas inclure de caractères supplémentaires dans le nom du fichier de configuration, par exemple
(2)
.
Pour rendre les valeurs de votre fichier de configuration
accessibles aux SDK Firebase, vous devez disposer du plug-in 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: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 }
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 }
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 plug-in des services Google:plugins { id("com.android.application") // Add the Google services Gradle plugin id("com.google.gms.google-services") // ... }
plugins { id 'com.android.application' // Add the Google services Gradle plugin id 'com.google.gms.google-services' // ... }
Étape 4: Ajouter les SDK Firebase à votre application
Dans votre fichier Gradle de module (au niveau de l'application) (généralement
<project>/<app-module>/build.gradle.kts
ou<project>/<app-module>/build.gradle
), ajoutez les dépendances pour les produits Firebase que vous souhaitez utiliser dans votre application. Nous vous recommandons d'utiliser Firebase Android BoM pour contrôler la gestion des versions des bibliothèques.dependencies { // ... // Import the Firebase BoM implementation(platform("com.google.firebase:firebase-bom:33.7.0")) // When using the BoM, you don't specify versions in Firebase library dependencies // Add the dependency for the Firebase SDK for Google Analytics implementation("com.google.firebase:firebase-analytics") // TODO: Add the dependencies for any other Firebase products you want to use // See https://firebase.google.com/docs/android/setup#available-libraries // For example, add the dependencies for Firebase Authentication and Cloud Firestore implementation("com.google.firebase:firebase-auth") implementation("com.google.firebase:firebase-firestore") }
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 dépendre du module de bibliothèque principal (pour en savoir plus, consultez les questions fréquentes sur cette initiative).
dependencies { // ... // Import the Firebase BoM implementation(platform("com.google.firebase:firebase-bom:33.7.0")) // When using the BoM, you don't specify versions in Firebase library dependencies // TODO: Add the dependencies for Firebase products you want to use // See https://firebase.google.com/docs/android/setup#available-libraries // For example, add the dependencies for Firebase Authentication and Cloud Firestore implementation("com.google.firebase:firebase-auth") implementation("com.google.firebase:firebase-firestore") }
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 dépendre du module de bibliothèque principal (pour en savoir plus, consultez les questions fréquentes sur cette initiative).
Après avoir ajouté les dépendances pour les produits que vous souhaitez utiliser, synchronisez votre projet Android avec les fichiers Gradle.
Avez-vous rencontré un échec de compilation concernant la prise en charge d'invoke-custom et l'activation du désucrage ? Voici comment résoudre le problème.
Les builds Gradle qui utilisent le plug-in Android Gradle (AGP) 4.2 ou version antérieure doivent activer la compatibilité avec Java 8. Sinon, ces projets Android rencontrent un échec de compilation lors de l'ajout d'un SDK Firebase.
Pour résoudre ce problème de compilation, vous pouvez suivre l'une des deux options suivantes:
- Ajoutez l'
compileOptions
listée dans le message d'erreur à votre fichierbuild.gradle.kts
oubuild.gradle
au niveau de l'application. - Augmentez la version
minSdk
de votre projet Android à 26 ou version ultérieure.
Pour en savoir plus sur cet échec de compilation, consultez ces questions fréquentes.
- Ajoutez l'
Et voilà ! Vous pouvez passer directement aux étapes suivantes recommandées.
Toutefois, si vous rencontrez des difficultés pour configurer l'application, consultez la section Dépannage et questions fréquentes sur Android.
Option 2: Ajouter Firebase à l'aide de Firebase Assistant
Firebase Assistant enregistre votre application dans un projet Firebase et ajoute les fichiers, plug-ins et dépendances Firebase nécessaires à votre projet Android, le tout, depuis Android Studio.
Ouvrez votre projet Android dans Android Studio, puis assurez-vous d'utiliser les dernières versions d'Android Studio et de l'Assistant Firebase:
- Windows / Linux: Help > Check for updates (Aide > Rechercher une mise à jour)
- macOS: Android Studio > Rechercher les mises à jour
Ouvrez Firebase Assistant: Tools > Firebase (Outils > Firebase).
Dans le volet Assistant, choisissez un produit Firebase à ajouter à votre application. Développez sa section, puis cliquez sur le lien du tutoriel (par exemple,
Analytics > Consigner un événement Analytics ).Cliquez sur Connect to Firebase (Se connecter à Firebase) pour associer votre projet Android à Firebase.
À quoi sert ce workflow ?
Ce workflow crée automatiquement une application Android Firebase à l'aide du nom de package de votre application. Vous pouvez créer cette nouvelle application Android Firebase dans un projet Firebase existant ou dans un nouveau projet.
Voici quelques conseils pour configurer votre projet Firebase:
Consultez nos bonnes pratiques pour ajouter des applications à un projet Firebase, y compris pour gérer plusieurs variantes.
Si vous créez un projet, nous vous recommandons vivement de configurer Google Analytics pour votre projet. Vous pourrez ainsi profiter d'une expérience optimale avec de nombreux produits Firebase.
Ce workflow ajoute également le fichier de configuration Android (
) de votre projet Firebase au répertoire du module (au niveau de l'application) de votre application.google-services.json
Cliquez sur le bouton pour ajouter le produit Firebase souhaité (par exemple,
Ajouter Analytics à votre application ).
Synchronisez votre application pour vous assurer que toutes les dépendances disposent des versions nécessaires.
Dans le volet Assistant, suivez les instructions de configuration restantes pour le produit Firebase sélectionné.
Ajoutez autant d'autres produits Firebase que vous le souhaitez via l'Assistant Firebase.
Et voilà ! N'oubliez pas de consulter les étapes suivantes recommandées.
Toutefois, si vous rencontrez des difficultés pour configurer l'application, consultez la section Dépannage et questions fréquentes sur Android.
Bibliothèques disponibles
Cette section répertorie les produits Firebase compatibles avec Android et leurs dépendances Gradle. En savoir plus sur ces bibliothèques Android Firebase:
Dépôt GitHub du SDK Firebase pour Android
Notez que lorsque vous utilisez Firebase Android BoM, vous ne spécifiez pas de versions de bibliothèque individuelles lorsque vous déclarez des dépendances de bibliothèque Firebase dans votre fichier de configuration de compilation Gradle.
Service ou produit | Dépendance Gradle | Dernière version de |
Ajouter Analytics ? | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Firebase Android BoM (Bill of Materials) |
com.google.firebase:firebase-bom
La dernière version de Firebase BoM contient les dernières versions de chaque bibliothèque Android Firebase. Pour savoir quelles versions de bibliothèque sont mappées à une version BoM spécifique, consultez les notes de version de cette version BoM. |
33.7.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AdMob | com.google.android.gms:play-services-ads | 23.6.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Analytics | com.google.firebase:firebase-analytics | 22.1.2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fournisseur personnalisé App Check | com.google.firebase:firebase-appcheck | 18.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fournisseur de débogage App Check | com.google.firebase:firebase-appcheck-debug | 18.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Check Fournisseur Play Integrity | com.google.firebase:firebase-appcheck-playintegrity | 18.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Distribution | com.google.firebase:firebase-appdistribution | 16.0.0-beta14 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
API App Distribution | com.google.firebase:firebase-appdistribution-api | 16.0.0-beta14 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Plug-in App Distribution | com.google.firebase:firebase-appdistribution-gradle | 5.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Authentication | com.google.firebase:firebase-auth | 23.1.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cloud Firestore | com.google.firebase:firebase-firestore | 25.1.1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cloud Functions for Firebase Client SDK | com.google.firebase:firebase-functions | 21.1.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cloud Messaging | com.google.firebase:firebase-messaging | 24.1.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cloud Storage | com.google.firebase:firebase-storage | 21.0.1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Crashlytics | com.google.firebase:firebase-crashlytics | 19.3.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NDK Crashlytics | com.google.firebase:firebase-crashlytics-ndk | 19.3.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Plug-in Crashlytics | com.google.firebase:firebase-crashlytics-gradle | 3.0.2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Compatibilité avec les modules de fonctionnalités dynamiques | com.google.firebase:firebase-dynamic-module-support | 16.0.0-beta03 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Dynamic Links | com.google.firebase:firebase-dynamic-links | 22.1.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
In-App Messaging | com.google.firebase:firebase-inappmessaging | 21.0.1 | (obligatoire) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
In-App Messaging Écran | com.google.firebase:firebase-inappmessaging-display | 21.0.1 | (obligatoire) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Installations Firebase | com.google.firebase:firebase-installations | 18.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
API Firebase ML Model Downloader | com.google.firebase:firebase-ml-modeldownloader | 25.0.1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Performance Monitoring | com.google.firebase:firebase-perf | 21.0.3 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Plug-in Performance Monitoring | com.google.firebase:perf-plugin | 1.4.2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Realtime Database | com.google.firebase:firebase-database | 21.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Remote Config | com.google.firebase:firebase-config | 22.0.1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Vertex AI in Firebase | com.google.firebase:firebase-vertexai | 16.0.2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Plug-in des services Google Play | com.google.gms:google-services | 4.4.2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BIBLIOTHÈQUES OBSOLÈTES | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Check Fournisseur SafetyNet | com.google.firebase:firebase-appcheck-safetynet | 16.1.2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Indexing | com.google.firebase:firebase-appindexing | 20.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Modules Firebase KTX
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bibliothèques Firebase ML Kit
|
Étapes suivantes
Ajoutez des services Firebase à votre application:
Obtenez des insights sur le comportement des utilisateurs avec Analytics.
Configurez un flux d'authentification des utilisateurs avec Authentication.
Stockez des données, telles que des informations utilisateur, avec Cloud Firestore ou Realtime Database.
Stockez des fichiers, comme des photos et des vidéos, avec Cloud Storage.
Déclenchez le code backend qui s'exécute dans un environnement sécurisé avec Cloud Functions.
Envoyer des notifications avec Cloud Messaging
Découvrez quand et pourquoi votre application plante avec Crashlytics.
En savoir plus sur Firebase:
Consultez Comprendre les projets Firebase pour en savoir plus sur les projets Firebase et les bonnes pratiques à suivre.
Consultez En savoir plus sur Android et Firebase si vous avez des questions sur des concepts inconnus ou spécifiques au développement Firebase et Android.
Parcourez les exemples d'applications Firebase.
Familiarisez-vous avec l'atelier de programmation Firebase Android.
Pour en savoir plus, consultez le cours Firebase en un week-end.
Préparez le lancement de votre application:
- Configurez des alertes budgétaires pour votre projet dans la console Google Cloud.
- Surveillez le tableau de bord "Utilisation et facturation" dans la console Firebase pour obtenir une vue d'ensemble de l'utilisation de votre projet sur plusieurs services Firebase.
- Consultez la checklist de lancement de Firebase.
Vous rencontrez des difficultés avec Firebase et votre projet Android ? Consultez les questions fréquentes et le dépannage Android.