Ajouter Firebase à votre projet Android

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érieure
      • compileSdkVersion 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.

É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.

  1. Accédez à la console Firebase.

  2. 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.

  3. Saisissez le nom du package de votre application dans le champ Nom du package Android.

  4. (Facultatif) Saisissez d'autres informations sur l'application : Pseudo de l'application et Certificat de signature de débogage SHA-1.

  5. Cliquez sur Enregistrer l'application.

Étape 3: Ajouter un fichier de configuration Firebase

  1. Téléchargez, puis ajoutez le fichier de configuration Firebase Android (google-services.json) à votre application:

    1. Cliquez sur Télécharger google-services.json pour obtenir votre fichier de configuration Firebase Android.

    2. Déplacez votre fichier de configuration dans le répertoire racine du module (au niveau de l'application) de votre application.

  2. Pour rendre les valeurs de votre fichier de configuration google-services.json accessibles aux SDK Firebase, vous devez disposer du plug-in Gradle des services Google (google-services).

    1. 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.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
}

    2. 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:

      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'
  // ...
}

Étape 4: Ajouter les SDK Firebase à votre application

  1. 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.

    Analytics activé 

    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).

    Analytics non activé 

    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).

  2. Après avoir ajouté les dépendances pour les produits que vous souhaitez utiliser, synchronisez votre projet Android avec les fichiers Gradle.

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.

  1. 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

  2. Ouvrez Firebase Assistant: Tools > Firebase (Outils > Firebase).

  3. 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).

    1. Cliquez sur Connect to Firebase (Se connecter à Firebase) pour associer votre projet Android à Firebase.

    2. Cliquez sur le bouton pour ajouter le produit Firebase souhaité (par exemple, Ajouter Analytics à votre application).

  4. Synchronisez votre application pour vous assurer que toutes les dépendances disposent des versions nécessaires.

  5. Dans le volet Assistant, suivez les instructions de configuration restantes pour le produit Firebase sélectionné.

  6. 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:

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

Analytics com.google.firebase:firebase-analytics-ktx 22.1.2
Fournisseur personnalisé App Check com.google.firebase:firebase-appcheck-ktx 18.0.0
API App Distribution com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta14
Authentication com.google.firebase:firebase-auth-ktx 23.1.0
Cloud Firestore com.google.firebase:firebase-firestore-ktx 25.1.1
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions-ktx 21.1.0
Cloud Messaging com.google.firebase:firebase-messaging-ktx 24.1.0
Cloud Storage com.google.firebase:firebase-storage-ktx 21.0.1
Crashlytics com.google.firebase:firebase-crashlytics-ktx 19.3.0
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging-ktx 21.0.1
(obligatoire)
In-App Messaging Écran com.google.firebase:firebase-inappmessaging-display-ktx 21.0.1
(obligatoire)
Installations Firebase com.google.firebase:firebase-installations-ktx 18.0.0
API Firebase ML Model Downloader com.google.firebase:firebase-ml-modeldownloader-ktx 25.0.1
Performance Monitoring com.google.firebase:firebase-perf-ktx 21.0.3
Realtime Database com.google.firebase:firebase-database-ktx 21.0.0
Remote Config com.google.firebase:firebase-config-ktx 22.0.1

Bibliothèques Firebase ML Kit

Firebase ML API de modèle personnalisé com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase ML API Vision com.google.firebase:firebase-ml-vision 24.1.0
Firebase ML: modèle de libellé d'image com.google.firebase:firebase-ml-vision-image-label-model 20.0.2
Firebase ML: modèle de détection et de suivi des objets com.google.firebase:firebase-ml-vision-object-detection-model 19.0.6
Firebase ML: modèle de détection de visage com.google.firebase:firebase-ml-vision-face-model 20.0.2
Firebase ML: modèle de lecture de code-barres com.google.firebase:firebase-ml-vision-barcode-model 16.1.2
Firebase ML: API AutoML Vision Edge com.google.firebase:firebase-ml-vision-automl 18.0.6
Firebase ML: API Natural Language com.google.firebase:firebase-ml-natural-language 22.0.1
Firebase ML: modèle d'identification de la langue com.google.firebase:firebase-ml-natural-language-language-id-model 20.0.8
Firebase ML: modèle de traduction com.google.firebase:firebase-ml-natural-language-translate-model 20.0.9
Firebase ML: modèle de réponses suggérées com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8


É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: