The Firebase installations service (FIS) provides a Firebase installation ID (FID) for each installed instance of a Firebase app. The Firebase installation ID is used internally by these Firebase services:
| Firebase service | Firebase installations functionality |
|---|---|
| Firebase Cloud Messaging | Firebase Cloud Messaging uses Firebase installation IDs to target devices for message delivery. |
| Firebase Crashlytics | Firebase Crashlytics rotates the Crashlytics installation UUID based on changes to the app instance's Firebase installation ID. In the future, the installation ID may be used to enable features that enhance crash reporting and crash management services. |
| Firebase In-App Messaging | Firebase In-App Messaging uses Firebase installation IDs to target devices for message delivery. |
| Firebase Performance Monitoring | Performance Monitoring uses Firebase installation IDs to calculate the number of unique Firebase installations that access network resources, to ensure that access patterns are sufficiently anonymous. It also uses Firebase installation IDs with Firebase Remote Config to manage the rate of performance event reporting. |
| Firebase Remote Config | Remote Config uses Firebase installation IDs to select configuration values to return to end-user devices. |
| Firebase ML | Credentials called installation auth tokens are used by Firebase ML for device authentication when interacting with app instances, for example, to distribute developer models to app instances. |
| Firebase User Segmentation Storage | Firebase User Segmentation Storage stores Firebase installation IDs and related attributes and segments to provide targeting information to other Firebase services that use them. |
Typically, Firebase services use the Firebase installations service without requiring developers to interact directly with the FIS API. However, there are cases where app developers might want to directly call the FIS API, such as:
- To delete a Firebase installation and data tied to the installation.
- To retrieve identifiers ( Firebase installation IDs) in order to target specific app installations.
- To retrieve installation auth tokens to authenticate Firebase installations.
To get started with directly calling the FIS API, add the SDK to your app.
Add the Firebase installations SDK to your app
iOS+
- Add the dependency for Firebase
installations to your Podfile:
pod 'FirebaseInstallations'
- Run
pod installand open the created.xcworkspacefile. - Import the
FirebaseCoremodule in yourUIApplicationDelegate, as well as any other Firebase modules your app delegate uses. For example, to use Cloud Firestore and Authentication :SwiftUI
import SwiftUI import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
Swift
import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
Objective-C
@import FirebaseCore ; @import FirebaseFirestore ; @import FirebaseAuth ; // ...
- Configure a
FirebaseAppshared instance in your app delegate'sapplication(_:didFinishLaunchingWithOptions:)method:SwiftUI
// Use Firebase library to configure APIs FirebaseApp . configure ()
Swift
// Use Firebase library to configure APIs FirebaseApp . configure ()
Objective-C
// Use Firebase library to configure APIs [ FIRApp configure ];
- If you're using SwiftUI, you must create an application delegate and attach it
to your
Appstruct viaUIApplicationDelegateAdaptororNSApplicationDelegateAdaptor. You must also disable app delegate swizzling. For more information, see the SwiftUI instructions .SwiftUI
@ main struct YourApp : App { // register app delegate for Firebase setup @ UIApplicationDelegateAdaptor ( AppDelegate . self ) var delegate var body : some Scene { WindowGroup { NavigationView { ContentView () } } } }
Android
Add the dependency for the Firebase
installations Android SDK to your
module (app-level) Gradle file (usually app/build.gradle
):
implementation
'
com
.
google
.
firebase
:
firebase
-
installations
:
19.0.0
'
JavaScript
Depending on how your web application is hosted, your configuration may be handled automatically or you may need to update your Firebase configuration object .
For example, if your dependencies are added in index.html, add the dependency in the <head> element:
< script src = "/__/firebase/12.2.1/firebase-installations.js" >< / script >
Flutter
-
From the root directory of your Flutter project, run the following command to install the Firebase installations plugin:
flutter pub add firebase_app_installations -
Rebuild your project:
flutter run -
Import the Firebase installations plugin:
import 'package:firebase_app_installations/firebase_app_installations.dart' ;
Delete a Firebase installation
Data tied to a Firebase installation is generally not personally identifying. Still, it can be helpful to give users an option to manage and delete this data.
Firebase installation IDs are different for every installation of every application; different applications on the same device have different Firebase installation IDs. Firebase installation IDs identify app installations and data tied to those app installations.
When you delete an installation ID, the data tied to that installation ID is removed from live and backup systems of all Firebase services that use Firebase installation IDs to identify installations within 180 days. This process is described at a high level in Google’s statement on deletion and retention .
Unless you disable all FID-generating services in your app, FIS creates a new ID within a few days. Firebase considers the newly-created ID to be a new Firebase installation, and doesn't associate it with the previous ID or data in any way.
Delete an FID with a client API call
To delete FIDs generated by Firebase services, call the appropriate method from the Firebase installations SDK:
Swift
do { try await Installations . installations (). delete () print ( "Installation deleted" ); } catch { print ( "Error deleting installation: \( error ) " ) }
Objective-C
[[ FIRInstallations installations ] deleteWithCompletion :^ ( NSError * error ) { if ( error != nil ) { NSLog ( @"Error deleting Installation %@" , error ); return ; } NSLog ( @"Installation deleted" ); }];
Java
FirebaseInstallations . getInstance (). delete () . addOnCompleteListener ( new OnCompleteListener<Void> () { @Override public void onComplete ( @NonNull Task<Void> task ) { if ( task . isSuccessful ()) { Log . d ( "Installations" , "Installation deleted" ); } else { Log . e ( "Installations" , "Unable to delete Installation" ); } } });
Kotlin
FirebaseInstallations . getInstance (). delete (). addOnCompleteListener { task - > if ( task . isComplete ) { Log . d ( "Installations" , "Installation deleted" ) } else { Log . e ( "Installations" , "Unable to delete Installation" ) } }
JavaScript
await firebase . installations (). delete ();
Dart
await
FirebaseInstallations
.
instance
.
delete
();
Delete an FID with a server API call
To delete an FID with a server API call, add the Firebase Admin SDK to your server , if you haven't already.
Once the SDK is added, delete FIDs through a call to the deletion function in your language of choice (note: Except for Node.js, these methods reflect Instance ID naming. However, they all actually delete the FID when called with any current Firebase SDK).
Node.js
// An FIDsent from a client service SDK
const
idToDelete
=
'eyJhbGciOiJFUzI1N_iIs5'
;
admin
.
installations
().
deleteInstallation
(
idToDelete
);
Java
// An FID sent from a client service SDK
String
idToDelete
=
"eyJhbGciOiJFUzI1N_iIs5"
;
FirebaseInstanceId
.
getInstance
().
deleteInstanceIdAsync
(
idToDelete
).
get
();
Python
from
firebase_admin
import
instance_id
# An FID sent from a client service SDK
id_to_delete
=
'eyJhbGciOiJFUzI1N_iIs5'
instance_id
.
delete_instance_id
(
id_to_delete
)
Go
client
,
err
:=
app
.
InstanceId
(
ctx
)
if
err
!=
nil
{
log
.
Fatalln
(
"error initializing client"
,
err
)
}
iidToDelete
:=
"eyJhbGciOiJFUzI1N_iIs5"
if
err
:=
client
.
DeleteInstanceId
(
ctx
,
iidToDelete
);
err
!=
nil
{
log
.
Fatalln
(
"error deleting FID"
,
err
)
}
When you delete an Firebase installation ID with a server API call, Firebase services start the process to delete the data tied to that installation ID, stop accepting new data for that ID over the course of 1-2 days, and then notify the client app that the ID was deleted. Until Firebase notifies the client app, some of the app's services might still target the ID—for example, a Firebase installation might continue to receive FCM notifications for a few hours.
If you want to delete the current Firebase installation ID and immediately use Firebase services with a new, unrelated ID, use the client API to handle the deletion.
Retrieve client identifiers
If you have a requirement to identify particular installations of your app, you can do so by retrieving the Firebase installation ID. For example, to create segments of app installs for BiqQuery import, or to perform testing during Firebase In-App Messaging development, you can identify and target the correct devices using the corresponding Firebase installation IDs.
To retrieve a Firebase installation ID:
Swift
do { let id = try await Installations . installations (). installationID () print ( "Installation ID: \( id ) " ) } catch { print ( "Error fetching id: \( error ) " ) }
Objective-C
[[ FIRInstallations installations ] installationIDWithCompletion :^ ( NSString * identifier , NSError * error ) { if ( error != nil ) { NSLog ( @"Error fetching Installation ID %@" , error ); return ; } NSLog ( @"Installation ID: %@" , identifier ); }];
Java
FirebaseInstallations . getInstance (). getId () . addOnCompleteListener ( new OnCompleteListener<String> () { @Override public void onComplete ( @NonNull Task<String> task ) { if ( task . isSuccessful ()) { Log . d ( "Installations" , "Installation ID: " + task . getResult ()); } else { Log . e ( "Installations" , "Unable to get Installation ID" ); } } });
Kotlin
FirebaseInstallations . getInstance (). id . addOnCompleteListener { task - > if ( task . isSuccessful ) { Log . d ( "Installations" , "Installation ID: " + task . result ) } else { Log . e ( "Installations" , "Unable to get Installation ID" ) } }
JavaScript
const installationId = await firebase . installations (). getId (); console . log ( installationId );
Dart
String
id
=
await
FirebaseInstallations
.
instance
.
getId
();
Retrieve installation auth tokens
Firebase services can authenticate Firebase installations with auth tokens retrieved from FIS. For example, when designing A/B tests for Remote Config , you can authenticate a targeted test device using an installation auth token.
An installation auth token is a short-lived bearer token in JSON web token (JWT) format containing the following information for an installation:
- The Firebase installation ID
- The associated project (
projectNumber) - The associated Firebase application ID (
appId) - The token's expiration date
An installation auth token cannot be revoked, and remains valid until its expiration date. The default token lifetime is one week.
To retrieve an installation auth token:
Swift
do { let result = try await Installations . installations () . authTokenForcingRefresh ( true ) print ( "Installation auth token: \( result . authToken ) " ) } catch { print ( "Error fetching token: \( error ) " ) }
Objective-C
[[ FIRInstallations installations ] authTokenForcingRefresh : true completion : ^ ( FIRInstallationsAuthTokenResult * result , NSError * error ) { if ( error != nil ) { NSLog ( @"Error fetching Installation token %@" , error ); return ; } NSLog ( @"Installation auth token: %@" , [ result authToken ]); }];
Java
FirebaseInstallations . getInstance (). getToken ( /* forceRefresh */ true ) . addOnCompleteListener ( new OnCompleteListener<InstallationTokenResult> () { @Override public void onComplete ( @NonNull Task<InstallationTokenResult> task ) { if ( task . isSuccessful () && task . getResult () != null ) { Log . d ( "Installations" , "Installation auth token: " + task . getResult (). getToken ()); } else { Log . e ( "Installations" , "Unable to get Installation auth token" ); } } });
Kotlin
val forceRefresh = true FirebaseInstallations . getInstance (). getToken ( forceRefresh ) . addOnCompleteListener { task - > if ( task . isSuccessful ) { Log . d ( "Installations" , "Installation auth token: " + task . result ?. token ) } else { Log . e ( "Installations" , "Unable to get Installation auth token" ) } }
JavaScript
const installationToken = await firebase . installations () . getToken ( /* forceRefresh */ true ); console . log ( installationToken );
Dart
String
token
=
await
FirebaseInstallations
.
instance
.
getToken
();
Monitor the Firebase installation ID lifecycle
During the normal operation of an app, Firebase installation IDs (FIDs) don't require special monitoring. However, apps that explicitly retrieve and use FIDs should add logic to monitor the potential deletion or rotation of the FID. Here are some cases where FIDs could be deleted or rotated:
- Uninstallation or reinstallation of the app, for instance when an end user installs on a new device.
- The end user clears the cache of the app or the device.
- FID deletion is triggered in the backend due to app inactivity (currently the threshold for this is 270 days of inactivity).
When apps experience FID rotation or deletion in these kinds of cases, they are assigned a new FID. Also, the installation auth token associated with a deleted FID is deleted, regardless of its own maturity, and is replaced with a new installation auth token.
Apps can monitor these changes and respond accordingly.
To monitor FID rotation:
Swift
installationIDObserver = NotificationCenter . default . addObserver ( forName : . InstallationIDDidChange , object : nil , queue : nil ) { ( notification ) in // Fetch new Installation ID Task { await self . fetchInstallationToken () } }
Objective-C
__weak __auto_type weakSelf = self ; self . installationIDObserver = [[ NSNotificationCenter defaultCenter ] addObserverForName : FIRInstallationIDDidChangeNotification object : nil queue : nil usingBlock : ^ ( NSNotification * _Nonnull notification ) { // Fetch new Installation ID [ weakSelf fetchInstallationsID ]; }];
An NSNotification named NSNotificationName.InstallationIDDidChange
is
posted to the default NSNotificationCenter whenever a new
FID is assigned.
Android
Kotlin and Java clients should add retry logic to respond on failed calls to retrieve the new FID.
JavaScript
Web apps can subscribe to the onIdChange
hook.
Whenever a new FID is created, the subscribed callback is triggered:
await firebase . installations (). onIdChange (( newId ) = > { console . log ( newId ); // TODO: Handle new installation ID. });
Dart
FirebaseInstallations
.
instance
.
onIdChange
.
listen
((
token
)
{
print
(
'FID token:
$
token
'
);
});
Migrate from Instance ID to Firebase installations
Prior to the introduction of Firebase installations, Firebase relied on the Instance ID SDK for identifiers of app installs. Firebase installations provides significant advantages over Instance ID in reliability, performance, and security. Firebase apps that depend on the Instance ID SDK should migrate to Firebase installations.
The migration process is different based on your app:
-
Apps that don't directly call Instance ID APIs can migrate by updating their SDK versions . Most Firebase apps fall into this category.
-
Apps that explicitly make API calls to Instance ID must update SDK versions and make code changes to replace Instance ID methods with their Firebase installations or FCM equivalents. If your app uses Instance ID to retrieve FCM registration tokens or explicitly uses Instance ID to target app instances or for any other purpose, you'll need to update your application code.
Currently, FIS is backward-compatible with the legacy identifier Firebase Instance ID. Deleting an IID is an alternative method of requesting data deletion with these Firebase SDKs:
- iOS 6.14.0 and lower
- Android SDKs earlier than February 27, 2020
This means that apps are not required to migrate to Firebase installations; however, doing so is highly recommended.
Upgrading to minimum SDK versions for Firebase installations
To migrate from Instance ID to Firebase installations, make sure that your applications use at least the listed minimum version numbers of the following Firebase SDKs:
| Firebase SDK | Minimum Android version | Minimum iOS version |
|---|---|---|
|
Firebase Cloud Messaging
|
v20.3.0 | v6.34.0 |
|
Remote Config
|
v19.2.0 | v6.24.0 |
|
Google Analytics for Firebase \
(Measurement SDK)
|
v17.4.4 | v6.18.0 |
|
In-App Messaging
|
v19.0.7 | v6.24.0 |
|
Performance Monitoring
|
v19.0.8 | v6.21.0 |
|
Crashlytics
|
v17.2.1 | v6.23.0 |
|
ML Kit
|
v22.1.2 | v6.28.0 |
Updating code that explicitly calls Instance ID APIs
If your Android or Apple app directly uses Instance ID SDK methods, you can replace that usage with identical alternatives in the Firebase installations SDK or the FCM SDK.
Retrieving an identifier
Methods to get Instance IDs are replaced with methods to get an installations ID. For example:
Before
Swift
Messaging . messaging (). token { token , error in if let error = error { print ( "Error fetching remote FCM registration token: \( error ) " ) } else if let token = token { print ( "Remote instance ID token: \( token ) " ) self . remoteFCMTokenMessage . text = "Remote FCM registration token: \( token ) " } }
Objective-C
[[ FIRMessaging messaging ] tokenWithCompletion :^ ( NSString * _Nullable token , NSError * _Nullable error ) { if ( error != nil ) { NSLog ( @"Error fetching the remote FCM registration token: %@" , error ); } else { NSLog ( @"Remote FCM registration token: %@" , token ); NSString * message = [ NSString stringWithFormat : @"FCM registration token: %@" , token ]; self . remoteFCMTokenMessage . text = message ; } }];
Java
FirebaseInstanceId . getInstance (). getInstanceId () . addOnCompleteListener ( new OnCompleteListener<InstanceIdResult> () { @Override public void onComplete ( @NonNull Task<InstanceIdResult> task ) { Log . d ( "IID_TOKEN" , task . getResult (). getToken ()); } });
Kotlin
FirebaseInstanceId . getInstance (). instanceId . addOnSuccessListener { result - > Log . d ( "IID_TOKEN" , result . token ) }
After
Swift
do { let id = try await Installations . installations (). installationID () print ( "Installation ID: \( id ) " ) } catch { print ( "Error fetching id: \( error ) " ) }
Objective-C
[[ FIRInstallations installations ] installationIDWithCompletion :^ ( NSString * identifier , NSError * error ) { if ( error != nil ) { NSLog ( @"Error fetching Installation ID %@" , error ); return ; } NSLog ( @"Installation ID: %@" , identifier ); }];
Java
FirebaseInstallations . getInstance (). getId () . addOnCompleteListener ( new OnCompleteListener<String> () { @Override public void onComplete ( @NonNull Task<String> task ) { if ( task . isSuccessful ()) { Log . d ( "Installations" , "Installation ID: " + task . getResult ()); } else { Log . e ( "Installations" , "Unable to get Installation ID" ); } } });
Kotlin
FirebaseInstallations . getInstance (). id . addOnCompleteListener { task - > if ( task . isSuccessful ) { Log . d ( "Installations" , "Installation ID: " + task . result ) } else { Log . e ( "Installations" , "Unable to get Installation ID" ) } }
Deleting an identifier
Methods to delete Instance IDs are replaced with methods to delete Firebase installation IDs. For example:
Before
Swift
InstanceID
.
instanceID
().
deleteID
{
error
in
if
let
error
=
error
{
print
(
"Error deleting instance ID:
\(
error
)
"
)
}
}
Objective-C
[
FIRInstanceID
instanceID
]
deleteIDWithHandler
:^
(
NSError
*
error
)
{
if
error
!=
nil
{
NSLog
(
@"Error deleting instance ID: %@"
,
error
);
}
}];
Android
FirebaseInstanceId.deleteInstanceId();
After
Swift
func
delete
(
completion
:
@
escaping
(
Error
?)
-
>
Void
)
Objective-C
-
(
void
)
deleteWithCompletion:
(
nonnull
void
(
^
)(
NSError
*
_Nullable
))
completion
;
Java
FirebaseInstallations . getInstance (). delete () . addOnCompleteListener ( new OnCompleteListener<Void> () { @Override public void onComplete ( @NonNull Task<Void> task ) { if ( task . isSuccessful ()) { Log . d ( "Installations" , "Installation deleted" ); } else { Log . e ( "Installations" , "Unable to delete Installation" ); } } });
Kotlin
FirebaseInstallations . getInstance (). delete (). addOnCompleteListener { task - > if ( task . isComplete ) { Log . d ( "Installations" , "Installation deleted" ) } else { Log . e ( "Installations" , "Unable to delete Installation" ) } }
Retrieving an FCM registration token
Prior to the introduction of Firebase Installations, FCM clients retrieved registration tokens from Instance ID. Now, the FCM SDK provides methods to retrieve the registration token.
Before
Java
FirebaseInstanceId . getInstance (). getInstanceId () . addOnCompleteListener ( new OnCompleteListener<InstanceIdResult> () { @Override public void onComplete ( @NonNull Task<InstanceIdResult> task ) { if ( ! task . isSuccessful ()) { Log . w ( TAG , "getInstanceId failed" , task . getException ()); return ; } // Get new Instance ID token String token = task . getResult (). getToken (); // Log and toast String msg = getString ( R . string . msg_token_fmt , token ); Log . d ( TAG , msg ); Toast . makeText ( MainActivity . this , msg , Toast . LENGTH_SHORT ). show (); } });
Kotlin
FirebaseInstanceId . getInstance (). instanceId . addOnCompleteListener ( OnCompleteListener { task - > if ( ! task . isSuccessful ) { Log . w ( TAG , "getInstanceId failed" , task . exception ) return @OnCompleteListener } // Get new Instance ID token val token = task . result ?. token // Log and toast val msg = getString ( R . string . msg_token_fmt , token ) Log . d ( TAG , msg ) Toast . makeText ( baseContext , msg , Toast . LENGTH_SHORT ). show () })
Swift
Messaging . messaging (). token { token , error in if let error = error { print ( "Error fetching remote FCM registration token: \( error ) " ) } else if let token = token { print ( "Remote instance ID token: \( token ) " ) self . remoteFCMTokenMessage . text = "Remote FCM registration token: \( token ) " } }
Objective-C
[[ FIRMessaging messaging ] tokenWithCompletion :^ ( NSString * _Nullable token , NSError * _Nullable error ) { if ( error != nil ) { NSLog ( @"Error fetching the remote FCM registration token: %@" , error ); } else { NSLog ( @"Remote FCM registration token: %@" , token ); NSString * message = [ NSString stringWithFormat : @"FCM registration token: %@" , token ]; self . remoteFCMTokenMessage . text = message ; } }];
After
Java
FirebaseMessaging . getInstance (). getToken () . addOnCompleteListener ( new OnCompleteListener<String> () { @Override public void onComplete ( @NonNull Task<String> task ) { if ( ! task . isSuccessful ()) { Log . w ( TAG , "Fetching FCM registration token failed" , task . getException ()); return ; } // Get new FCM registration token String token = task . getResult (); // Log and toast String msg = getString ( R . string . msg_token_fmt , token ); Log . d ( TAG , msg ); Toast . makeText ( MainActivity . this , msg , Toast . LENGTH_SHORT ). show (); } });
Kotlin
FirebaseMessaging . getInstance (). token . addOnCompleteListener ( OnCompleteListener { task - > if ( ! task . isSuccessful ) { Log . w ( TAG , "Fetching FCM registration token failed" , task . exception ) return @OnCompleteListener } // Get new FCM registration token val token = task . result // Log and toast val msg = getString ( R . string . msg_token_fmt , token ) Log . d ( TAG , msg ) Toast . makeText ( baseContext , msg , Toast . LENGTH_SHORT ). show () })
Swift
Messaging . messaging (). token { token , error in if let error = error { print ( "Error fetching FCM registration token: \( error ) " ) } else if let token = token { print ( "FCM registration token: \( token ) " ) self . fcmRegTokenMessage . text = "Remote FCM registration token: \( token ) " } }
Objective-C
[[ FIRMessaging messaging ] tokenWithCompletion :^ ( NSString * token , NSError * error ) { if ( error != nil ) { NSLog ( @"Error getting FCM registration token: %@" , error ); } else { NSLog ( @"FCM registration token: %@" , token ); self . fcmRegTokenMessage . text = token ; } }];
