Как управлять установками и идентификаторами Firebase

Сервис установки Firebase (FIS) предоставляет идентификатор установки Firebase (FID) для каждого установленного экземпляра приложения Firebase. Идентификатор установки Firebase используется внутри следующих сервисов Firebase:

Обычно сервисы Firebase используют сервис установок Firebase без необходимости прямого взаимодействия разработчиков с FIS API. Однако в некоторых случаях разработчикам приложений может понадобиться напрямую вызывать API FIS, например:

• Чтобы удалить установку Firebase и связанные с ней данные.
• Чтобы получать идентификаторы (идентификаторы установки Firebase) и настраивать таргетинг на определенные установки приложений.
• Получение токенов аутентификации для аутентификации установок Firebase.

Чтобы начать работу с FIS API, добавьте SDK в приложение.

Как добавить в приложение SDK для отслеживания установок Firebase

implementation 'com.google.firebase:firebase-installations:19.1.2'

<script src="/__/firebase/12.19.0/firebase-installations.js"></script>

Как удалить установку Firebase

Данные, связанные с установкой Firebase, обычно не позволяют идентифицировать личность. Однако пользователям может быть полезно иметь возможность управлять этими данными и удалять их.

Идентификаторы установки Firebase уникальны для каждого экземпляра каждого приложения. У разных приложений на одном устройстве разные идентификаторы установки Firebase. Идентификаторы установки приложения Firebase позволяют идентифицировать установки приложений и связанные с ними данные.

Когда вы удаляете идентификатор установки, связанные с ним данные удаляются из активных и резервных систем всех сервисов Firebase, которые используют идентификаторы установки Firebase для идентификации установок, в течение 180 дней. Общие сведения об этом процессе приведены в заявлении Google об удалении и хранении данных.

Если вы не отключите все сервисы, генерирующие идентификаторы FID, в приложении, FIS создаст новый идентификатор в течение нескольких дней. Firebase считает новый идентификатор новой установкой Firebase и никак не связывает его с предыдущим идентификатором или данными.

Как удалить идентификатор экземпляра установки с помощью вызова клиентского API

Чтобы удалить FID, созданные сервисами Firebase, вызовите подходящий метод из Firebase SDK установок:

do {
  try await Installations.installations().delete()
  print("Installation deleted");
} catch {
  print("Error deleting installation: \(error)")
}
AppDelegate.swift

[[FIRInstallations installations] deleteWithCompletion:^(NSError *error) {
   if (error != nil) {
     NSLog(@"Error deleting Installation %@", error);
     return;
   }
   NSLog(@"Installation deleted");
}];
ObjCSnippets.m

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");
        }
    }
});
MainActivity.java

FirebaseInstallations.getInstance().delete().addOnCompleteListener { task ->
    if (task.isComplete) {
        Log.d("Installations", "Installation deleted")
    } else {
        Log.e("Installations", "Unable to delete Installation")
    }
}
MainActivity.kt

await firebase.installations().delete();
index.js

await FirebaseInstallations.instance.delete();

Как удалить идентификатор экземпляра с помощью вызова API сервера

Чтобы удалить FID с помощью вызова API сервера, добавьте Firebase Admin SDK на сервер, если вы ещё этого не сделали.

После добавления SDK удалите идентификаторы установки, вызвав функцию удаления на нужном языке (кроме Node.js, в этих методах используются названия, относящиеся к идентификаторам экземпляра). Однако при вызове с любой текущей версией Firebase SDK они удаляют FID.

// An FIDsent from a client service SDK
const idToDelete = 'eyJhbGciOiJFUzI1N_iIs5';

admin.installations().deleteInstallation(idToDelete);

// An FID sent from a client service SDK
String idToDelete = "eyJhbGciOiJFUzI1N_iIs5";

FirebaseInstanceId.getInstance().deleteInstanceIdAsync(idToDelete).get();

  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)

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

Когда вы удаляете идентификатор установки Firebase с помощью вызова API сервера, сервисы Firebase запускают процесс удаления данных, связанных с этим идентификатором. В течение 1–2 дней они перестают принимать новые данные для этого идентификатора, а затем уведомляют клиентское приложение о том, что идентификатор был удален. Пока Firebase не уведомит клиентское приложение, некоторые сервисы приложения могут по-прежнему использовать идентификатор. Например, экземпляр Firebase может получать уведомления FCM в течение нескольких часов.

Если вы хотите удалить текущий идентификатор установки Firebase и сразу же начать использовать сервисы Firebase с новым, не связанным с ним идентификатором, воспользуйтесь клиентским API для удаления.

Как получить идентификаторы клиентов

Если вам нужно идентифицировать определенные установки приложения, вы можете получить идентификатор установки Firebase. Например, чтобы создать сегменты установок приложений для импорта в BigQuery или провести тестирование во время разработки Firebase In-App Messaging, вы можете идентифицировать и настроить таргетинг на нужные устройства с помощью соответствующих идентификаторов установки Firebase.

Чтобы получить идентификатор установки Firebase:

do {
  let id = try await Installations.installations().installationID()
  print("Installation ID: \(id)")
} catch {
  print("Error fetching id: \(error)")
}
AppDelegate.swift

[[FIRInstallations installations] installationIDWithCompletion:^(NSString *identifier, NSError *error) {
  if (error != nil) {
    NSLog(@"Error fetching Installation ID %@", error);
    return;
  }
  NSLog(@"Installation ID: %@", identifier);
}];
ObjCSnippets.m

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");
        }
    }
});
MainActivity.java

FirebaseInstallations.getInstance().id.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        Log.d("Installations", "Installation ID: " + task.result)
    } else {
        Log.e("Installations", "Unable to get Installation ID")
    }
}
MainActivity.kt

const installationId = await firebase.installations().getId();
console.log(installationId);
index.js

String id = await FirebaseInstallations.instance.getId();

Как получить токены аутентификации для установки

Сервисы Firebase могут аутентифицировать установки Firebase с помощью токенов аутентификации, полученных от FIS. Например, при разработке A/B-тестов для Remote Config можно аутентифицировать целевое тестовое устройство с помощью токена аутентификации установки.

Токен авторизации установки – это кратковременный токен носителя в формате веб-токена JSON (JWT), содержащий следующую информацию об установке:

• Идентификатор установки Firebase
• Связанный проект (projectNumber)
• Идентификатор связанного приложения Firebase (appId).
• Дата окончания срока действия токена.

Токен авторизации установки нельзя отозвать. Он будет действителен до даты окончания срока действия. Срок действия токена по умолчанию – одна неделя.

Чтобы получить токен авторизации для установки:

do {
  let result = try await Installations.installations()
    .authTokenForcingRefresh(true)
  print("Installation auth token: \(result.authToken)")
} catch {
  print("Error fetching token: \(error)")
}
AppDelegate.swift

[[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]);
}];
ObjCSnippets.m

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");
        }
    }
});
MainActivity.java

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")
        }
    }
MainActivity.kt

const installationToken = await firebase.installations()
    .getToken(/* forceRefresh */ true);
console.log(installationToken);
index.js

String token = await FirebaseInstallations.instance.getToken();

Как отслеживать жизненный цикл идентификатора установки Firebase

При нормальной работе приложения Firebaseидентификаторы установки Firebase (FID) не требуют специального мониторинга. Однако приложения, которые явно получают и используют идентификаторы экземпляра приложения, должны добавить логику для отслеживания возможного удаления или ротации идентификатора. Вот несколько случаев, когда идентификаторы FID могут быть удалены или заменены:

• Удаление или повторная установка приложения, например когда конечный пользователь устанавливает его на новое устройство.
• Конечный пользователь очищает кеш приложения или устройства.
• Удаление FID запускается на сервере из-за бездействия приложения (в настоящее время пороговое значение составляет 270 дней бездействия).

Когда в приложении происходит смена или удаление FID в таких случаях, ему назначается новый FID. Кроме того, удаляется токен авторизации установки, связанный с удаленным идентификатором установки, независимо от срока его действия, и заменяется новым токеном авторизации установки.

Приложения могут отслеживать эти изменения и реагировать на них.

Как отслеживать ротацию FID

installationIDObserver = NotificationCenter.default.addObserver(
        forName: .InstallationIDDidChange,
        object: nil,
        queue: nil
) { (notification) in
  // Fetch new Installation ID
  Task {
    await self.fetchInstallationToken()
  }
}
AppDelegate.swift

__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];
}];
ObjCSnippets.m

await firebase.installations().onIdChange((newId) => {
  console.log(newId);
  // TODO: Handle new installation ID.
});

FirebaseInstallations.instance.onIdChange.listen((token) {
  print('FID token: $token');
});

Переход с Instance ID на установку Firebase

До появления установок Firebase Firebase использовал для идентификации установок приложений SDK идентификатора экземпляра. Firebase установки надежнее, производительнее и безопаснее, чем идентификаторы экземпляра. Приложения Firebase, в которых используется Instance ID SDK, следует перевести на Firebase.

Процесс переноса зависит от типа приложения:

• Приложения, которые не вызывают API идентификатора экземпляра напрямую, можно перенести, обновив версии SDK. Большинство приложений Firebase относятся к этой категории.

• Приложения, которые явно вызывают API для идентификатора экземпляра, должны обновить версии SDK и изменить код, чтобы заменить методы идентификатора экземпляра на эквивалентные методы Firebase или FCM. Если ваше приложение использует идентификатор экземпляра для получения FCM регистрационных токенов или явным образом использует идентификатор экземпляра для таргетинга на экземпляры приложения или для любых других целей, вам нужно будет обновить код приложения.

В настоящее время FIS обратно совместим с устаревшим идентификатором Firebase Instance ID. Удаление идентификатора экземпляра – это альтернативный способ запросить удаление данных с помощью следующих SDK Firebase:

• iOS 6.14.0 и более ранних версий
• Android SDK, выпущенные до 27 февраля 2020 г.

Это означает, что приложениям не нужно переходить на установку Firebase, но мы настоятельно рекомендуем это сделать.

Переход на минимальные версии SDK для установок Firebase

Чтобы перейти с идентификатора экземпляра на Firebase, убедитесь, что в ваших приложениях используются указанные ниже минимальные версии Firebase SDK:

Как обновить код, в котором явно вызываются API идентификатора экземпляра

Если ваше приложение для Android или iOS напрямую использует методы Instance ID SDK, вы можете заменить их на идентичные альтернативы в Firebase installations SDK или FCM SDK.

Как получить идентификатор

Методы получения идентификаторов экземпляров заменены методами получения идентификаторов установок. Пример:

До

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)")
  }
}

[[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];
    // display message
    NSLog(@"%@", message);
  }
}];

FirebaseInstanceId.getInstance().getInstanceId()
        .addOnCompleteListener(new OnCompleteListener<InstanceIdResult>() {
            @Override
            public void onComplete(@NonNull Task<InstanceIdResult> task) {
                Log.d("IID_TOKEN", task.getResult().getToken());
            }
        });

FirebaseInstanceId.getInstance().instanceId
        .addOnSuccessListener { result ->
            Log.d("IID_TOKEN", result.token)
        }

После

do {
  let id = try await Installations.installations().installationID()
  print("Installation ID: \(id)")
} catch {
  print("Error fetching id: \(error)")
}
AppDelegate.swift

[[FIRInstallations installations] installationIDWithCompletion:^(NSString *identifier, NSError *error) {
  if (error != nil) {
    NSLog(@"Error fetching Installation ID %@", error);
    return;
  }
  NSLog(@"Installation ID: %@", identifier);
}];
ObjCSnippets.m

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");
        }
    }
});
MainActivity.java

FirebaseInstallations.getInstance().id.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        Log.d("Installations", "Installation ID: " + task.result)
    } else {
        Log.e("Installations", "Unable to get Installation ID")
    }
}
MainActivity.kt

Как удалить идентификатор

Методы удаления идентификаторов экземпляров заменены методами удаления идентификаторов установки Firebase. Пример:

До

InstanceID.instanceID().deleteID { error in
  if let error = error {
    print("Error deleting instance ID: \(error)")
  }
}

[FIRInstanceID instanceID] deleteIDWithHandler:^(NSError *error) {
  if error != nil {
    NSLog(@"Error deleting instance ID: %@", error);
  }
}];

FirebaseInstanceId.deleteInstanceId();

После

func delete(completion: @escaping (Error?) -> Void)

- (void)deleteWithCompletion:(nonnull void (^)(NSError *_Nullable))completion;

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");
        }
    }
});
MainActivity.java

FirebaseInstallations.getInstance().delete().addOnCompleteListener { task ->
    if (task.isComplete) {
        Log.d("Installations", "Installation deleted")
    } else {
        Log.e("Installations", "Unable to delete Installation")
    }
}
MainActivity.kt

Как получить токен регистрации FCM

До появления установок Firebase клиенты FCM получали токены регистрации из идентификатора экземпляра. Теперь в SDK FCM есть методы для получения токена регистрации.

До

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();
            }
        });

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()
        })

InstanceID.instanceID().instanceID { result, error in
  if let error = error {
    print("Error fetching instance ID: \(error)")
  } else if let result = result {
    print("Instance ID token: \(result.token)")
  }
}

[[FIRInstanceID instanceID] instanceIDWithHandler:^(FIRInstanceIDResult * _Nullable result,
                                                    NSError * _Nullable error) {
  if (error != nil) {
    NSLog(@"Error fetching instance ID: %@", error);
  } else {
    NSLog(@"Instance ID token: %@", result.token);
  }
}];

После

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();
        }
    });

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()
})

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)")
  }
}

[[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];
    // display message
    NSLog(@"%@", message);
  }
}];