Modifica la configurazione remota a livello di codice

Questo documento descrive come leggere e modificare in modo programmatico il set di parametri e condizioni in formato JSON noto come modello di configurazione remota . Ciò ti consente di apportare modifiche al modello sul back-end che l'app client può recuperare utilizzando la libreria client.

Utilizzando l' API REST di Remote Config o gli Admin SDK descritti in questa guida, puoi ignorare la gestione del modello nella console Firebase per integrare direttamente le modifiche di Remote Config nei tuoi processi. Ad esempio, con le API di back-end di Remote Config, puoi:

  • Pianificazione degli aggiornamenti di configurazione remota . Utilizzando le chiamate API insieme a un processo cron, puoi modificare i valori di Remote Config in base a una pianificazione regolare.
  • Importa in batch i valori di configurazione per passare in modo efficiente dal tuo sistema proprietario a Firebase Remote Config.
  • Usa Remote Config con Cloud Functions per Firebase , modificando i valori nella tua app in base agli eventi che si verificano lato server. Ad esempio, puoi utilizzare Remote Config per promuovere una nuova funzionalità nella tua app e quindi disattivare automaticamente tale promozione una volta rilevata che un numero sufficiente di persone ha interagito con la nuova funzionalità.

    Diagramma che mostra il back-end di Remote Config che interagisce con strumenti e server personalizzati

Le sezioni seguenti di questa guida descrivono le operazioni che puoi eseguire con le API back-end di Remote Config. Per esaminare del codice che esegue queste attività tramite l'API REST, vedere una di queste app di esempio:

Modifica Remote Config utilizzando Firebase Admin SDK

Admin SDK è un insieme di librerie server che ti consentono di interagire con Firebase da ambienti privilegiati. Oltre a eseguire aggiornamenti a Remote Config, Admin SDK consente la generazione e la verifica dei token di autenticazione Firebase, la lettura e la scrittura dal database in tempo reale e così via. Per ulteriori informazioni sui prerequisiti e sulla configurazione dell'SDK di amministrazione, consulta Aggiungere l'SDK di amministrazione di Firebase al server .

In un tipico flusso di configurazione remota, è possibile ottenere il modello corrente, modificare alcuni parametri o gruppi di parametri e condizioni, convalidare il modello e quindi pubblicarlo. Prima di effettuare tali chiamate API, devi autorizzare le richieste dall'SDK.

Inizializza l'SDK e autorizza le richieste API

Quando inizializzi l'SDK di amministrazione senza parametri, l'SDK utilizza le credenziali predefinite dell'applicazione Google e legge le opzioni dalla variabile di ambiente FIREBASE_CONFIG . Se il contenuto della variabile FIREBASE_CONFIG inizia con un { , verrà analizzato come un oggetto JSON. In caso contrario, l'SDK presuppone che la stringa sia il nome di un file JSON contenente le opzioni.

Per esempio:

Node.js

const admin = require('firebase-admin');
admin.initializeApp();

Giava

FileInputStream serviceAccount = new FileInputStream("service-account.json");
FirebaseOptions options = FirebaseOptions.builder()
        .setCredentials(GoogleCredentials.fromStream(serviceAccount))
        .build();
FirebaseApp.initializeApp(options);

Ottieni il modello di configurazione remota corrente

Quando si lavora con i modelli di configurazione remota, tenere presente che hanno una versione e che ogni versione ha una durata limitata dal momento della creazione al momento in cui la si sostituisce con un aggiornamento: 90 giorni, con un limite totale di 300 versioni archiviate. Per ulteriori informazioni, vedere Modelli e controllo delle versioni .

Puoi utilizzare le API di back-end per ottenere la versione attiva corrente del modello di configurazione remota in formato JSON. Per ottenere il modello:

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

Modifica i parametri di configurazione remota

È possibile modificare e aggiungere a livello di codice parametri Remote Config e gruppi di parametri. Ad esempio, a un gruppo di parametri esistente denominato "nuovo_menu" è possibile aggiungere un parametro per controllare la visualizzazione delle informazioni stagionali:

Node.js

function addParameterToGroup(template) {
  template.parameterGroups['new_menu'].parameters['spring_season'] = {
    defaultValue: {
      useInAppDefault: true
    },
    description: 'spring season menu visibility.',
  };
}

Giava

template.getParameterGroups().get("new_menu").getParameters()
        .put("spring_season", new Parameter()
                .setDefaultValue(ParameterValue.inAppDefault())
                .setDescription("spring season menu visibility.")
        );

L'API consente di creare nuovi parametri e gruppi di parametri o modificare valori predefiniti, valori condizionali e descrizioni. In tutti i casi, è necessario pubblicare in modo esplicito il modello dopo aver apportato le modifiche.

Modifica le condizioni di configurazione remota

È possibile modificare e aggiungere a livello di codice condizioni di configurazione remota e valori condizionali. Ad esempio, per aggiungere una nuova condizione:

Node.js

function addNewCondition(template) {
  template.conditions.push({
    name: 'android_en',
    expression: 'device.os == \'android\' && device.country in [\'us\', \'uk\']',
    tagColor: 'BLUE',
  });
}

Giava

template.getConditions().add(new Condition("android_en",
        "device.os == 'android' && device.country in ['us', 'uk']", TagColor.BLUE));

In tutti i casi, è necessario pubblicare in modo esplicito il modello dopo aver apportato le modifiche.

Le API di back-end di Remote Config forniscono diverse condizioni e operatori di confronto che puoi usare per modificare il comportamento e l'aspetto della tua app. Per ulteriori informazioni sulle condizioni e sugli operatori supportati per queste condizioni, vedere il riferimento all'espressione condizionale .

Convalida il modello di configurazione remota

Facoltativamente, puoi convalidare i tuoi aggiornamenti prima di pubblicarli, come mostrato:

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

Questo processo di convalida 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, restituirà il messaggio di errore, Param count too large .

Pubblica il modello di configurazione remota

Dopo aver recuperato un modello e averlo rivisto con gli aggiornamenti desiderati, puoi quindi pubblicarlo. La pubblicazione di un modello come descritto in questa sezione sostituisce l'intero modello di configurazione esistente con il file aggiornato e al nuovo modello attivo viene assegnato un numero di versione maggiore di un numero rispetto al modello che ha sostituito.

Se necessario, puoi utilizzare l'API REST per tornare alla versione precedente . Per ridurre il rischio di errori in un aggiornamento, puoi convalidare prima di pubblicare .

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

Modifica la configurazione remota utilizzando l'API REST

Questa sezione descrive le funzionalità principali dell'API REST Remote Config all'indirizzo https://firebaseremoteconfig.googleapis.com . Per i dettagli completi, vedere il riferimento API .

Ottieni un token di accesso per autenticare e autorizzare le richieste API

I progetti Firebase supportano gli account di servizio Google , che puoi utilizzare per chiamare le API del server Firebase dal server dell'app o dall'ambiente attendibile. Se stai sviluppando codice in locale o distribuendo l'applicazione in locale, puoi usare le credenziali ottenute tramite questo account di servizio per autorizzare le richieste del server.

Per autenticare un account di servizio e autorizzarlo ad accedere ai servizi Firebase, devi generare un file di chiave privata in formato JSON.

Per generare un file di chiave privata per il tuo account di servizio:

  1. Nella console Firebase, apri Impostazioni > Account di servizio .

  2. Fare clic su Genera nuova chiave privata , quindi confermare facendo clic su Genera chiave .

  3. Archivia in modo sicuro il file JSON contenente la chiave.

Quando si autorizza tramite un account di servizio, sono disponibili due opzioni per fornire le credenziali all'applicazione. Puoi impostare la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS oppure passare in modo esplicito il percorso alla chiave dell'account di servizio nel codice. La prima opzione è più sicura ed è fortemente consigliata.

Per impostare la variabile di ambiente:

Imposta la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS sul percorso del file JSON che contiene la chiave dell'account di servizio. Questa variabile si applica solo alla tua sessione di shell corrente, quindi se apri una nuova sessione, imposta nuovamente la variabile.

Linux o macOS

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

finestre

Con PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

Dopo aver completato i passaggi precedenti, Application Default Credentials (ADC) è in grado di determinare implicitamente le tue credenziali, consentendoti di utilizzare le credenziali dell'account di servizio durante il test o l'esecuzione in ambienti non Google.

Utilizza le tue credenziali Firebase insieme a Google Auth Library per la tua lingua preferita per recuperare un token di accesso OAuth 2.0 di breve durata:

nodo.js

 function getAccessToken() {
  return admin.credential.applicationDefault().getAccessToken()
      .then(accessToken => {
        return accessToken.access_token;
      })
      .catch(err => {
        console.error('Unable to get access token');
        console.error(err);
      });
}

In questo esempio, la libreria client dell'API di Google autentica la richiesta con un token web JSON o JWT. Per ulteriori informazioni, consulta Token Web JSON .

Pitone

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      'service-account.json', SCOPES)
  access_token_info = credentials.get_access_token()
  return access_token_info.access_token

Giava

private static String getAccessToken() throws IOException {
  GoogleCredentials googleCredentials = GoogleCredentials
          .fromStream(new FileInputStream("service-account.json"))
          .createScoped(Arrays.asList(SCOPES));
  googleCredentials.refreshAccessToken();
  return googleCredentials.getAccessToken().getTokenValue();
}

Dopo la scadenza del token di accesso, il metodo di aggiornamento del token viene chiamato automaticamente per recuperare un token di accesso aggiornato.

Per autorizzare l'accesso a Remote Config, richiedi l'ambito https://www.googleapis.com/auth/firebase.remoteconfig .

Modifica il modello di configurazione remota

Quando si lavora con i modelli di configurazione remota, tenere presente che hanno una versione e che ogni versione ha una durata limitata dal momento della creazione al momento in cui la si sostituisce con un aggiornamento: 90 giorni, con un limite totale di 300 versioni archiviate. Per ulteriori informazioni, vedere Modelli e controllo delle versioni .

Ottieni il modello di configurazione remota corrente

Puoi utilizzare le API di back-end per ottenere la versione attiva corrente del modello di configurazione remota in formato JSON. Utilizzare i seguenti comandi:

arricciare

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 l'Etag) in un file separato.

Richiesta HTTP grezza

Host: firebaseremoteconfig.googleapis.com

GET /v1/projects/my-project-id/remoteConfig HTTP/1.1
Authorization: Bearer token
Accept-Encoding: gzip

Questa chiamata API restituisce il seguente JSON, insieme a un'intestazione separata che include un ETag che utilizzi per la richiesta successiva.

Convalida il modello di configurazione remota

Facoltativamente, puoi convalidare i tuoi aggiornamenti prima di pubblicarli. Convalida gli aggiornamenti del modello aggiungendo alla tua richiesta di pubblicazione il parametro URL ?validate_only=true . Nella risposta, un codice di stato 200 e un etag aggiornato con il suffisso -0 significano che l'aggiornamento è stato convalidato correttamente. Qualsiasi risposta diversa da 200 indica che i dati JSON contengono errori che devi correggere prima della pubblicazione.

Aggiorna il modello di configurazione remota

Dopo aver recuperato un modello e rivisto il contenuto JSON con gli aggiornamenti desiderati, puoi quindi pubblicarlo. La pubblicazione di un modello come descritto in questa sezione sostituisce l'intero modello di configurazione esistente con il file aggiornato e al nuovo modello attivo viene assegnato un numero di versione maggiore di un numero rispetto al modello che ha sostituito.

Se necessario, puoi utilizzare l'API REST per tornare alla versione precedente . Per ridurre il rischio di errori in un aggiornamento, puoi convalidare prima di pubblicare .

arricciare

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 , puoi specificare il contenuto utilizzando il carattere "@", seguito dal nome del file.

Richiesta HTTP grezza

Host: firebaseremoteconfig.googleapis.com
PUT /v1/projects/my-project-id/remoteConfig HTTP/1.1
Content-Length: size
Content-Type: application/json; UTF8
Authorization: Bearer token
If-Match: expected ETag
Accept-Encoding: gzip
JSON_HERE

Poiché si tratta di una richiesta di scrittura, l' ETag viene modificato da questo comando e viene fornito un ETag aggiornato nelle intestazioni della risposta del comando PUT successivo.

Modifica le condizioni di configurazione remota

È possibile modificare a livello di codice le condizioni di configurazione remota e i valori condizionali. Con l'API REST, è necessario modificare direttamente il modello per modificare le condizioni prima di pubblicare il modello.

{
  "conditions": [{
    "name": "android_english",
    "expression": "device.os == 'android' && device.country in ['us', 'uk']",
    "tagColor": "BLUE"
  }, {
    "name": "tenPercent",
    "expression": "percent <= 10",
    "tagColor": "BROWN"
  }],
  "parameters": {
    "welcome_message": {
      "defaultValue": {
        "value": "Welcome to this sample app"
      },
      "conditionalValues": {
        "tenPercent": {
          "value": "Welcome to this new sample app"
        }
      },
      "description": "The sample app's welcome message"
    },
    "welcome_message_caps": {
      "defaultValue": {
        "value": "false"
      },
      "conditionalValues": {
        "android_english": {
          "value": "true"
        }
      },
      "description": "Whether the welcome message should be displayed in all capital letters."
    }
  }
}

Le modifiche precedenti definiscono prima un insieme di condizioni, quindi definiscono i valori predefiniti e i valori dei parametri basati sulle condizioni (valori condizionali ) per ciascun parametro. Aggiunge anche una descrizione opzionale per ogni elemento; come i commenti sul codice, questi sono per l'uso da parte degli sviluppatori e non vengono visualizzati nell'app. Viene fornito anche un ETag per scopi di controllo della versione.

Le API di back-end di Remote Config forniscono diverse condizioni e operatori di confronto che puoi usare per modificare il comportamento e l'aspetto della tua app. Per ulteriori informazioni sulle condizioni e sugli operatori supportati per queste condizioni, vedere il riferimento all'espressione condizionale .

Codici di errore HTTP

Codice di stato Significato
200 Aggiornato con successo
400 Si è verificato un errore di convalida. Ad esempio, una richiesta contenente un numero di chiavi superiore a quello consentito, 2000, restituirà 400 (Richiesta errata) con il messaggio di errore Param count too large . Inoltre, questo codice di stato HTTPS può verificarsi in queste due situazioni:
  • Si è verificato un errore di mancata corrispondenza della versione perché il set di valori e condizioni è stato aggiornato dall'ultimo recupero di un valore ETag. Per risolvere questo problema, dovresti utilizzare un comando GET per ottenere un nuovo modello e un valore ETag, aggiornare il modello e quindi inviare utilizzando quel modello e il nuovo valore ETag.
  • È stato eseguito un comando PUT (richiesta di aggiornamento del modello di configurazione remota) senza specificare un'intestazione If-Match .
401 Si è verificato un errore di autorizzazione (non è stato fornito alcun token di accesso o l'API REST di Firebase Remote Config non è stata aggiunta al progetto nella Cloud Developer Console)
403 Si è verificato un errore di autenticazione (è stato fornito il token di accesso errato)
500 Si è verificato un errore interno. Se si verifica questo errore, invia un ticket di supporto Firebase

Un codice di stato 200 significa che il modello Remote Config (parametri, valori e condizioni per il progetto) è stato aggiornato ed è ora disponibile per le app che utilizzano questo progetto. Altri codici di stato indicano che il modello di configurazione remota esistente in precedenza è ancora in vigore.

Dopo aver inviato gli aggiornamenti al modello, vai alla console Firebase per verificare che le modifiche appaiano come previsto. Questo è fondamentale perché l'ordine delle condizioni influisce sul modo in cui vengono valutate (la prima condizione che valuta true ha effetto).

Utilizzo di ETag e aggiornamenti forzati

L'API REST di Remote Config usa un tag di entità (ETag) per prevenire condizioni di competizione e aggiornamenti sovrapposti alle risorse. Per ulteriori informazioni sugli ETag, consulta ETag - HTTP .

Per l'API REST, Google consiglia di memorizzare nella cache l'ETag fornito dal comando GET più recente e di utilizzare quel valore ETag nell'intestazione della richiesta If-Match quando si emettono i comandi PUT . Se il tuo comando PUT genera un codice di stato HTTPS 409, dovresti emettere un nuovo comando GET per acquisire un nuovo ETag e un nuovo modello da utilizzare con il tuo prossimo comando PUT .

Puoi aggirare l'ETag e la protezione che fornisce, forzando l'aggiornamento del modello Remote Config come segue: If-Match: * Tuttavia, questo approccio non è consigliato perché rischia di causare la perdita di aggiornamenti al tuo Remote Config modello se più client stanno aggiornando il modello di configurazione remota. Questo tipo di conflitto potrebbe verificarsi con più client che utilizzano l'API o con aggiornamenti in conflitto da client API e utenti della console Firebase.

Per indicazioni sulla gestione delle versioni dei modelli di configurazione remota, vedere modelli e versioni di configurazione remota .