Эта страница переведена с помощью Cloud Translation API.

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

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

Шаг 1. Добавьте и инициализируйте SDK Remote Config.

Установите Firebase JS SDK и инициализируйте Firebase , если вы еще этого не сделали.
Добавьте Remote Config JS SDK и инициализируйте Remote Config:

Веб-модульный API

import { initializeApp } from "firebase/app";
import { getRemoteConfig } from "firebase/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = getRemoteConfig(app);

Веб-API в пространстве имен

import firebase from "firebase/compat/app";
import "firebase/compat/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = firebase.remoteConfig();

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

Шаг 2. Установите минимальный интервал выборки

Во время разработки рекомендуется установить относительно небольшой минимальный интервал выборки. Дополнительную информацию см. в разделе Регулирование .

Web modular API

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;rc_set_minimum_fetch_time.js

Web namespaced API

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;index.js

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

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

Web modular API

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

Web namespaced API

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

Если вы уже настроили значения параметров серверной части Remote Config, вы можете загрузить сгенерированный файл JSON, который включает все значения по умолчанию, и включить его в свой пакет приложений:

ОТДЫХ

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=JSON -o remote_config_defaults.json

Консоль Firebase

На вкладке «Параметры» откройте меню и выберите «Загрузить значения по умолчанию» .
При появлении запроса включите .json для Интернета , затем нажмите «Загрузить файл» .

В следующих примерах показаны два разных способа импорта и установки значений по умолчанию в вашем приложении. В первом примере используется fetch , который отправляет HTTP-запрос к файлу настроек по умолчанию, включенному в пакет вашего приложения:


  const rcDefaultsFile = await fetch('remote_config_defaults.json');
  const rcDefaultsJson = await rcDefaultsFile.json();
  remoteConfig.defaultConfig = rcDefaultsJson;

В следующем примере используется require , который компилирует значения в ваше приложение во время сборки:

  let rcDefaults = require('./remote_config_defaults.json');
  remoteConfig.defaultConfig = rcDefaults;

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

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

Web modular API

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

const val = getValue(remoteConfig, "welcome_messsage");rc_get_values.js

Web namespaced API

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

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

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

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

Шаг 6. Получите и активируйте значения

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

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

Web modular API

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

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

Web namespaced API

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

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

Регулирование

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

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

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

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

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

Next steps

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.

Step 1: Add and initialize the Remote Config SDK

If you haven't already, install the Firebase JS SDK and initialize Firebase .
Add the Remote Config JS SDK and initialize Remote Config:

Web modular API

import { initializeApp } from "firebase/app";
import { getRemoteConfig } from "firebase/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = getRemoteConfig(app);

Web namespaced API

import firebase from "firebase/compat/app";
import "firebase/compat/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
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.

Step 2: Set minimum fetch interval

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

Web modular API

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;rc_set_minimum_fetch_time.js

Web namespaced API

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;index.js

Step 3: 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 modular API

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

Web namespaced API

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

If you have already configured Remote Config backend parameter values, you can download a generated JSON file that includes all default values and include it in your app bundle:

REST

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=JSON -o remote_config_defaults.json

Firebase console

In the Parameters tab, open the Menu , and select Download default values .
When prompted, enable .json for web , then click Download file .

The following examples show two different ways you could import and set default values in your app. The first example uses fetch , which will make an HTTP request to the defaults file included in your app bundle:


  const rcDefaultsFile = await fetch('remote_config_defaults.json');
  const rcDefaultsJson = await rcDefaultsFile.json();
  remoteConfig.defaultConfig = rcDefaultsJson;

The next example uses require , which compiles the values into your app at build time:

  let rcDefaults = require('./remote_config_defaults.json');
  remoteConfig.defaultConfig = rcDefaults;

Step 4: 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 modular API

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

const val = getValue(remoteConfig, "welcome_messsage");rc_get_values.js

Web namespaced API

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

Step 5: 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.

In the Firebase console , open your project.
Select Remote Config from the menu to view the Remote Config dashboard.
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 .

Step 6: Fetch and activate values

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.
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 modular API

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

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

Web namespaced API

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

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:

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

Next steps

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: