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 :

    • Cibles API niveau 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 v3.2.1 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 l'installation des services Google Play 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 en utilisant l'une des options suivantes :

  • Option 1 : (recommandée) 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 à partir de la console, puis 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 Ajouter une application pour lancer le workflow de configuration.

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

  4. (Facultatif) Saisissez d'autres informations sur l'application : surnom 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. Ajoutez le fichier de configuration Firebase Android à votre application :

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

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

  2. Pour activer les produits Firebase dans votre application, ajoutez le plug-in google-services à vos fichiers Gradle.

    1. Dans votre fichier Gradle de niveau racine (niveau projet) ( build.gradle ), ajoutez des règles pour inclure le plug-in Google Services Gradle. Vérifiez que vous disposez également du référentiel Maven de Google.

      buildscript {
      
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
        }
      
        dependencies {
          // ...
      
          // Add the following line:
          classpath 'com.google.gms:google-services:4.3.13'  // Google Services plugin
        }
      }
      
      allprojects {
        // ...
      
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
          // ...
        }
      }
      
    2. Dans le fichier Gradle de votre module (au niveau de l'application) (généralement app/build.gradle ), appliquez le plug-in Google Services Gradle :

      apply plugin: 'com.android.application'
      // Add the following line:
      apply plugin: 'com.google.gms.google-services'  // Google Services plugin
      
      android {
        // ...
      }
      

Étape 4 : Ajoutez des SDK Firebase à votre application

  1. À l'aide de Firebase Android BoM , déclarez les dépendances des produits Firebase que vous souhaitez utiliser dans votre application. Déclarez-les dans le fichier Gradle de votre module (au niveau de l'application) (généralement app/build.gradle ).

    Analyse activée

    Java

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:30.3.1')
    
      // When using the BoM, you don't specify versions in Firebase library dependencies
    
      // Declare the dependency for the Firebase SDK for Google Analytics
      implementation 'com.google.firebase:firebase-analytics'
    
      // Declare the dependencies for any other desired Firebase products
      // For example, declare the dependencies for Firebase Authentication and Cloud Firestore
      implementation 'com.google.firebase:firebase-auth'
      implementation 'com.google.firebase:firebase-firestore'
    }
    

    Kotlin+KTX

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:30.3.1')
    
      // When using the BoM, you don't specify versions in Firebase library dependencies
    
      // Declare the dependency for the Firebase SDK for Google Analytics
      implementation 'com.google.firebase:firebase-analytics-ktx'
    
      // Declare the dependencies for any other desired Firebase products
      // For example, declare the dependencies for Firebase Authentication and Cloud Firestore
      implementation 'com.google.firebase:firebase-auth-ktx'
      implementation 'com.google.firebase:firebase-firestore-ktx'
    }
    

    En utilisant Firebase Android BoM , votre application utilisera toujours des versions compatibles des bibliothèques Firebase Android.

    Analyse non activée

    Java

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:30.3.1')
    
      // When using the BoM, you don't specify versions in Firebase library dependencies
    
      // Declare the dependencies for the desired Firebase products
      // For example, declare the dependencies for Firebase Authentication and Cloud Firestore
      implementation 'com.google.firebase:firebase-auth'
      implementation 'com.google.firebase:firebase-firestore'
    }
    

    Kotlin+KTX

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:30.3.1')
    
      // When using the BoM, you don't specify versions in Firebase library dependencies
    
      // Declare the dependencies for the desired Firebase products
      // For example, declare the dependencies for Firebase Authentication and Cloud Firestore
      implementation 'com.google.firebase:firebase-auth-ktx'
      implementation 'com.google.firebase:firebase-firestore-ktx'
    }
    

    En utilisant Firebase Android BoM , votre application utilisera toujours des versions compatibles des bibliothèques Firebase Android.

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

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

Si vous rencontrez des difficultés pour la configuration, consultez la FAQ et le dépannage d'Android .



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

L' assistant Firebase enregistre votre application avec 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 : Aide > Rechercher les mises à jour
    • macOS : Android Studio > Vérifier 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 > Enregistrer un événement Analytics ).

    1. Cliquez sur Se 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 étapes suivantes recommandées.

Si vous rencontrez des difficultés pour la configuration, consultez la FAQ et le dépannage d'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 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 build.gradle .

Java

Service ou produit Dépendance Gradle Dernier
version
Ajouter des analyses ?
BoM Android Firebase
(Nom des 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 version de cette version de BoM.

30.3.1
AdMob com.google.android.gms:play-services-ads 21.1.0
Analytique com.google.firebase:firebase-analytics 21.1.0
Fournisseur personnalisé App Check com.google.firebase:firebase-appcheck 16.0.0
Fournisseur de débogage App Check com.google.firebase:firebase-appcheck-debug 16.0.0
App Check Play Fournisseur d'intégrité com.google.firebase:firebase-appcheck-playintegrity 16.0.0
Fournisseur App Check SafetyNet com.google.firebase:firebase-appcheck-safetynet 16.0.0
Distribution d'applications com.google.firebase:firebase-appdistribution 16.0.0-beta03
API de distribution d'applications com.google.firebase:firebase-appdistribution-api 16.0.0-beta03
Plug-in de distribution d'applications com.google.firebase:firebase-appdistribution-gradle 3.0.3
Authentification com.google.firebase:firebase-auth 21.0.7
Cloud Firestore com.google.firebase:firebase-firestore 24.2.2
Cloud Functions pour le SDK client Firebase com.google.firebase:fonctions-firebase 20.1.0
Messagerie en nuage com.google.firebase : messagerie Firebase 23.0.7
Stockage en ligne com.google.firebase:firebase-stockage 20.0.1
Crashlytics com.google.firebase:firebase-crashlytics 18.2.12
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 18.2.12
Plug-in Crashlytics com.google.firebase:firebase-crashlytics-gradle 2.9.1
Prise en charge du module de fonctionnalités dynamiques com.google.firebase : prise en charge du module dynamique firebase 16.0.0-beta02
Liens dynamiques com.google.firebase:firebase-dynamic-links 21.0.1
Messagerie intégrée à l'application com.google.firebase:firebase-inappmessagerie 20.1.2
(obligatoire)
Affichage de la messagerie dans l'application com.google.firebase:firebase-inappmessaging-display 20.1.2
(obligatoire)
Installations Firebase com.google.firebase:installations-firebase 17.0.1
API de téléchargement de modèles Firebase ML com.google.firebase:firebase-ml-modeldownloader 24.0.4
Suivi de la performance com.google.firebase:firebase-perf 20.1.0
Plug-in de surveillance des performances com.google.firebase:perf-plugin 1.4.1
Base de données en temps réel com.google.firebase:firebase-database 20.0.5
Configuration à distance com.google.firebase:firebase-config 21.1.1
Plug-in de services Google Play com.google.gms:services-google 4.3.13
Bibliothèques obsolètes
Indexation des applications com.google.firebase:firebase-appindexing 20.0.0
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'image 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 des visages com.google.firebase:firebase-ml-vision-face-model 20.0.2
Firebase ML : modèle de lecture 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-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 : Traduire le modèle com.google.firebase:firebase-ml-natural-language-translate-model 20.0.9
Firebase ML : modèle de réponse intelligente com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8

Kotlin+KTX

Service ou Produit Dépendance Gradle Dernier
version
Ajouter des analyses ?
BoM Android Firebase
(Nom des 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 version de cette version de BoM.

30.3.1
AdMob com.google.android.gms:play-services-ads 21.1.0
Analytique com.google.firebase:firebase-analytics-ktx 21.1.0
Fournisseur personnalisé App Check com.google.firebase:firebase-appcheck 16.0.0
Fournisseur de débogage App Check com.google.firebase:firebase-appcheck-debug 16.0.0
Fournisseur App Check SafetyNet com.google.firebase:firebase-appcheck-safetynet 16.0.0
API de distribution d'applications com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta03
Plug-in de distribution d'applications com.google.firebase:firebase-appdistribution-gradle 3.0.3
Authentification com.google.firebase:firebase-auth-ktx 21.0.7
Cloud Firestore com.google.firebase:firebase-firestore-ktx 24.2.2
Cloud Functions pour le SDK client Firebase com.google.firebase:firebase-functions-ktx 20.1.0
Messagerie en nuage com.google.firebase:firebase-messaging-ktx 23.0.7
Stockage en ligne com.google.firebase:firebase-storage-ktx 20.0.1
Crashlytics com.google.firebase:firebase-crashlytics-ktx 18.2.12
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 18.2.12
Plug-in Crashlytics com.google.firebase:firebase-crashlytics-gradle 2.9.1
Prise en charge du module de fonctionnalités dynamiques com.google.firebase : prise en charge du module dynamique firebase 16.0.0-beta02
Liens dynamiques com.google.firebase:firebase-dynamic-links-ktx 21.0.1
Messagerie intégrée à l'application com.google.firebase:firebase-inappmessaging-ktx 20.1.2
(obligatoire)
Affichage de la messagerie dans l'application com.google.firebase:firebase-inappmessaging-display-ktx 20.1.2
(obligatoire)
Installations Firebase com.google.firebase:firebase-installations-ktx 17.0.1
API de téléchargement de modèles Firebase ML com.google.firebase:firebase-ml-modeldownloader-ktx 24.0.4
Suivi de la performance com.google.firebase:firebase-perf-ktx 20.1.0
Plug-in de surveillance des performances com.google.firebase:perf-plugin 1.4.1
Base de données en temps réel com.google.firebase:firebase-database-ktx 20.0.5
Configuration à distance com.google.firebase:firebase-config-ktx 21.1.1
Plug-in de services Google Play com.google.gms:services-google 4.3.13
Bibliothèques obsolètes
Indexation des applications com.google.firebase:firebase-appindexing 20.0.0
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'image 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 des visages com.google.firebase:firebase-ml-vision-face-model 20.0.2
Firebase ML : modèle de lecture 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-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 : Traduire le modèle com.google.firebase:firebase-ml-natural-language-translate-model 20.0.9
Firebase ML : modèle de réponse intelligente com.google.firebase:firebase-ml-natural-language-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 Authentification .

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