Начать работу с Firebase Remote Config

Вы можете использовать Firebase Remote Config для определения параметров в вашем приложении и обновления их значений в облаке, что позволяет вам изменять внешний вид и поведение вашего приложения без распространения обновления приложения. Это руководство проведет вас через шаги , чтобы начать работу и предоставляет некоторые примеры кода, все из которых доступно для клона или загрузить с firebase / быстрым стартом-JS хранилище GitHub.

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

  1. Установите Firebase SDK для Web.

  2. Создайте одноэлементный объект Remote Config:

    Веб-версия 9

    import { getRemoteConfig } from "firebase/remote-config";
    
    const remoteConfig = getRemoteConfig();

    Веб-версия 8

    const remoteConfig = firebase.remoteConfig();

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

  3. Установите минимальный интервал выборки:

    Веб-версия 9

    remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

    Веб-версия 8

    remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

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

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

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

Веб-версия 9

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};

Веб-версия 8

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};

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

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

Веб-версия 9

import { getValue } from "firebase/remote-config";

const val = getValue(remoteConfig, "welcome_messsage");

Веб-версия 8

const val = remoteConfig.getValue("welcome_messsage");

Установить значения параметров

Использование Firebase консоли или удаленного API - интерфейсы бэкэнд Config , вы можете создать новые значения на стороне сервера по умолчанию , которые переопределяют значения в приложении в соответствии с нужной условной логики или пользовательский таргетинг. В этом разделе описаны шаги консоли Firebase для создания этих значений.

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

Получить и активировать значения

  1. Для извлечения значения параметров из удаленного Config бэкэнда, вызовите fetchConfig() метод. Любые значения, которые вы устанавливаете на серверной части, извлекаются и кэшируются в объекте Remote Config.
  2. Для того, чтобы надуманные значения параметров доступны для вашего приложения, вызовите activate() метод.

В тех случаях , когда вы хотите , чтобы принести и активизируют значения в одном вызове, используйте fetchAndActivate() , как показано в следующем примере:

Веб-версия 9

import { fetchAndActivate } from "firebase/remote-config";

fetchAndActivate(remoteConfig)
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });

Веб-версия 8

remoteConfig.fetchAndActivate()
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });

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

Дросселирование

Если приложение выполняет выборку слишком много раз за короткий период времени, вызовы выборки могут быть ограничены. В таких случаях SDK бросает FETCH_THROTTLE ошибки. Рекомендуется перехватить эту ошибку и повторить попытку в режиме экспоненциальной отсрочки, ожидая более длительных интервалов между последующими запросами на выборку.

Во время разработки приложения вам может потребоваться очень часто обновлять кеш (много раз в час), чтобы вы могли быстро выполнять итерации при разработке и тестировании приложения. Для размещения быстрой итерации проекта с многочисленными разработчиками, вы можете временно добавить свойство с низкой минимальной выборкой интервала ( Settings.minimumFetchIntervalMillis ) в вашем приложении.

По умолчанию и рекомендуемый интервал производственной выборки для Remote Config составляет 12 часов, что означает, что конфигурации не будут извлекаться из серверной части более одного раза в 12-часовом окне, независимо от того, сколько вызовов выборки фактически сделано. В частности, минимальный интервал выборки определяется в следующем порядке:

  1. Параметр Settings.minimumFetchIntervalMillis .
  2. Значение по умолчанию 12 часов.

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

Если вы уже не имеете, изучить Удаленная настройка вариантов использования , и взглянуть на некоторые из ключевых концепций и передовых стратегий документации, в том числе:

,

Вы можете использовать Firebase Remote Config для определения параметров в вашем приложении и обновления их значений в облаке, что позволяет вам изменять внешний вид и поведение вашего приложения без распространения обновления приложения. Это руководство проведет вас через шаги , чтобы начать работу и предоставляет некоторые примеры кода, все из которых доступно для клона или загрузить с firebase / быстрым стартом-JS хранилище GitHub.

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

  1. Установите Firebase SDK для Web.

  2. Создайте одноэлементный объект Remote Config:

    Веб-версия 9

    import { getRemoteConfig } from "firebase/remote-config";
    
    const remoteConfig = getRemoteConfig();

    Веб-версия 8

    const remoteConfig = firebase.remoteConfig();

    This object 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.

  3. Set a minimum fetch interval:

    Web version 9

    remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

    Web version 8

    remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

    During development, it's recommended to set a relatively low minimum fetch interval. See Throttling for more information.

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 on the backend.

Web version 9

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};

Web version 8

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};

Get parameter values to use in your app

Now you can get parameter values from the Remote Config object. If you later set values in the backend, fetch them, and then activate them, those values are available to your app. To get these values, call the getValue() method, providing the parameter key as an argument.

Web version 9

import { getValue } from "firebase/remote-config";

const val = getValue(remoteConfig, "welcome_messsage");

Web version 8

const val = remoteConfig.getValue("welcome_messsage");

Set parameter values

Using the Firebase console or the Remote Config backend APIs , you can create new server-side default values that override the in-app values according to your desired conditional logic or user targeting. This section walks you through the Firebase console steps to create these 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 you can also set conditional values. To learn more, see Remote Config Parameters and Conditions .

Fetch and activate values

  1. To fetch parameter values from the Remote Config backend, call the fetchConfig() method. Any values that you set on the backend are fetched and cached in the Remote Config object.
  2. To make fetched parameter values available to your app, call the activate() method.

For cases where you want to fetch and activate values in one call, use fetchAndActivate() as shown in this example:

Web version 9

import { fetchAndActivate } from "firebase/remote-config";

fetchAndActivate(remoteConfig)
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });

Web version 8

remoteConfig.fetchAndActivate()
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });

Because these updated parameter values affect the behavior and appearance of your app, you should activate the fetched values at a time that ensures a smooth experience for your user, such as the next time that the user opens your app. See Remote Config loading strategies for more information and examples.

Throttling

If an app fetches too many times in a short time period, fetch calls may be throttled. In such cases, the SDK throws a FETCH_THROTTLE error. You are recommended to catch this error and retry in exponential backoff mode, waiting longer intervals between subsequent fetch requests.

During app development, you might want to refresh the cache very frequently (many times per hour) to let you rapidly iterate as you develop and test your app. To accommodate rapid iteration on a project with numerous developers, you can temporarily add a property with a low minimum fetch interval ( Settings.minimumFetchIntervalMillis ) in your app.

The default and recommended production fetch interval for Remote Config is 12 hours, which means that configs won't be fetched from the backend more than once in a 12 hour window, regardless of how many fetch calls are actually made. Specifically, the minimum fetch interval is determined in the following order:

  1. The parameter in Settings.minimumFetchIntervalMillis .
  2. The default value of 12 hours.

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

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:

,

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. 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-js GitHub repository.

Add Remote Config to your app

  1. Install the Firebase SDK for Web.

  2. Create the singleton Remote Config object:

    Web version 9

    import { getRemoteConfig } from "firebase/remote-config";
    
    const remoteConfig = getRemoteConfig();

    Web version 8

    const remoteConfig = firebase.remoteConfig();

    This object 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.

  3. Set a minimum fetch interval:

    Web version 9

    remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

    Web version 8

    remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

    During development, it's recommended to set a relatively low minimum fetch interval. See Throttling for more information.

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 on the backend.

Web version 9

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};

Web version 8

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};

Get parameter values to use in your app

Now you can get parameter values from the Remote Config object. If you later set values in the backend, fetch them, and then activate them, those values are available to your app. To get these values, call the getValue() method, providing the parameter key as an argument.

Web version 9

import { getValue } from "firebase/remote-config";

const val = getValue(remoteConfig, "welcome_messsage");

Web version 8

const val = remoteConfig.getValue("welcome_messsage");

Set parameter values

Using the Firebase console or the Remote Config backend APIs , you can create new server-side default values that override the in-app values according to your desired conditional logic or user targeting. This section walks you through the Firebase console steps to create these 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 you can also set conditional values. To learn more, see Remote Config Parameters and Conditions .

Fetch and activate values

  1. To fetch parameter values from the Remote Config backend, call the fetchConfig() method. Any values that you set on the backend are fetched and cached in the Remote Config object.
  2. To make fetched parameter values available to your app, call the activate() method.

For cases where you want to fetch and activate values in one call, use fetchAndActivate() as shown in this example:

Web version 9

import { fetchAndActivate } from "firebase/remote-config";

fetchAndActivate(remoteConfig)
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });

Web version 8

remoteConfig.fetchAndActivate()
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });

Because these updated parameter values affect the behavior and appearance of your app, you should activate the fetched values at a time that ensures a smooth experience for your user, such as the next time that the user opens your app. See Remote Config loading strategies for more information and examples.

Throttling

If an app fetches too many times in a short time period, fetch calls may be throttled. In such cases, the SDK throws a FETCH_THROTTLE error. You are recommended to catch this error and retry in exponential backoff mode, waiting longer intervals between subsequent fetch requests.

During app development, you might want to refresh the cache very frequently (many times per hour) to let you rapidly iterate as you develop and test your app. To accommodate rapid iteration on a project with numerous developers, you can temporarily add a property with a low minimum fetch interval ( Settings.minimumFetchIntervalMillis ) in your app.

The default and recommended production fetch interval for Remote Config is 12 hours, which means that configs won't be fetched from the backend more than once in a 12 hour window, regardless of how many fetch calls are actually made. Specifically, the minimum fetch interval is determined in the following order:

  1. The parameter in Settings.minimumFetchIntervalMillis .
  2. The default value of 12 hours.

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

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: