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 ( plat_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 .

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

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

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

   Comment le surnom de l'application et le certificat de signature de débogage SHA-1 sont-ils utilisés dans Firebase ?

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

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.

   Que devez-vous savoir sur ce fichier de configuration ?

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

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.

   Rencontrez-vous un échec de construction concernant la prise en charge des appels personnalisés et l'activation du désucrage ? Voici comment y remédier.

   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 fichier build.gradle.kts ou build.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 .

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.

      À quoi sert ce flux de travail ?

      • Ce workflow crée automatiquement une nouvelle application Firebase Android en utilisant le nom du package de votre application. Vous pouvez créer cette nouvelle application Firebase Android 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, notamment sur la façon de gérer plusieurs variantes.

        • Si vous créez un nouveau projet, nous vous recommandons fortement de configurer Google Analytics pour votre projet, ce qui vous permet d'avoir une expérience optimale en utilisant de nombreux produits Firebase.

      • Ce workflow ajoute également le fichier de configuration Android de votre projet Firebase ( google-services.json ) au répertoire de module (au niveau de l'application) de votre application.

   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 :

• Documentation de référence ( Kotlin+KTX | Java )

• Dépôt GitHub du SDK 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 les dépendances de la bibliothèque Firebase dans votre fichier de configuration de build Gradle.

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 :

• Consultez Comprendre les projets Firebase pour en savoir plus sur les projets Firebase et les meilleures pratiques en matière de projets.

• Consultez En savoir plus sur Android et Firebase si vous avez des questions sur des concepts peu familiers ou spécifiques au développement Firebase et Android.

• Découvrez des exemples d'applications Firebase .

• Bénéficiez d'une expérience pratique avec l' atelier de programmation Android Firebase .

• Apprenez-en davantage avec le cours Firebase en un week-end .

• Préparez-vous à lancer votre application :

  • Configurez des alertes budgétaires pour votre projet dans Google Cloud Console.
  • Surveillez le tableau de bord d'utilisation et de facturation dans la console Firebase pour obtenir une image globale de l'utilisation de votre projet sur plusieurs services Firebase.
  • Consultez la liste de contrôle de lancement de Firebase .

• Vous rencontrez des problèmes avec Firebase et votre projet Android ? Consultez la FAQ et le dépannage Android .