Prerequisites
Install or update Android Studio to its latest version.
Make sure that your project meets these requirements (note that some products might have stricter requirements):
- Targets API level 21 (Lollipop) or higher
- Uses Android 5.0 or higher
- Uses
Jetpack (AndroidX),
which includes meeting these version requirements:
com.android.tools.build:gradle
v7.3.0 or latercompileSdkVersion
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.
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.
Go to the Firebase console.
In the center of the project overview page, click the Android icon (
) or Add app to launch the setup workflow.Enter your app's package name in the Android package name field.
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.
(Optional) Enter other app information: App nickname and Debug signing certificate SHA-1.
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.
Click Register app.
Step 3: Add a Firebase configuration file
Download and then add the Firebase Android configuration file (
) to your app:google-services.json Click Download google-services.json to obtain your Firebase Android config file.
Move your config file into the module (app-level) root directory of your app.
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)
.
To make the values in your
config file accessible to Firebase SDKs, you need the Google services Gradle plugin (google-services.json google-services
).In your root-level (project-level) Gradle file (
<project>/build.gradle.kts
or<project>/build.gradle
), add the Google services plugin as a dependency: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 }
In your module (app-level) Gradle file (usually
<project>/<app-module>/build.gradle.kts
or<project>/<app-module>/build.gradle
), add the Google services plugin: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' // ... }
Step 4: Add Firebase SDKs to your app
In your module (app-level) Gradle file (usually
<project>/<app-module>/build.gradle.kts
or<project>/<app-module>/build.gradle
), add the dependencies for the Firebase products that you want to use in your app. We recommend using the Firebase Android BoM to control library versioning.Analytics enabled
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") }
By using the Firebase Android BoM, your app will always use compatible versions of Firebase Android libraries.
Looking for a Kotlin-specific library module? Starting in October 2023 (Firebase BoM 32.5.0), both Kotlin and Java developers can depend on the main library module (for details, see the FAQ about this initiative).
Analytics not enabled
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") }
By using the Firebase Android BoM, your app will always use compatible versions of Firebase Android libraries.
Looking for a Kotlin-specific library module? Starting in October 2023 (Firebase BoM 32.5.0), both Kotlin and Java developers can depend on the main library module (for details, see the FAQ about this initiative).
After adding the dependencies for the products you want to use, sync your Android project with Gradle files.
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-levelbuild.gradle.kts
orbuild.gradle
file. - Increase the
minSdk
for your Android project to 26 or above.
Learn more about this build failure in this FAQ.
- Add the listed
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!
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
Open the Firebase Assistant: Tools > Firebase.
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 ).Click Connect to Firebase to connect your Android project with Firebase.
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:
Check out our best practices for adding apps to a Firebase project, including how to handle multiple 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 (
) to the module (app-level) directory of your app.google-services.json
Click the button to add a desired Firebase product (for example,
Add Analytics to your app ).
Sync your app to ensure that all dependencies have the necessary versions.
In the Assistant pane, follow the remaining setup instructions for your selected Firebase product.
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 (Kotlin+KTX | Java)
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 your Gradle build configuration file.
Service or Product | Gradle dependency | Latest version |
Add Analytics? | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Firebase Android BoM (Bill of Materials) |
com.google.firebase:firebase-bom
The latest Firebase BoM version contains the latest versions of each Firebase Android library. To learn which library versions are mapped to a specific BoM version, review the release notes for that BoM version. |
33.7.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AdMob | com.google.android.gms:play-services-ads | 23.6.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Analytics | com.google.firebase:firebase-analytics | 22.1.2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Check custom provider | com.google.firebase:firebase-appcheck | 18.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Check debug provider | com.google.firebase:firebase-appcheck-debug | 18.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Check Play Integrity provider | com.google.firebase:firebase-appcheck-playintegrity | 18.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Distribution | com.google.firebase:firebase-appdistribution | 16.0.0-beta14 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Distribution API | com.google.firebase:firebase-appdistribution-api | 16.0.0-beta14 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Distribution plugin | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Crashlytics NDK | com.google.firebase:firebase-crashlytics-ndk | 19.3.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Crashlytics plugin | com.google.firebase:firebase-crashlytics-gradle | 3.0.2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Dynamic feature module support | 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 | (required) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
In-App Messaging Display | com.google.firebase:firebase-inappmessaging-display | 21.0.1 | (required) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Firebase installations | com.google.firebase:firebase-installations | 18.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Firebase ML Model Downloader API | com.google.firebase:firebase-ml-modeldownloader | 25.0.1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Performance Monitoring | com.google.firebase:firebase-perf | 21.0.3 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Performance Monitoring plugin | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Google Play services plugin | com.google.gms:google-services | 4.4.2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DEPRECATED LIBRARIES | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Check SafetyNet provider | com.google.firebase:firebase-appcheck-safetynet | 16.1.2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
App Indexing | com.google.firebase:firebase-appindexing | 20.0.0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Firebase KTX modules
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Firebase ML Kit libraries
|
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.