Add Firebase to your Android project

Prerequisites

• Install or update Android Studio to its latest version.

• Make sure that your project meets these requirements:

  • Targets API level 19 (KitKat) or higher
  • Uses Android 4.4 or higher
  • Uses Jetpack (AndroidX), which includes meeting these version requirements:
    • com.android.tools.build:gradle v3.2.1 or later
    • compileSdkVersion 28 or later

• Set up a physical device or use an emulator to run your app.
  Note that Firebase SDKs with a dependency on Google Play services require the device or emulator to have Google Play services installed.

• Sign into Firebase using your Google account.

If you don't already have an Android project and just want to try out a Firebase product, you can download one of our quickstart samples.

You can connect your Android app to Firebase using one of the following options:

• Option 1: (recommended) Use the Firebase console setup workflow.
• Option 2: Use the Android Studio Firebase Assistant (may require additional configuration).

---

Option 1: Add Firebase using the Firebase console

Adding Firebase to your app involves tasks both in the Firebase console and in your open Android project (for example, you download Firebase config files from the console, then move them into your Android project).

Step 1: Create a Firebase project

Before you can add Firebase to your Android app, you need to create a Firebase project to connect to your Android app. Visit Understand Firebase Projects to learn more about Firebase projects.

Create a Firebase project

1. In the Firebase console, click Add project.

   • To add Firebase resources to an existing Google Cloud project, enter its project name or select it from the dropdown menu.

   • To create a new project, enter the desired project name. You can also optionally edit the project ID displayed below the project name.

2. If prompted, review and accept the Firebase terms.

3. Click Continue.

4. (Optional) Set up Google Analytics for your project, which enables you to have an optimal experience using any of the following Firebase products:

   Firebase Crashlytics Firebase Predictions

   Firebase Cloud Messaging Firebase In-App Messaging

   Firebase Remote Config Firebase A/B Testing

   Either select an existing Google Analytics account or to create a new account.

   If you create a new account, select your Analytics reporting location, then accept the data sharing settings and Google Analytics terms for your project.

5. Click Create project (or Add Firebase, if you're using an existing Google Cloud project).

Firebase automatically provisions resources for your Firebase project. When the process completes, you'll be taken to the overview page for your Firebase project in the Firebase console.

Step 2: Register your app with Firebase

To use Firebase in your Android app, you need to register your app with your Firebase project. Registering your app is often called "adding" your app to your project.

1. Go to the Firebase console.

2. In the center of the project overview page, click the Android icon (plat_android) or Add app to launch the setup workflow.

3. Enter your app's package name in the Android package name field.

   What's a package name, and where do you find it?

   • A package name uniquely identifies your app on the device and in the Google Play Store.

   • A package name is often referred to as an application ID.

   • Find your app's package name in your module (app-level) Gradle file, usually app/build.gradle (example package name: com.yourcompany.yourproject).

   • Be aware that the package name value is case-sensitive, and it cannot be changed for this Firebase Android app after it's registered with your Firebase project.

4. (Optional) Enter other app information: App nickname and Debug signing certificate SHA-1.

   How are the App nickname and the Debug signing certificate SHA-1 used within Firebase?

   • App nickname: An internal, convenience identifier that is only visible to you in the Firebase console

   • Debug signing certificate SHA-1: A SHA-1 hash is required by Firebase Authentication (when using Google Sign In or phone number sign in) and Firebase Dynamic Links.

5. Click Register app.

Step 3: Add a Firebase configuration file

1. Add the Firebase Android configuration file to your app:

   1. Click Download google-services.json to obtain your Firebase Android config file (google-services.json).

   2. Move your config file into the module (app-level) directory of your app.

   What do you need to know about this config file?

   • The Firebase config file contains unique, but non-secret identifiers for your project. To learn more about this config file, visit Understand Firebase Projects.

   • You can download your Firebase config file again at any time.

   • Make sure the config file name is not appended with additional characters, like (2).

2. To enable Firebase products in your app, add the google-services plugin to your Gradle files.

   1. In your root-level (project-level) Gradle file (build.gradle), add rules to include the Google Services Gradle plugin. Check that you have Google's Maven repository, as well.

      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.10'  // Google Services plugin
        }
      }
      
      allprojects {
        // ...
      
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
          // ...
        }
      }
      

   2. In your module (app-level) Gradle file (usually app/build.gradle), apply the Google Services Gradle plugin:

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

Step 4: Add Firebase SDKs to your app

1. Using the Firebase Android BoM, declare the dependencies for the Firebase products that you want to use in your app. Declare them in your module (app-level) Gradle file (usually app/build.gradle).

   Analytics enabled

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:29.0.4')
   
     // 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:29.0.4')
   
     // 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'
   }
   

   By using the Firebase Android BoM, your app will always use compatible versions of the Firebase Android libraries.

   Analytics not enabled

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:29.0.4')
   
     // 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:29.0.4')
   
     // 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'
   }
   

   By using the Firebase Android BoM, your app will always use compatible versions of the Firebase Android libraries.

2. Sync your app to ensure that all dependencies have the necessary versions.

   Getting a build failure about invoke-custom support and enabling desugaring? Here's how to fix it.

   Gradle builds that use Android Gradle plugin (AGP) v4.2 or earlier need to enable Java 8 support. Otherwise, these Android projects get a build failure when adding a Firebase SDK.

   To fix this build failure, you can follow one of two options:

   • Add the listed compileOptions from the error message to your app-level build.gradle file.
   • Increase the minSdkVersion for your Android project to 26 or above.

   Learn more about this build failure in this FAQ.

That's it! You can skip ahead to check out the recommended next steps.

If you're having trouble getting set up, though, visit the Android troubleshooting & FAQ.

---

Option 2: Add Firebase using the Firebase Assistant

The Firebase Assistant registers your app with a Firebase project and adds the necessary Firebase files, plugins, and dependencies to your Android project — all from within Android Studio!

1. Open your Android project in Android Studio, then make sure that you're using the latest versions of Android Studio and the Firebase Assistant:

   • Windows / Linux: Help > Check for updates
   • macOS: Android Studio > Check for updates

2. Open the Firebase Assistant: Tools > Firebase.

3. In the Assistant pane, choose a Firebase product to add to your app. Expand its section, then click the tutorial link (for example, Analytics > Log an Analytics event).

   1. Click Connect to Firebase to connect your Android project with Firebase.

      What does this workflow do?

      • This workflow automatically creates a new Firebase Android app using your app's package name. You can create this new Firebase Android app in either an existing Firebase project or a new project.

        Here are some tips about setting up your Firebase project:

        • Visit Understand Firebase Projects to learn more about best practices and considerations for adding apps to a Firebase project, including how to handle multiple build variants.

        • If you create a new project, we strongly recommend that you set up Google Analytics for your project, which enables you to have an optimal experience using many Firebase products.

      • This workflow also adds your Firebase project's Android configuration file (google-services.json) to the module (app-level) directory of your app.

   2. Click the button to add a desired Firebase product (for example, Add Analytics to your app).

4. Sync your app to ensure that all dependencies have the necessary versions.

5. In the Assistant pane, follow the remaining setup instructions for your selected Firebase product.

6. Add as many other Firebase products as you'd like via the Firebase Assistant!

That's it! Make sure to check out the recommended next steps.

If you're having trouble getting set up, though, visit the Android troubleshooting & FAQ.

---

Available libraries

This section lists the Firebase products supported for Android and their Gradle dependencies. Learn more about these Firebase Android libraries:

• Reference documentation (Java | Kotlin+KTX)

• Firebase Android SDK GitHub repo

Note that when using the Firebase Android BoM, you don't specify individual library versions when you declare Firebase library dependencies in build.gradle.

---

Next steps

Add Firebase services to your app:

• Gain insights on user behavior with Analytics.

• Set up a user authentication flow with Authentication.

• Store data, like user information, with Cloud Firestore or Realtime Database.

• Store files, like photos and videos, with Cloud Storage.

• Trigger backend code that runs in a secure environment with Cloud Functions.

• Send notifications with Cloud Messaging.

• Find out when and why your app is crashing with Crashlytics.

Learn about Firebase:

• Visit Understand Firebase Projects to learn more about Firebase projects and best practices for projects.

• Visit Learn more about Android and Firebase if you have questions about concepts that are unfamiliar or specific to Firebase and Android development.

• Explore sample Firebase apps.

• Get hands-on experience with the Firebase Android Codelab.

• Learn more with the Firebase in a Weekend course.

• Prepare to launch your app:

  • Set up budget alerts for your project in the Google Cloud Console.
  • Monitor the Usage and billing dashboard in the Firebase console to get an overall picture of your project's usage across multiple Firebase services.
  • Review the Firebase launch checklist.

• Having trouble with Firebase and your Android project? Visit the Android troubleshooting & FAQ.