Modelli di configurazione remota e controllo delle versioni

Il modello Remote Config è l'insieme lato server di parametri e condizioni in formato JSON che hai creato per il tuo progetto Firebase. Puoi modificare e gestire il modello utilizzando la console Firebase, che visualizza il contenuto del modello in formato grafico nelle schede Parametri e Condizioni . Puoi anche utilizzare l' API REST Remote Config e l'Admin SDK o la CLI Firebase per modificare e gestire la tua configurazione.

Ecco un esempio di file modello:

  {
    "conditions": [
      {
        "name": "ios",
        "expression": "device.os == 'ios'"
      }
    ],
    "parameters": {
      "welcome_message": {
        "defaultValue": {
          "value": "Welcome to this sample app"
        },
        "conditionalValues": {
          "ios": {
            "value": "Welcome to this sample iOS app"
          }
        }
      },
      "welcome_message_caps": {
        "defaultValue": {
          "value": "false"
        }
      },
      "header_text": {
        "defaultValue": {
          "useInAppDefault": true
        }
      }
    },
    "version": {
      "versionNumber": "28",
      "updateTime": "2020-05-14T18:39:38.994Z",
      "updateUser": {
        "email": "user@google.com"
      },
      "updateOrigin": "CONSOLE",
      "updateType": "INCREMENTAL_UPDATE"
    }
  }

Ogni volta che si aggiornano i parametri, Remote Config crea un nuovo modello Remote Config con versione e memorizza il modello precedente come una versione che è possibile recuperare o ripristinare secondo necessità. I numeri di versione vengono incrementati in sequenza dal valore iniziale memorizzato da Remote Config. Tutti i modelli includono un campo version come mostrato, contenente metadati su quella versione specifica.

Con la console Firebase, la CLI Firebase o le API backend Remote Config, puoi eseguire queste attività di gestione delle versioni:

  • Elenca tutte le versioni del modello memorizzate
  • Recupera una versione specifica
  • Tornare a una versione specifica

È possibile eliminare i modelli Remote Config secondo necessità dalla pagina Cronologia modifiche sulla console Remote Config. Esiste un limite totale di 300 versioni archiviate per tutta la durata, inclusi i numeri di versione archiviati per i modelli eliminati. Se pubblichi più di 300 versioni di modello durante la durata di un progetto, le prime versioni verranno eliminate, mantenendo un massimo di 300 versioni.

Gestisci le versioni del modello Remote Config

Questa sezione descrive come gestire le versioni del modello Remote Config. Per ulteriori dettagli su come creare, modificare e salvare i modelli a livello di codice, vedere Modificare Remote Config a livello di codice .

Elenca tutte le versioni archiviate del modello Remote Config

È possibile recuperare un elenco di tutte le versioni archiviate del modello Remote Config. Per esempio:

Node.js

function listAllVersions() {
  admin.remoteConfig().listVersions()
    .then((listVersionsResult) => {
      console.log("Successfully fetched the list of versions");
      listVersionsResult.versions.forEach((version) => {
        console.log('version', JSON.stringify(version));
      });
    })
    .catch((error) => {
      console.log(error);
    });
}

Giava

ListVersionsPage page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
while (page != null) {
  for (Version version : page.getValues()) {
    System.out.println("Version: " + version.getVersionNumber());
  }
  page = page.getNextPage();
}

// Iterate through all versions. This will still retrieve versions in batches.
page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
for (Version version : page.iterateAll()) {
  System.out.println("Version: " + version.getVersionNumber());
}

RIPOSO

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:listVersions

Console Firebase

Nella scheda Parametri , seleziona l'icona "orologio" visualizzata in alto a destra. Si apre la pagina Cronologia modifiche che elenca tutte le versioni dei modelli archiviate in un menu di elenco a destra.

I dettagli visualizzati per ciascuna versione archiviata includono informazioni su se le modifiche hanno avuto origine con la console, con l'API REST, da un rollback o se si trattava di modifiche incrementali da un salvataggio forzato del modello.

CLI Firebase

firebase remoteconfig:versions:list

Utilizza l'opzione --limit per limitare il numero di versioni restituite. Passa "0" per recuperare tutte le versioni.

L'elenco dei modelli include i metadati per tutte le versioni archiviate, inclusa l'ora dell'aggiornamento, l'utente che lo ha effettuato e se è stato effettuato tramite la console o l'API REST. Ecco un esempio di un elemento di versione:

{
  "versions": [{
    "version_number": "6",
    "update_time": "2022-05-12T02:38:54Z",
    "update_user": {
      "name": "Jane Smith",
      "email": "jane@developer.org",
      "imageUrl": "https://lh3.googleusercontent.com/a-/..."
    },
    "description": "One small change on the console",
    "origin": "CONSOLE",
    "update_type": "INCREMENTAL_UPDATE"
  }]

Recupera una versione specifica del modello Remote Config

È possibile recuperare qualsiasi versione specifica memorizzata del modello Remote Config. Per esempio:

Node.js

Passa getTemplate() senza argomenti per recuperare la versione più recente del modello oppure, per recuperare una versione specifica, utilizza getTemplateAtVersion() .

// Get template version: 6
admin.remoteConfig().getTemplateAtVersion('6')
  .then((template) => {
    console.log("Successfully fetched the template with ETag: " + template.etag);
  })
  .catch((error) => {
    console.log(error);
  });

Giava

Template template = FirebaseRemoteConfig.getInstance().getTemplateAtVersionAsync(versionNumber).get();
// See the ETag of the fetched template.
System.out.println("Successfully fetched the template with ETag: " + template.getETag());

RIPOSO

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig?version_number=6

Il parametro URL ?version_number è valido solo per le operazioni GET ; non è possibile utilizzarlo per specificare i numeri di versione per gli aggiornamenti. Una richiesta get simile senza il parametro ?version_number recupererebbe il modello attivo corrente.

Console Firebase

Per impostazione predefinita, il riquadro dei dettagli nella scheda Cronologia modifiche visualizza il modello attivo corrente. Per visualizzare i dettagli di un'altra versione nell'elenco, selezionala dal menu a destra.

Puoi visualizzare una differenza dettagliata tra la versione attualmente selezionata e qualsiasi altra versione memorizzata passando il mouse sul menu contestuale di qualsiasi versione non selezionata e selezionando Confronta con la versione selezionata.

CLI Firebase

firebase remoteconfig:get -v VERSION_NUMBER

Facoltativamente, è possibile scrivere l'output in un file specificato con -o, FILENAME .

Eseguire il rollback a una versione memorizzata specifica del modello Remote Config

È possibile ripristinare qualsiasi versione memorizzata del modello. Per esempio:

Node.js

// Roll back to template version: 6
admin.remoteConfig().rollback('6')
  .then((template) => {
    console.log("Successfully rolled back to template version 6.");
    console.log("New ETag: " + template.etag);
  })
  .catch((error) => {
    console.log('Error trying to rollback:', e);
  })

Giava

try {
  Template template = FirebaseRemoteConfig.getInstance().rollbackAsync(versionNumber).get();
  System.out.println("Successfully rolled back to template version: " + versionNumber);
  System.out.println("New ETag: " + template.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Error trying to rollback template.");
    System.out.println(rcError.getMessage());
  }
}

RIPOSO

Per ripristinare un modello Remote Config archiviato, emettere un POST HTTP con il metodo personalizzato :rollback e, nel corpo della richiesta, la versione specifica da applicare. Per esempio:

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -H "Content-Type: application/json" -X POST https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:rollback -d '{"version_number": 6}'

La risposta contiene il contenuto del modello archiviato ora attivo, con i relativi metadati della nuova versione.

Console Firebase

Per le versioni precedenti del modello idonee al rollback, un pulsante di opzione per ripristinare quella versione viene visualizzato in alto a destra nella pagina Cronologia modifiche . Fai clic e confermalo solo se sei sicuro di voler tornare a quella versione e utilizzare immediatamente tali valori per tutte le app e gli utenti.

CLI Firebase

firebase remoteconfig:rollback -v VERSION_NUMBER

Tieni presente che questa operazione di rollback crea effettivamente una nuova versione numerata. Ad esempio, il rollback dalla versione 10 alla versione 6 crea effettivamente una nuova copia della versione 6, diversa dall'originale solo per il fatto che il suo numero di versione è 11. La versione 6 originale è ancora archiviata, presupponendo che non abbia raggiunto la scadenza, e la versione 11 diventa il modello attivo.

Elimina un modello Remote Config

Puoi eliminare i modelli Remote Config dalla console Firebase. Per eliminare un modello Remote Config:

  1. Dalla pagina Parametri di configurazione remota, fare clic su Modifica cronologia .

  2. Passa al modello che desideri eliminare, fai clic su Altro , quindi seleziona Elimina .

  3. Quando viene richiesto di confermare l'eliminazione, fare clic su Elimina .

Scarica e pubblica i modelli Remote Config

Scarica e pubblica modelli Remote Config per integrarli nel tuo controllo del codice sorgente e creare sistemi, automatizzare gli aggiornamenti di configurazione e mantenere parametri e valori sincronizzati su più progetti.

Puoi scaricare il modello Remote Config attualmente attivo a livello di programmazione o dalla console Firebase. Puoi quindi aggiornare il file JSON esportato e pubblicarlo nello stesso progetto oppure pubblicarlo in un progetto nuovo o esistente.

Supponiamo che tu abbia più progetti che rappresentano diverse fasi del ciclo di vita dello sviluppo software, come ambienti di sviluppo, test, gestione temporanea e produzione. In questo caso, potresti promuovere un modello completamente testato dal tuo ambiente di staging all'ambiente di produzione scaricandolo dal tuo progetto di staging e pubblicandolo nel tuo progetto di produzione.

È inoltre possibile utilizzare questo metodo per migrare le configurazioni da un progetto a un altro o popolare un nuovo progetto con parametri e valori da un progetto stabilito.

I parametri e i valori dei parametri creati appositamente come varianti in un esperimento di test A/B non sono inclusi nei modelli esportati.

Per esportare e importare modelli Remote Config:

  1. Scarica il modello di configurazione Remote Config corrente .
  2. Convalidare il modello Remote Config .
  3. Pubblica il modello Remote Config .

Scarica il modello di configurazione remota corrente

Puoi scaricare il modello Remote Config corrente e attivo a livello di codice o utilizzando la console Firebase.

Utilizzare i seguenti comandi per scaricare il modello Remote Config attivo in formato JSON:

Node.js

function getTemplate() {
  var config = admin.remoteConfig();
  config.getTemplate()
      .then(function (template) {
        console.log('ETag from server: ' + template.etag);
        var templateStr = JSON.stringify(template);
        fs.writeFileSync('config.json', templateStr);
      })
      .catch(function (err) {
        console.error('Unable to get template');
        console.error(err);
      });
}

Giava

Template template = FirebaseRemoteConfig.getInstance().getTemplateAsync().get();
// See the ETag of the fetched template.
System.out.println("ETag from server: " + template.getETag());

RIPOSO

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -o filename

Questo comando restituisce il payload JSON in un file e le intestazioni (incluso ETag) in un file headers separato.

Console Firebase

  1. Dalla scheda Parametri o Condizioni di configurazione remota , aprire il menu e selezionare Scarica file di configurazione corrente .
  2. Quando richiesto, fai clic su Scarica file di configurazione , scegli la posizione in cui desideri salvare il file, quindi fai clic su Salva .

CLI Firebase

firebase remoteconfig:get -o filename

Convalidare il modello Remote Config

Puoi convalidare gli aggiornamenti dei modelli prima di pubblicarli utilizzando Firebase Admin SDK o l'API REST. I modelli vengono convalidati anche quando tenti di pubblicare dalla CLI Firebase o dalla console Firebase.

Il processo di convalida del modello verifica la presenza di errori come chiavi duplicate per parametri e condizioni, nomi di condizioni non validi o condizioni inesistenti o ETag formattati in modo errato. Ad esempio, una richiesta contenente un numero di chiavi superiore a quello consentito, 2000, restituirebbe il messaggio di errore Param count too large .

Node.js

function validateTemplate(template) {
  admin.remoteConfig().validateTemplate(template)
      .then(function (validatedTemplate) {
        // The template is valid and safe to use.
        console.log('Template was valid and safe to use');
      })
      .catch(function (err) {
        console.error('Template is invalid and cannot be published');
        console.error(err);
      });
}

Giava

try {
  Template validatedTemplate = FirebaseRemoteConfig.getInstance()
          .validateTemplateAsync(template).get();
  System.out.println("Template was valid and safe to use");
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Template is invalid and cannot be published");
    System.out.println(rcError.getMessage());
  }
}

RIPOSO

Convalida gli aggiornamenti del modello aggiungendo il parametro URL ?validate_only=true alla tua richiesta di pubblicazione:

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig?validate_only=true -d @filename

Se il tuo modello è stato convalidato con successo, il comando curl restituisce il modello JSON che hai inviato e, nel file headers salvato, troverai uno stato HTTP/2 200 e un ETag aggiornato con il suffisso -0 . Se il tuo modello non è stato convalidato, riceverai l'errore di convalida nella risposta JSON e il file headers conterrà una risposta diversa da 200 (e nessun ETag).

Pubblica il modello Remote Config

Dopo aver scaricato un modello, apportato le modifiche necessarie al contenuto JSON e averlo convalidato, puoi pubblicarlo in un progetto.

La pubblicazione di un modello sostituisce l'intero modello di configurazione esistente con il file aggiornato e incrementa la versione del modello di uno. Poiché l'intera configurazione viene sostituita, se elimini un parametro dal file JSON e lo pubblichi, il parametro viene eliminato dal server e non è più disponibile per i client.

Dopo la pubblicazione, le modifiche ai parametri e ai valori sono immediatamente disponibili per le tue app e i tuoi utenti. Se necessario, puoi tornare a una versione precedente .

Utilizza i seguenti comandi per pubblicare il tuo modello:

Node.js

function publishTemplate() {
  var config = admin.remoteConfig();
  var template = config.createTemplateFromJSON(
      fs.readFileSync('config.json', 'UTF8'));
  config.publishTemplate(template)
      .then(function (updatedTemplate) {
        console.log('Template has been published');
        console.log('ETag from server: ' + updatedTemplate.etag);
      })
      .catch(function (err) {
        console.error('Unable to publish template.');
        console.error(err);
      });
}

Giava

try {
  Template publishedTemplate = FirebaseRemoteConfig.getInstance()
          .publishTemplateAsync(template).get();
  System.out.println("Template has been published");
  // See the ETag of the published template.
  System.out.println("ETag from server: " + publishedTemplate.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Unable to publish template.");
    System.out.println(rcError.getMessage());
  }
}

RIPOSO

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -d @filename

Per questo comando curl è possibile specificare il contenuto utilizzando il carattere "@", seguito dal nome del file.

Console Firebase

  1. Dalla scheda Parametri o condizioni di configurazione remota , aprire il menu e selezionare Pubblica da un file .
  2. Quando richiesto, fare clic su Sfoglia , individuare e selezionare il file Remote Config che si desidera pubblicare, quindi fare clic su Seleziona .
  3. Il file verrà convalidato e, in caso positivo, potrai fare clic su Pubblica per rendere la configurazione immediatamente disponibile per le tue app e i tuoi utenti.

Le personalizzazioni e le condizioni di Remote Config sono incluse nei modelli scaricati, quindi è importante essere consapevoli delle seguenti limitazioni quando si tenta di pubblicare su un progetto diverso:

  • Le personalizzazioni non possono essere importate da progetto a progetto.

    Ad esempio, se hai abilitato le personalizzazioni nel tuo progetto e scarichi e modifichi un modello, puoi pubblicarlo nello stesso progetto, ma non puoi pubblicarlo in un progetto diverso a meno che non elimini le personalizzazioni dal modello.

  • Le condizioni possono essere importate da progetto a progetto, ma tieni presente che eventuali valori condizionali specifici (come ID app o segmenti di pubblico) dovrebbero esistere nel progetto di destinazione prima della pubblicazione.

    Ad esempio, se disponi di un parametro Remote Config che utilizza una condizione che specifica un valore della piattaforma iOS , il modello può essere pubblicato in un altro progetto, poiché i valori della piattaforma sono gli stessi per qualsiasi progetto. Tuttavia, se contiene una condizione che si basa su un ID app o un pubblico di utenti specifico che non esiste nel progetto di destinazione, la convalida avrà esito negativo.

  • Se il modello che prevedi di pubblicare contiene condizioni che si basano su Google Analytics, Analytics deve essere abilitato nel progetto di destinazione.

Scarica le impostazioni predefinite del modello Remote Config

Poiché la tua app potrebbe non essere sempre connessa a Internet, dovresti configurare i valori predefiniti dell'app lato client per tutti i parametri di Remote Config. Dovresti anche sincronizzare periodicamente i valori predefiniti del client dell'app e i valori predefiniti dei parametri del backend Remote Config, poiché potrebbero cambiare nel tempo.

Come descritto nei collegamenti specifici della piattaforma alla fine di questa sezione, puoi impostare manualmente queste impostazioni predefinite nella tua app oppure puoi semplificare questo processo scaricando file che contengono solo le coppie chiave-valore per tutti i parametri e i relativi valori predefiniti nella sezione modello Remote Config attivo. Puoi quindi includere questo file nel tuo progetto e configurare la tua app per importare questi valori.

Puoi scaricare questi file in formato XML per le app Android, formato elenco proprietà (plist) per le app iOS e JSON per le app Web.

Ti consigliamo di scaricare periodicamente le impostazioni predefinite di Remote Config prima di qualsiasi nuova versione dell'app per garantire che la tua app e il backend Remote Config rimangano sincronizzati.

Per scaricare un file che contiene le impostazioni predefinite del modello:

RIPOSO

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

Utilizza XML , PLIST o JSON come valore format , a seconda del formato di file che desideri scaricare.

Console Firebase

  1. Nella scheda Parametri , apri il menu e seleziona Scarica valori predefiniti .
  2. Quando richiesto, fai clic sul pulsante di opzione che corrisponde al formato di file che desideri scaricare, quindi fai clic su Scarica file .

Per ulteriori informazioni sull'importazione dei valori predefiniti di Remote Config nella tua app, consulta: