Inizia con Firebase Remote Config


Puoi utilizzare Firebase Remote Config per definire i parametri nella tua app e aggiornarne i valori nel cloud, consentendoti di modificare l'aspetto e il comportamento della tua app senza distribuire un aggiornamento dell'app. Questa guida ti guida attraverso i passaggi per iniziare e fornisce del codice di esempio, il tutto disponibile per essere clonato o scaricato dal repository GitHub firebase/quickstart-js .

Passaggio 1: aggiungere e inizializzare l'SDK di Remote Config

  1. Se non lo hai già fatto, installa Firebase JS SDK e inizializza Firebase .

  2. Aggiungi l'SDK JS di Remote Config e inizializza Remote Config:

API modulare 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);

API con spazio dei nomi 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();

Questo oggetto viene utilizzato per archiviare i valori dei parametri predefiniti in-app, recuperare i valori dei parametri aggiornati dal backend Remote Config e controllare quando i valori recuperati vengono resi disponibili alla tua app.

Passaggio 2: imposta l'intervallo di recupero minimo

Durante lo sviluppo, si consiglia di impostare un intervallo di recupero minimo relativamente basso. Per ulteriori informazioni, vedere Limitazione .

Web modular API

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

Web namespaced API

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;

Passaggio 3: imposta i valori dei parametri predefiniti in-app

Puoi impostare i valori dei parametri predefiniti in-app nell'oggetto Remote Config, in modo che la tua app si comporti come previsto prima di connettersi al backend Remote Config e in modo che i valori predefiniti siano disponibili se non ne sono impostati nessuno sul backend.

Web modular API

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

Web namespaced API

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

Se hai già configurato i valori dei parametri backend di Remote Config, puoi scaricare un file JSON generato che include tutti i valori predefiniti e includerlo nel pacchetto dell'app:

RIPOSO

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. Nella scheda Parametri , apri il menu e seleziona Scarica valori predefiniti .
  2. Quando richiesto, abilita .json per il web , quindi fai clic su Scarica file .

Gli esempi seguenti mostrano due modi diversi in cui puoi importare e impostare valori predefiniti nella tua app. Il primo esempio utilizza fetch , che effettuerà una richiesta HTTP al file predefinito incluso nel pacchetto dell'app:


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

L'esempio successivo utilizza require , che compila i valori nella tua app in fase di compilazione:

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

Passaggio 4: ottieni i valori dei parametri da utilizzare nella tua app

Ora puoi ottenere i valori dei parametri dall'oggetto Remote Config. Se in seguito imposti valori nel backend, li recuperi e quindi li attivi, tali valori saranno disponibili per la tua app. Per ottenere questi valori, chiama il metodo getValue() , fornendo la chiave del parametro come argomento.

Web modular API

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

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

Web namespaced API

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

Passaggio 5: impostare i valori dei parametri

Utilizzando la console Firebase o le API di backend Remote Config , puoi creare nuovi valori predefiniti lato server che sostituiscono i valori in-app in base alla logica condizionale o al targeting utente desiderato. Questa sezione ti guida attraverso i passaggi della console Firebase per creare questi valori.

  1. Nella console Firebase , apri il tuo progetto.
  2. Selezionare Remote Config dal menu per visualizzare il dashboard Remote Config.
  3. Definisci i parametri con gli stessi nomi dei parametri che hai definito nella tua app. Per ciascun parametro, puoi impostare un valore predefinito (che eventualmente sovrascriverà il valore predefinito in-app) e puoi anche impostare valori condizionali. Per ulteriori informazioni, consulta Parametri e condizioni di configurazione remota .

Passaggio 6: recupera e attiva i valori

  1. Per recuperare i valori dei parametri dal backend Remote Config, chiamare il metodo fetchConfig() . Tutti i valori impostati sul backend vengono recuperati e memorizzati nella cache nell'oggetto Remote Config.
  2. Per rendere disponibili alla tua app i valori dei parametri recuperati, chiama il activate() .

Nei casi in cui desideri recuperare e attivare valori in una chiamata, utilizza fetchAndActivate() come mostrato in questo esempio:

Web modular API

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

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

Web namespaced API

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

Poiché questi valori dei parametri aggiornati influiscono sul comportamento e sull'aspetto della tua app, dovresti attivare i valori recuperati in un momento che garantisca un'esperienza fluida per il tuo utente, ad esempio la prossima volta che l'utente apre la tua app. Per ulteriori informazioni ed esempi, vedere Strategie di caricamento di Remote Config .

Limitazione

Se un'app recupera troppe volte in un breve periodo di tempo, le chiamate di recupero potrebbero essere limitate. In questi casi, l'SDK genera un errore FETCH_THROTTLE . Ti consigliamo di rilevare questo errore e riprovare in modalità backoff esponenziale, attendendo intervalli più lunghi tra le successive richieste di recupero.

Durante lo sviluppo dell'app, potresti voler aggiornare la cache molto frequentemente (molte volte all'ora) per poter eseguire rapidamente l'iterazione durante lo sviluppo e il test dell'app. Per consentire una rapida iterazione su un progetto con numerosi sviluppatori, puoi aggiungere temporaneamente una proprietà con un intervallo di recupero minimo basso ( Settings.minimumFetchIntervalMillis ) nella tua app.

L'intervallo di recupero della produzione predefinito e consigliato per Remote Config è di 12 ore, il che significa che le configurazioni non verranno recuperate dal backend più di una volta in una finestra di 12 ore, indipendentemente dal numero di chiamate di recupero effettivamente effettuate. Nello specifico, l'intervallo di recupero minimo è determinato nel seguente ordine:

  1. Il parametro in Settings.minimumFetchIntervalMillis .
  2. Il valore predefinito è 12 ore.

Prossimi passi

Se non l'hai già fatto, esplora i casi d'uso di configurazione remota e dai un'occhiata ad alcuni dei concetti chiave e alla documentazione di strategie avanzate, tra cui: