To get started with FCM, build out the simplest use case: sending a notification message from the Notifications console to a specific user's device when the app is in the background on the device. This page lists all the steps to achieve this, from setup to verification — it may cover steps you already completed if you have set up an Android client app for FCM.
Set up the SDK
This section covers tasks you may have completed if you have already enabled other Firebase features for your app.
Prerequisites
- A device running Android 2.3 (Gingerbread) or newer, and Google Play services 9.6.1 or newer
- The Google Repository from the Android SDK Manager
- Android Studio 1.5 or higher
If you don't have an Android Studio project already, you can download one of
our quickstart samples if you just want to try a
Firebase feature. If you're using a quickstart, remember to get the application
ID from the build.gradle file in your project's module folder
(typically app/), as you'll need this package name for the next step.
Add Firebase to your app
To add Firebase to your app you'll need a Firebase project and a Firebase configuration file for your app.
- Create a Firebase project in the Firebase console, if you don't already have one. If you already have an existing Google project associated with your mobile app, click Import Google Project. Otherwise, click Create New Project.
- Click Add Firebase to your Android app and follow the setup steps. If you're importing an existing Google project, this may happen automatically and you can just download the config file.
- When prompted, enter your app's package name. It's important to enter the package name your app is using; this can only be set when you add an app to your Firebase project.
- At the end, you'll download a
google-services.jsonfile. You can download this file again at any time. - If you haven't done so already, copy this into your project's module folder,
typically
app/.
Add the SDK
If you would like to integrate the Firebase libraries into one of your own projects, you need to perform a few basic tasks to prepare your Android Studio project. You may have already done this as part of adding Firebase to your app.
First, add rules to your root-level build.gradle file, to
include the google-services plugin:
buildscript {
// ...
dependencies {
// ...
classpath 'com.google.gms:google-services:3.0.0'
}
}
Then, in your module Gradle file (usually the app/build.gradle), add the
apply plugin line at the bottom of the file to enable the Gradle plugin:
apply plugin: 'com.android.application'
android {
// ...
}
dependencies {
// ...
compile 'com.google.firebase:firebase-core:9.6.1'
compile 'com.google.firebase:firebase-messaging:9.6.1'
// Getting a "Could not find" error? Make sure you have
// the latest Google Repository in the Android SDK manager
}
// ADD THIS AT THE BOTTOM
apply plugin: 'com.google.gms.google-services'
You should also add the dependencies for the Firebase SDKs you want to use. We
recommend starting with com.google.firebase:firebase-core, which provides Firebase Analytics
functionality. See the list of available libraries.
Access the registration token
To send a message to a specific device, you need to know that device's registration token. Because you'll need to enter the token in a field in the Notifications console to complete this tutorial, make sure to copy the token or securely store it after you retrieve it.
On initial startup of your app, the FCM SDK generates a registration
token for the client app instance. If you want to target single devices or
create device groups, you'll need to access this token by extending
FirebaseInstanceIdService.
This section describes how to retrieve the token and how to monitor changes to the token. Because the token could be rotated after initial startup, you are strongly recommended to retrieve the latest updated registration token.
The registration token may change when:
- The app deletes Instance ID
- The app is restored on a new device
- The user uninstalls/reinstall the app
- The user clears app data.
Retrieve the current registration token
When you need to retrieve the current token, call
FirebaseInstanceID.getToken().
This method returns null if the token has not yet been generated.
Monitor token generation
The onTokenRefreshcallback fires whenever a new token is
generated, so calling
getToken in its context ensures that you are accessing a current, available
registration token. Make sure you have added the service to your
manifest,
then call getToken
in the context of onTokenRefresh, and log the value as shown:
@Override
public void onTokenRefresh() {
// Get updated InstanceID token.
String refreshedToken = FirebaseInstanceId.getInstance().getToken();
Log.d(TAG, "Refreshed token: " + refreshedToken);
// If you want to send messages to this application instance or
// manage this apps subscriptions on the server side, send the
// Instance ID token to your app server.
sendRegistrationToServer(refreshedToken);
}
After you've obtained the token, you can send it to your app server and store it using your preferred method. See the Instance ID API reference for full detail on the API.
Send a notification message
-
Install and run the app on the target device.
-
Make sure the app is in the background on the device.
-
Open the Notifications tab of the Firebase console and select New Message.
-
Enter the message text.
-
Select Single Device for the message target.
-
In the field labeled FCM Registration Token, enter the registration token you obtained in a previous section of this guide.
After you click Send Message, targeted client devices that have the app in the background receive the notification in the system notifications tray .
Next steps
Send messages to foregrounded apps
Once you have successfully sent notification messages while your app is in the background, see Receive Messages in an Android App to get started sending to foregrounded apps.
Go beyond notification messages
To go beyond notification messages and add other, more advanced behavior to your app, see:
Need help? Visit our