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 alcuni esempi di codice, tutti disponibili per la clonazione o il download dal repository GitHub firebase/quickstart-js .
Passaggio 1: aggiungere e inizializzare Remote Config SDK
Se non lo hai già fatto, installa Firebase JS SDK e inizializza Firebase .
Aggiungere Remote Config JS SDK e inizializzare 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 back-end Remote Config e controllare quando i valori recuperati vengono resi disponibili per la tua app.
Passaggio 2: imposta l'intervallo di recupero minimo
Durante lo sviluppo, è consigliabile impostare un intervallo di recupero minimo relativamente basso. Vedere Limitazione per ulteriori informazioni.
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 back-end Remote Config e in modo che i valori predefiniti siano disponibili se nessuno è impostato sul back-end.
Web modular API
remoteConfig.defaultConfig = { "welcome_message": "Welcome" };
Web namespaced API
remoteConfig.defaultConfig = { "welcome_message": "Welcome" };
Se hai già configurato i valori dei parametri back-end di Remote Config, puoi scaricare un file JSON generato che include tutti i valori predefiniti e includerlo nel tuo app bundle:
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
- Nella scheda Parametri , apri il menu e seleziona Scarica valori predefiniti .
- Quando richiesto, abilita .json per il Web , quindi fai clic su Scarica file .
Gli esempi seguenti mostrano due modi diversi per importare e impostare i valori predefiniti nella tua app. Il primo esempio utilizza fetch
, che effettuerà una richiesta HTTP al file defaults incluso nel bundle dell'app:
const rcDefaultsFile = await fetch('remote_config_defaults.json'); const rcDefaultsJson = await rcDefaultsFile.json(); remoteConfig.defaultConfig = rcDefaultsJson;
Il prossimo esempio usa require
, che compila i valori nella tua app al momento della 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 successivamente imposti valori nel back-end, 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 back-end Remote Config , puoi creare nuovi valori predefiniti lato server che sovrascrivono i valori in-app in base alla logica condizionale o al targeting utente desiderati. Questa sezione ti guida attraverso i passaggi della console Firebase per creare questi valori.
- Nella console Firebase , apri il tuo progetto.
- Seleziona Remote Config dal menu per visualizzare la dashboard di Remote Config.
- Definisci i parametri con gli stessi nomi dei parametri che hai definito nella tua app. Per ogni parametro, puoi impostare un valore predefinito (che alla fine sostituirà il valore predefinito in-app) e puoi anche impostare valori condizionali. Per ulteriori informazioni, consulta Parametri e condizioni di configurazione remota .
Passaggio 6: recuperare e attivare i valori
- Per recuperare i valori dei parametri dal backend Remote Config, chiama il metodo
fetchConfig()
. Tutti i valori impostati sul back-end vengono recuperati e memorizzati nella cache nell'oggetto Remote Config. - Per rendere i valori dei parametri recuperati disponibili per la tua app, chiama il
activate()
.
Per i casi in cui si desidera recuperare e attivare i valori in una chiamata, utilizzare 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, devi attivare i valori recuperati in un momento che garantisca un'esperienza fluida per l'utente, ad esempio la volta successiva che l'utente apre la tua app. Vedere Strategie di caricamento della configurazione remota per ulteriori informazioni ed esempi.
Limitazione
Se un'app recupera troppe volte in un breve periodo di tempo, le chiamate di recupero potrebbero essere limitate. In tali casi, l'SDK genera un errore FETCH_THROTTLE
. Si consiglia 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 (più volte all'ora) per consentire un'iterazione rapida 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 di produzione predefinito e consigliato per Remote Config è di 12 ore, il che significa che le configurazioni non verranno recuperate dal back-end più di una volta in una finestra di 12 ore, indipendentemente dal numero di chiamate di recupero effettivamente effettuate. In particolare, l'intervallo di recupero minimo è determinato nel seguente ordine:
- Il parametro in
Settings.minimumFetchIntervalMillis
. - Il valore predefinito di 12 ore.
Prossimi passi
Se non l'hai già fatto, esplora i casi d'uso di Remote Config e dai un'occhiata ad alcuni dei concetti chiave e alla documentazione delle strategie avanzate, tra cui: