Premiers pas avec Firebase Remote Config


Vous pouvez utiliser Firebase Remote Config pour définir des paramètres dans votre application et mettre à jour leurs valeurs dans le cloud. Vous pouvez ainsi modifier l'apparence et le comportement de votre application sans distribuer de mise à jour. Ce guide vous explique comment commencer et fournit des exemples de code, tous disponibles à cloner ou à télécharger à partir du dépôt GitHub firebase/quickstart-js.

Étape 1: Ajoutez et initialisez le SDK Remote Config

  1. Si ce n'est pas déjà fait, installez le SDK JS Firebase et initialisez Firebase.

  2. Ajoutez le SDK JavaScript Remote Config et initialisez Remote Config:

Web 

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 

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

Cet objet permet de stocker les valeurs de paramètre par défaut dans l'application, de récupérer les valeurs de paramètre mises à jour à partir du backend Remote Config et de contrôler le moment où les valeurs récupérées sont mises à la disposition de votre application.

Étape 2: Définissez l'intervalle de récupération minimal

Lors du développement, nous vous recommandons de définir un intervalle de récupération minimal relativement faible. Pour en savoir plus, consultez la section Limitation de débit.

Web

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
rc_set_minimum_fetch_time.js

Web

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
index.js

Étape 3: Définir les valeurs par défaut des paramètres dans l'application

Vous pouvez définir des valeurs de paramètre par défaut dans l'application dans l'objet Remote Config afin que votre application se comporte comme prévu avant de se connecter au backend Remote Config et que des valeurs par défaut soient disponibles si aucune n'est définie sur le backend.

Web

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

Web

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

Si vous avez déjà configuré les valeurs de paramètre du backend Remote Config, vous pouvez télécharger un fichier JSON généré qui inclut toutes les valeurs par défaut et l'inclure dans votre bundle d'application:

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

Console Firebase

  1. Dans l'onglet Paramètres, ouvrez le menu , puis sélectionnez Télécharger les valeurs par défaut.
  2. Lorsque vous y êtes invité, activez .json pour le Web, puis cliquez sur Télécharger le fichier.

Les exemples suivants présentent deux façons différentes d'importer et de définir des valeurs par défaut dans votre application. Le premier exemple utilise fetch, qui envoie une requête HTTP au fichier de valeurs par défaut inclus dans votre bundle d'application:


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

L'exemple suivant utilise require, qui compile les valeurs dans votre application au moment de la compilation:

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

Étape 4: Obtenez les valeurs de paramètre à utiliser dans votre application

Vous pouvez maintenant obtenir les valeurs des paramètres à partir de l'objet Remote Config. Si vous définissez ultérieurement des valeurs dans le backend, les récupérez, puis les activez, ces valeurs sont disponibles pour votre application.Pour obtenir ces valeurs, appelez la méthode getValue() en fournissant la clé de paramètre en tant qu'argument.

Web

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

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

Web

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

Étape 5: Définir les valeurs des paramètres

À l'aide de la console Firebase ou des API backend Remote Config, vous pouvez créer des valeurs par défaut côté serveur qui remplacent les valeurs dans l'application en fonction de la logique conditionnelle ou du ciblage utilisateur souhaités. Cette section vous explique comment créer ces valeurs dans la console Firebase.

  1. Dans la console Firebase, ouvrez votre projet.
  2. Sélectionnez Remote Config dans le menu pour afficher le tableau de bord Remote Config.
  3. Définissez des paramètres portant les mêmes noms que ceux que vous avez définis dans votre application. Pour chaque paramètre, vous pouvez définir une valeur par défaut (qui remplacera éventuellement la valeur par défaut dans l'application) et vous pouvez également définir des valeurs conditionnelles. Pour en savoir plus, consultez la section Paramètres et conditions Remote Config.

Étape 6: Extrayez et activez les valeurs

  1. Pour extraire les valeurs de paramètre du backend Remote Config, appelez la méthode fetchConfig(). Toutes les valeurs que vous définissez sur le backend sont extraites et mises en cache dans l'objet Remote Config.
  2. Pour mettre les valeurs de paramètre récupérées à la disposition de votre application, appelez la méthode activate().

Si vous souhaitez extraire et activer des valeurs en un seul appel, utilisez fetchAndActivate(), comme illustré dans cet exemple:

Web

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

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

Web

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

Étant donné que ces valeurs de paramètre mises à jour affectent le comportement et l'apparence de votre application, vous devez activer les valeurs extraites à un moment qui garantit une expérience fluide pour votre utilisateur, par exemple la prochaine fois qu'il ouvrira votre application. Pour en savoir plus et obtenir des exemples, consultez la section Stratégies de chargement de Remote Config.

Limitations

Si une application effectue trop de récupérations sur une courte période, les appels de récupération peuvent être limités. Dans ce cas, le SDK génère une erreur FETCH_THROTTLE. Nous vous recommandons de détecter cette erreur et de réessayer en mode intervalle exponentiel entre les tentatives, en attendant des intervalles plus longs entre les requêtes de récupération suivantes.

Lors du développement de l'application, vous pouvez souhaiter actualiser le cache très fréquemment (plusieurs fois par heure) pour vous permettre de parcourir rapidement le développement et le test de votre application. Pour permettre une itération rapide sur un projet comprenant de nombreux développeurs, vous pouvez ajouter temporairement une propriété avec un intervalle de récupération minimal faible (Settings.minimumFetchIntervalMillis) dans votre application.

L'intervalle de récupération par défaut et recommandé pour la production de Remote Config est de 12 heures, ce qui signifie que les configurations ne seront pas récupérées à partir du backend plus d'une fois dans un délai de 12 heures, quel que soit le nombre d'appels de récupération effectués. Plus précisément, l'intervalle de récupération minimal est déterminé dans l'ordre suivant:

  1. Paramètre dans Settings.minimumFetchIntervalMillis.
  2. Valeur par défaut de 12 heures.

Étapes suivantes

Si ce n'est pas déjà fait, explorez les Remote Config cas d'utilisation et consultez certains des concepts clés et la documentation sur les stratégies avancées, y compris: