Начало работы с Firebase Remote Config


Вы можете использовать Firebase Remote Config для определения параметров в своем приложении и обновления их значений в облаке, что позволяет изменять внешний вид и поведение вашего приложения без распространения обновления приложения.

Библиотека Remote Config используется для хранения значений параметров по умолчанию в приложении, извлечения обновленных значений параметров из бэкэнда Remote Config и управления тем, когда извлеченные значения становятся доступными для вашего приложения. Чтобы узнать больше, см. Стратегии загрузки Remote Config .

В этом руководстве вы найдете пошаговые инструкции по началу работы и примеры кода, которые можно клонировать или загрузить из репозитория firebase/quickstart-unity на GitHub.

Шаг 1: Добавьте Remote Config в свое приложение

Прежде чем использовать Remote Config , вам необходимо:

  • Зарегистрируйте свой проект Unity и настройте его для использования Firebase.

    • Если ваш проект Unity уже использует Firebase, значит, он уже зарегистрирован и настроен для Firebase.

    • Если у вас нет проекта Unity, вы можете загрузить пример приложения .

  • Добавьте Firebase Unity SDK (в частности, FirebaseRemoteConfig.unitypackage ) в свой проект Unity.

Обратите внимание, что добавление Firebase в проект Unity включает в себя выполнение задач как в консоли Firebase , так и в открытом проекте Unity (например, вы загружаете файлы конфигурации Firebase из консоли, а затем перемещаете их в проект Unity).

Шаг 2: Установите значения параметров приложения по умолчанию

Вы можете задать значения параметров приложения по умолчанию в объекте Remote Config , чтобы ваше приложение вело себя так, как задумано, до того, как оно подключится к бэкэнду Remote Config , и чтобы были доступны значения по умолчанию, если в бэкэнде ничего не задано.

Для этого создайте словарь строк и заполните его парами ключ/значение, представляющими значения по умолчанию, которые вы хотите добавить. Если вы уже настроили значения параметров бэкэнда Remote Config , вы можете загрузить файл, содержащий эти пары ключ/значение, и использовать его для создания словаря строк. Для получения дополнительной информации см. Загрузка шаблонов Remote Config по умолчанию .

(Нестроковые свойства будут преобразованы в тип свойства при вызове SetDefaultsAsync() ). 

System.Collections.Generic.Dictionary<string, object> defaults =
  new System.Collections.Generic.Dictionary<string, object>();

// These are the values that are used if we haven't fetched data from the
// server
// yet, or if we ask for values that the server doesn't have:
defaults.Add("config_test_string", "default local string");
defaults.Add("config_test_int", 1);
defaults.Add("config_test_float", 1.0);
defaults.Add("config_test_bool", false);

Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.SetDefaultsAsync(defaults)
  .ContinueWithOnMainThread(task => {

Шаг 3: Получите значения параметров для использования в вашем приложении

Теперь вы можете получить значения параметров из объекта Remote Config . Если вы задали значения в бэкэнде Remote Config , извлекли их и затем активировали, эти значения доступны вашему приложению. В противном случае вы получите значения параметров в приложении, настроенные с помощью SetDefaultsAsync() .

Чтобы получить эти значения, используйте GetValue() , указав параметр key в качестве аргумента. Это возвращает ConfigValue , который имеет свойства для преобразования значения в различные базовые типы.

Шаг 4: Установите значения параметров

  1. В консоли Firebase откройте свой проект.
  2. Выберите Remote Config в меню, чтобы просмотреть панель управления Remote Config .
  3. Определите параметры с теми же именами, что и параметры, которые вы определили в своем приложении. Для каждого параметра можно задать значение по умолчанию (которое в конечном итоге переопределит значение по умолчанию в приложении) и условные значения. Чтобы узнать больше, см. Параметры и условия Remote Config .

Шаг 5: Извлечение и активация значений (при необходимости)

Чтобы получить значения параметров из бэкэнда Remote Config , вызовите метод FetchAsync() . Любые значения, которые вы устанавливаете на бэкэнде, извлекаются и кэшируются в объекте Remote Config . 

// Start a fetch request.
// FetchAsync only fetches new data if the current data is older than the provided
// timespan.  Otherwise it assumes the data is "recent enough", and does nothing.
// By default the timespan is 12 hours, and for production apps, this is a good
// number. For this example though, it's set to a timespan of zero, so that
// changes in the console will always show up immediately.
public Task FetchDataAsync() {
  DebugLog("Fetching data...");
  System.Threading.Tasks.Task fetchTask =
  Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.FetchAsync(
      TimeSpan.Zero);
  return fetchTask.ContinueWithOnMainThread(FetchComplete);
}

В приведенном выше коде FetchComplete — это метод, сигнатура которого соответствует параметрам одной из перегрузок ContinueWithOnMainThread() .

В примере кода ниже методу FetchComplete передается предыдущая задача ( fetchTask ), что позволяет FetchComplete определить, была ли она завершена. Код использует Info.LastFetchStatus , чтобы затем определить, была ли завершена также успешно. Если это так, то значения параметров Remote Config затем активируются с помощью ActivateAsync() . 

private void FetchComplete(Task fetchTask) {
  if (!fetchTask.IsCompleted) {
    Debug.LogError("Retrieval hasn't finished.");
    return;
  }

  var remoteConfig = FirebaseRemoteConfig.DefaultInstance;
  var info = remoteConfig.Info;
  if(info.LastFetchStatus != LastFetchStatus.Success) {
    Debug.LogError($"{nameof(FetchComplete)} was unsuccessful\n{nameof(info.LastFetchStatus)}: {info.LastFetchStatus}");
    return;
  }

  // Fetch successful. Parameter values must be activated to use.
  remoteConfig.ActivateAsync()
    .ContinueWithOnMainThread(
      task => {
        Debug.Log($"Remote data loaded and ready for use. Last fetch time {info.FetchTime}.");
    });
}

Значения, полученные с помощью FetchAsync() кэшируются локально после завершения выборки, но не становятся доступными до тех пор, пока не будет вызван ActivateAsync() . Это позволяет гарантировать, что новые значения не будут применены в середине расчета или в другие моменты, которые могут вызвать проблемы или странное поведение.

Шаг 6: Следите за обновлениями в режиме реального времени

После получения значений параметров вы можете использовать Remote Config в реальном времени для прослушивания обновлений из бэкэнда Remote Config . Remote Config в реальном времени посылает подключенным устройствам сигналы о наличии обновлений и автоматически извлекает изменения после публикации новой версии Remote Config .

Обновления в реальном времени поддерживаются Firebase Unity SDK v11.0.0+ и выше для платформ Android и Apple.

  1. Добавьте в свое приложение OnConfigUpdateListener , чтобы начать прослушивание обновлений и автоматически извлекать любые новые или обновленные значения параметров. Затем создайте ConfigUpdateListenerEventHandler для обработки событий обновления. Следующий пример прослушивает обновления и использует новые извлеченные значения для отображения обновленного приветственного сообщения. 
// Invoke the listener.
void Start()
{
  Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
    += ConfigUpdateListenerEventHandler;
}

// Handle real-time Remote Config events.
void ConfigUpdateListenerEventHandler(
   object sender, Firebase.RemoteConfig.ConfigUpdateEventArgs args) {
  if (args.Error != Firebase.RemoteConfig.RemoteConfigError.None) {
    Debug.Log(String.Format("Error occurred while listening: {0}", args.Error));
    return;
  }

  Debug.Log("Updated keys: " + string.Join(", ", args.UpdatedKeys));
  // Activate all fetched values and then display a welcome message.
  remoteConfig.ActivateAsync().ContinueWithOnMainThread(
    task => {
        DisplayWelcomeMessage();
    });
}

// Stop the listener.
void OnDestroy() {
    Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
      -= ConfigUpdateListenerEventHandler;
}

В следующий раз, когда вы опубликуете новую версию Remote Config , устройства, на которых запущено ваше приложение и которые ожидают изменений, вызовут обработчик завершения.

Следующие шаги

Если вы еще этого не сделали, изучите варианты использования Remote Config и посмотрите на некоторые из ключевых концепций и документации «Расширенные стратегии», в том числе:

,


You can use Firebase Remote Config to define parameters in your app and update their values in the cloud, allowing you to modify the appearance and behavior of your app without distributing an app update.

The Remote Config library is used to store in-app default parameter values, fetch updated parameter values from the Remote Config backend, and control when fetched values are made available to your app. To learn more, see Remote Config loading strategies .

This guide walks you through the steps to get started and provides some sample code, all of which is available to clone or download from the firebase/quickstart-unity GitHub repository.

Шаг 1: Добавьте Remote Config в свое приложение

Before you can use Remote Config , you need to:

  • Register your Unity project and configure it to use Firebase.

    • If your Unity project already uses Firebase, then it's already registered and configured for Firebase.

    • If you don't have a Unity project, you can download a sample app .

  • Add the Firebase Unity SDK (specifically, FirebaseRemoteConfig.unitypackage ) to your Unity project.

Note that adding Firebase to your Unity project involves tasks both in the Firebase console and in your open Unity project (for example, you download Firebase config files from the console, then move them into your Unity project).

Step 2: Set in-app default parameter values

You can set in-app default parameter values in the Remote Config object, so that your app behaves as intended before it connects to the Remote Config backend, and so that default values are available if none are set in the backend.

To do this, create a string dictionary, and populate it with key/value pairs representing the defaults you want to add. If you have already configured Remote Config backend parameter values, you can download a file that contains these key/value pairs and use it to construct your string dictionary. For more information, see Download Remote Config template defaults .

(Non-string properties will be converted to the property's type when SetDefaultsAsync() is called). 

System.Collections.Generic.Dictionary<string, object> defaults =
  new System.Collections.Generic.Dictionary<string, object>();

// These are the values that are used if we haven't fetched data from the
// server
// yet, or if we ask for values that the server doesn't have:
defaults.Add("config_test_string", "default local string");
defaults.Add("config_test_int", 1);
defaults.Add("config_test_float", 1.0);
defaults.Add("config_test_bool", false);

Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.SetDefaultsAsync(defaults)
  .ContinueWithOnMainThread(task => {

Step 3: Get parameter values to use in your app

Now you can get parameter values from the Remote Config object. If you set values in the Remote Config backend, fetched them, and then activated them, those values are available to your app. Otherwise, you get the in-app parameter values configured using SetDefaultsAsync() .

To get these values, use GetValue() , providing the parameter key as an argument. This returns a ConfigValue , which has properties to convert the value into various base types.

Step 4: Set parameter values

  1. In the Firebase console , open your project.
  2. Select Remote Config from the menu to view the Remote Config dashboard.
  3. Define parameters with the same names as the parameters that you defined in your app. For each parameter, you can set a default value (which will eventually override the in-app default value) and conditional values. To learn more, see Remote Config parameters and conditions .

Step 5: Fetch and activate values (as needed)

To fetch parameter values from the Remote Config backend, call the FetchAsync() method. Any values that you set on the backend are fetched and cached in the Remote Config object. 

// Start a fetch request.
// FetchAsync only fetches new data if the current data is older than the provided
// timespan.  Otherwise it assumes the data is "recent enough", and does nothing.
// By default the timespan is 12 hours, and for production apps, this is a good
// number. For this example though, it's set to a timespan of zero, so that
// changes in the console will always show up immediately.
public Task FetchDataAsync() {
  DebugLog("Fetching data...");
  System.Threading.Tasks.Task fetchTask =
  Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.FetchAsync(
      TimeSpan.Zero);
  return fetchTask.ContinueWithOnMainThread(FetchComplete);
}

In the code above, FetchComplete is a method whose signature matches the parameters of one of the overloads of ContinueWithOnMainThread() .

In the sample code below, the FetchComplete method is passed the previous task ( fetchTask ), which allows FetchComplete to determine whether it finished. The code uses Info.LastFetchStatus to then determine whether the finish was also successful. If so, Remote Config parameter values are then activated using ActivateAsync() . 

private void FetchComplete(Task fetchTask) {
  if (!fetchTask.IsCompleted) {
    Debug.LogError("Retrieval hasn't finished.");
    return;
  }

  var remoteConfig = FirebaseRemoteConfig.DefaultInstance;
  var info = remoteConfig.Info;
  if(info.LastFetchStatus != LastFetchStatus.Success) {
    Debug.LogError($"{nameof(FetchComplete)} was unsuccessful\n{nameof(info.LastFetchStatus)}: {info.LastFetchStatus}");
    return;
  }

  // Fetch successful. Parameter values must be activated to use.
  remoteConfig.ActivateAsync()
    .ContinueWithOnMainThread(
      task => {
        Debug.Log($"Remote data loaded and ready for use. Last fetch time {info.FetchTime}.");
    });
}

Values fetched using FetchAsync() are cached locally when the fetch completes, but are not made available until ActivateAsync() is invoked. This lets you ensure that the new values are not applied mid-calculation, or at other times that might cause problems or strange behavior.

Step 6: Listen for updates in real time

After you fetch parameter values, you can use real-time Remote Config to listen for updates from the Remote Config backend. Real-time Remote Config signals to connected devices when updates are available and automatically fetches the changes after you publish a new Remote Config version.

Real-time updates are supported by the Firebase Unity SDK v11.0.0+ and higher for Android and Apple platforms.

  1. In your app, add an OnConfigUpdateListener to start listening for updates and automatically fetch any new or updated parameter values. Then, create a ConfigUpdateListenerEventHandler to process update events. The following example listens for updates and uses the newly fetched values to display an updated welcome message. 
// Invoke the listener.
void Start()
{
  Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
    += ConfigUpdateListenerEventHandler;
}

// Handle real-time Remote Config events.
void ConfigUpdateListenerEventHandler(
   object sender, Firebase.RemoteConfig.ConfigUpdateEventArgs args) {
  if (args.Error != Firebase.RemoteConfig.RemoteConfigError.None) {
    Debug.Log(String.Format("Error occurred while listening: {0}", args.Error));
    return;
  }

  Debug.Log("Updated keys: " + string.Join(", ", args.UpdatedKeys));
  // Activate all fetched values and then display a welcome message.
  remoteConfig.ActivateAsync().ContinueWithOnMainThread(
    task => {
        DisplayWelcomeMessage();
    });
}

// Stop the listener.
void OnDestroy() {
    Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
      -= ConfigUpdateListenerEventHandler;
}

The next time you publish a new version of your Remote Config , devices that are running your app and listening for changes will call the completion handler.

Следующие шаги

If you haven't already, explore the Remote Config use cases , and take a look at some of the key concepts and advanced strategies documentation, including: