Inizia a utilizzare Firebase Remote Config

iOS+ Android Web Flutter Unity C++

Importante: questa sezione descrive i passaggi per configurare Remote Config con client web e mobile. Per gli ambienti server, consulta Utilizzare Remote Config negli ambienti server.

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. Questa guida ti illustra 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: aggiungi e inizializza l'SDK Remote Config

Nota :durante l'installazione dell'SDK, hai la possibilità di aggiungere la dipendenza per Analytics. Analytics è obbligatorio per il Remote Config targeting condizionale delle istanze dell'app alle proprietà utente e ai segmenti di pubblico.

1. Se non l'hai ancora fatto, installa l'SDK Firebase JS e inizializza Firebase.

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

Web

Scopri di più sull'API web modulare tree-shakeable e sull'upgrade dall'API con spazio dei nomi.

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

Scopri di più sull'API web modulare tree-shakeable e sull'upgrade dall'API con spazio dei nomi.

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 per la tua app.

Passaggio 2: imposta l'intervallo di recupero minimo

Durante lo sviluppo, ti consigliamo di impostare un intervallo di recupero minimo relativamente basso. Per ulteriori informazioni, consulta la sezione Limitazione.

Web

// The default and recommended production fetch interval for Remote Config is 12 hours
remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
rc_set_minimum_fetch_time.js

Web

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
index.js

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

Puoi impostare i valori parametro predefiniti in-app nell'oggetto Remote Config, in modo che l'app si comporti come previsto prima di connettersi al backend Remote Config e che i valori predefiniti siano disponibili se non ne sono impostati nel backend.

Importante: non memorizzare dati riservati nelle chiavi o nei valori dei parametri Remote Config. I dati Remote Config vengono criptati in transito, ma gli utenti finali possono accedere a qualsiasi parametro Remote Config predefinito o recuperato disponibile per la loro istanza dell'app client.

Web

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

Web

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

Se hai già configurato i valori dei parametri di backend Remote Config, puoi scaricare un file JSON generato che include tutti i valori predefiniti e includerlo nell'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

Console Firebase

1. Nella scheda Parametri, apri il menu e seleziona Scarica valori predefiniti.
2. Quando richiesto, attiva .json per il web, poi fai clic su Scarica file.

I seguenti esempi 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 predefinito incluso nel bundle 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 nell'app al momento della compilazione:

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

Passaggio 4: ottieni i valori dei parametri da utilizzare nell'app

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

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

Passaggio 5: imposta i valori dei parametri

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

1. Nella console Firebase, apri il tuo progetto.
2. Seleziona Remote Config dal menu per visualizzare la dashboard Remote Config.
3. Definisci i parametri con gli stessi nomi dei parametri definiti 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 saperne di più, consulta Remote Config Parametri e condizioni.

4. Se utilizzi condizioni di indicatori personalizzati, definisci gli attributi e i relativi valori. Il seguente esempio mostra come definire una condizione di segnale personalizzata.

     let customSignals = {
        "city": "Tokyo",
        "preferred_event_category": "sports"
     }
   
     setCustomSignals(config, customSignals);

Passaggio 6: recupera e attiva i valori

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

Per i casi in cui vuoi recuperare e attivare i valori in una sola chiamata, utilizza fetchAndActivate() come mostrato in questo esempio:

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

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. Per ulteriori informazioni ed esempi, consulta Strategie di caricamento di Remote Config.

Limitazione

Se un'app esegue troppi recuperi 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à di backoff esponenziale, attendendo intervalli più lunghi tra le richieste di recupero successive.

Durante lo sviluppo dell'app, potresti voler aggiornare la cache molto spesso (molte volte all'ora) per poter eseguire rapidamente le iterazioni durante lo sviluppo e il test dell'app. Per consentire iterazioni rapide in 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 un periodo di 12 ore, indipendentemente dal numero di chiamate di recupero effettuate. Nello specifico, l'intervallo di recupero minimo viene determinato nel seguente ordine:

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

Tieni presente che questa impostazione deve essere utilizzata solo per lo sviluppo, non per un'app in esecuzione in produzione. Se stai solo testando la tua app con un piccolo team di sviluppo di 10 persone, è improbabile che tu raggiunga i limiti di quota oraria lato servizio. Tuttavia, se hai distribuito la tua app a migliaia di utenti di test con un intervallo di recupero minimo molto basso, la tua app probabilmente raggiungerà questa quota.

Passaggi successivi

Se non l'hai ancora fatto, esplora i Remote Config casi d'uso e dai un'occhiata ad alcuni dei concetti chiave e alla documentazione sulle strategie avanzate, tra cui:

• Gestire le versioni del modello Remote Config
• Strategie di caricamento della configurazione