Ajouter Firebase à votre projet Android

Conditions préalables

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


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 : utilisez l'assistant Android Studio Firebase (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 les fichiers de configuration Firebase depuis la console, puis vous les déplacez dans votre projet Android).

Étape 1 : 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.

Étape 2 : Enregistrez votre application auprès de 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.

  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 workflow 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 : pseudonyme 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 avez besoin du plugin 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.0" 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.0' 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 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'
        // ...
      }
      

Étape 4 : Ajoutez des SDK Firebase à votre application

  1. 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 les dépendances pour les produits Firebase que vous souhaitez utiliser dans votre application. Nous vous recommandons d'utiliser la BoM Android Firebase pour contrôler la gestion des versions de la bibliothèque.

    Analyse activée

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation(platform("com.google.firebase:firebase-bom:32.6.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 s'appuyer sur le module de bibliothèque principal (pour plus de détails, consultez la FAQ sur cette initiative ).

    Analyse non activée

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation(platform("com.google.firebase:firebase-bom:32.6.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 s'appuyer sur le module de bibliothèque principal (pour plus de détails, consultez la FAQ sur cette initiative ).

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

C'est ça! Vous pouvez passer directement aux étapes suivantes recommandées.

Si vous rencontrez des difficultés lors de la configuration, consultez la section Dépannage et FAQ Android .



Option 2 : ajouter Firebase à l'aide de l'assistant Firebase

L' assistant Firebase enregistre votre application auprès d'un projet Firebase et ajoute les fichiers, plugins 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 que vous utilisez les dernières versions d'Android Studio et de Firebase Assistant :

    • Windows / Linux : Aide > Rechercher les mises à jour
    • macOS : Android Studio > Rechercher les mises à jour
  2. Ouvrez l'assistant 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 didacticiel (par exemple, Analytics > Consigner un événement Analytics ).

    1. Cliquez sur Connecter à Firebase pour connecter 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 votre produit Firebase sélectionné.

  6. Ajoutez autant d'autres produits Firebase que vous le souhaitez via l'assistant Firebase !

C'est ça! Assurez-vous de consulter les prochaines étapes recommandées.

Si vous rencontrez des difficultés lors de la configuration, consultez la section Dépannage et FAQ Android .



Bibliothèques disponibles

Cette section répertorie les produits Firebase pris en charge pour Android et leurs dépendances Gradle. En savoir plus sur ces bibliothèques Firebase Android :

Notez que lorsque vous utilisez Firebase Android BoM , vous ne spécifiez pas de versions de bibliothèque individuelles lorsque vous déclarez les dépendances de la bibliothèque Firebase dans votre fichier de configuration de build Gradle.

Service ou produit Dépendance graduée Dernier
version
Ajouter des analyses ?
Nomenclature Android de Firebase
(Nomelle de matériaux)
com.google.firebase:firebase-bom

La dernière version de Firebase BoM contient les dernières versions de chaque bibliothèque Firebase Android. Pour savoir quelles versions de bibliothèque sont mappées à une version de BoM spécifique, consultez les notes de publication de cette version de BoM.

32.6.0
AdMob com.google.android.gms:play-services-ads 22.5.0
Analytique com.google.firebase:firebase-analytics 21.5.0
Fournisseur personnalisé App Check com.google.firebase:firebase-appcheck 17.1.1
Fournisseur de débogage App Check com.google.firebase:firebase-appcheck-debug 17.1.1
Fournisseur d'intégrité App Check Play com.google.firebase:firebase-appcheck-playintegrity 17.1.1
Distribution d'applications com.google.firebase:firebase-appdistribution 16.0.0-bêta11
API de distribution d'applications com.google.firebase:firebase-appdistribution-api 16.0.0-bêta11
Plugin de distribution d'applications com.google.firebase:firebase-appdistribution-gradle 4.0.1
Authentification com.google.firebase:firebase-auth 22.3.0
Cloud Firestore com.google.firebase:firebase-firestore 24.9.1
Fonctions Cloud pour le SDK client Firebase com.google.firebase:fonctions firebase 20.4.0
Messagerie cloud com.google.firebase:firebase-messagerie 23.3.1
Stockage en ligne com.google.firebase:firebase-stockage 20.3.0
Crashlytiques com.google.firebase:firebase-crashlytics 18.6.0
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 18.6.0
Plugin Crashlytics com.google.firebase:firebase-crashlytics-gradle 2.9.9
Prise en charge des modules de fonctionnalités dynamiques com.google.firebase:firebase-dynamic-module-support 16.0.0-bêta03
Liens dynamiques com.google.firebase:firebase-dynamic-links 21.2.0
Messagerie intégrée à l'application com.google.firebase : messagerie firebase-inapp 20.4.0
(requis)
Affichage de la messagerie intégrée à l'application com.google.firebase:firebase-inappmessaging-display 20.4.0
(requis)
Installations Firebase com.google.firebase:installations-firebase 17.2.0
API de téléchargement de modèles Firebase ML com.google.firebase:firebase-ml-modeldownloader 24.2.1
Suivi de la performance com.google.firebase:firebase-perf 20.5.1
Plugin de surveillance des performances com.google.firebase:perf-plugin 1.4.2
Base de données en temps réel com.google.firebase:firebase-base de données 20.3.0
Configuration à distance com.google.firebase:firebase-config 21.6.0
Plugin des services Google Play com.google.gms:services-google 4.4.0
BIBLIOTHÈQUES DÉCONSEILLÉES
Fournisseur App Check SafetyNet com.google.firebase:firebase-appcheck-safetynet 16.1.2
Indexation des applications com.google.firebase:firebase-appindexing 20.0.0

Modules Firebase KTX

Analytique com.google.firebase:firebase-analytics-ktx 21.5.0
Fournisseur personnalisé App Check com.google.firebase:firebase-appcheck-ktx 17.1.1
API de distribution d'applications com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-bêta11
Authentification com.google.firebase:firebase-auth-ktx 22.3.0
Cloud Firestore com.google.firebase:firebase-firestore-ktx 24.9.1
Fonctions Cloud pour le SDK client Firebase com.google.firebase:firebase-functions-ktx 20.4.0
Messagerie cloud com.google.firebase:firebase-messaging-ktx 23.3.1
Stockage en ligne com.google.firebase:firebase-storage-ktx 20.3.0
Crashlytiques com.google.firebase:firebase-crashlytics-ktx 18.6.0
Liens dynamiques com.google.firebase:firebase-dynamic-links-ktx 21.2.0
Messagerie intégrée à l'application com.google.firebase:firebase-inappmessaging-ktx 20.4.0
(requis)
Affichage de la messagerie intégrée à l'application com.google.firebase:firebase-inappmessaging-display-ktx 20.4.0
(requis)
Installations Firebase com.google.firebase:firebase-installations-ktx 17.2.0
API de téléchargement de modèles Firebase ML com.google.firebase:firebase-ml-modeldownloader-ktx 24.2.1
Suivi de la performance com.google.firebase:firebase-perf-ktx 20.5.1
Base de données en temps réel com.google.firebase:firebase-database-ktx 20.3.0
Configuration à distance com.google.firebase:firebase-config-ktx 21.6.0

Bibliothèques du kit Firebase ML

API de modèle personnalisé Firebase ML com.google.firebase:firebase-ml-model-interpreter 22.0.4
API Firebase ML Vision com.google.firebase:firebase-ml-vision 24.1.0
Firebase ML : modèle d'étiquetage d'images com.google.firebase:firebase-ml-vision-image-label-model 20.0.2
Firebase ML : modèle de détection et de suivi d'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 d'analyse de codes-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 de langage naturel com.google.firebase:firebase-ml-langage-naturel 22.0.1
Firebase ML : modèle d'identification du langage com.google.firebase:firebase-ml-natural-langage-langage-id-model 20.0.8
Firebase ML : traduire le modèle com.google.firebase:firebase-ml-natural-lingual-translate-model 20.0.9
Firebase ML : modèle de réponse intelligente com.google.firebase:firebase-ml-natural-langage-smart-reply-model 20.0.8



Prochaines étapes

Ajoutez les services Firebase à votre application :

  • Obtenez des informations sur le comportement des utilisateurs avec Analytics .

  • Configurez un flux d'authentification utilisateur avec Authentication .

  • Stockez les données, telles que les informations utilisateur, avec Cloud Firestore ou Realtime Database .

  • Stockez des fichiers, comme des photos et des vidéos, avec Cloud Storage .

  • Déclenchez du code backend qui s'exécute dans un environnement sécurisé avec Cloud Functions .

  • Envoyez des notifications avec Cloud Messaging .

  • Découvrez quand et pourquoi votre application plante avec Crashlytics .

En savoir plus sur Firebase :