Начните работу с Remote Config в Unity

Выберите платформу:

iOS+ Android Web Flutter Unity C++

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

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

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

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

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

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

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

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

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

Подробные инструкции по выполнению этих начальных задач настройки вы найдете в разделе «Добавление Firebase в ваш проект Unity» .

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

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

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

Важно: не храните конфиденциальные данные в ключах или значениях параметров Remote Config . Данные 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() , передав в качестве аргумента ключ параметра. Этот метод возвращает объект 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 версии 11.0.0 и выше для платформ Android и Apple.

Важно: для работы функции Real-time Remote Config также требуется API Firebase Remote Config Realtime, который должен быть уже включен. Для проверки откройте консоль Google Cloud , выберите свой проект и перейдите на страницу API и сервисов . API должен отображаться как включенный. Если он отсутствует или не включен, нажмите «Включить API и сервисы» , найдите Firebase Remote Config Realtime API и включите его.

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 устройства, на которых запущено ваше приложение и которые отслеживают изменения, вызовут обработчик завершения.