Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

Remote-Konfigurationsvorlagen und Versionierung

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Die Remote Config-Vorlage ist der serverseitige Satz von JSON-formatierten Parametern und Bedingungen, die Sie für Ihr Firebase-Projekt erstellt haben. Sie können die Vorlage mithilfe der Firebase-Konsole ändern und verwalten, die den Inhalt der Vorlage in grafischer Form auf den Registerkarten „Parameter“ und „ Bedingungen “ anzeigt. Sie können auch die Remote Config-Back-End-APIs oder die Firebase-CLI verwenden, um Ihre Konfiguration zu ändern und zu verwalten.

Hier ist ein Beispiel für eine Vorlagendatei:

  {
    "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"
    }
  }

Jedes Mal, wenn Sie Parameter aktualisieren, erstellt Remote Config eine neue versionierte Remote Config-Vorlage und speichert die vorherige Vorlage als eine Version, die Sie nach Bedarf abrufen oder wiederherstellen können. Versionsnummern werden sequenziell ab dem von Remote Config gespeicherten Anfangswert erhöht. Alle Vorlagen enthalten ein version wie gezeigt, das Metadaten zu dieser bestimmten Version enthält.

Mit der Firebase-Konsole, der Firebase-CLI oder den Remote Config-Back-End-APIs können Sie diese Versionsverwaltungsaufgaben ausführen:

  • Alle gespeicherten Vorlagenversionen auflisten
  • Rufen Sie eine bestimmte Version ab
  • Zurücksetzen auf eine bestimmte Version

Denken Sie beim Verwalten von Remote Config-Vorlagen an den Ablaufschwellenwert: Die aktuell aktive Remote Config-Vorlage, die von Ihrer App verwendet wird, läuft nicht ab; wird sie jedoch durch ein Update ersetzt, wird die vorherige Version nur 90 Tage gespeichert, danach verfällt sie und kann nicht mehr abgerufen werden. Es gibt auch ein Gesamtlimit von 300 gespeicherten Versionen. Wenn Sie eine Vorlage außerhalb dieser Grenzen speichern oder wiederherstellen möchten, speichern und speichern Sie sie manuell.

Versionen von Remote Config-Vorlagen verwalten

In diesem Abschnitt wird beschrieben, wie Sie Versionen Ihrer Remote Config-Vorlage verwalten. Weitere Einzelheiten zum programmgesteuerten Erstellen, Ändern und Speichern von Vorlagen finden Sie unter Programmgesteuertes Ändern von Remote-Konfigurationen .

Alle gespeicherten Versionen der Remote Config-Vorlage auflisten

Sie können eine Liste aller gespeicherten Versionen der Remote Config-Vorlage abrufen. Zum Beispiel:

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

Java

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

SICH AUSRUHEN

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

Firebase-Konsole

Wählen Sie auf der Registerkarte Parameter das oben rechts angezeigte Symbol „Uhr“ aus. Dadurch wird die Seite „ Änderungsverlauf “ geöffnet, auf der alle gespeicherten Vorlagenversionen in einem Listenmenü auf der rechten Seite aufgeführt sind.

Zu den Details, die für jede gespeicherte Version angezeigt werden, gehören Informationen darüber, ob die Änderungen von der Konsole, von der REST-API, von einem Rollback stammen oder ob es sich um inkrementelle Änderungen aus einer erzwungenen Speicherung der Vorlage handelt.

Firebase-CLI

firebase remoteconfig:versions:list

Verwenden Sie die Option --limit , um die Anzahl der zurückgegebenen Versionen zu begrenzen. Übergeben Sie '0', um alle Versionen abzurufen.

Die Liste der Vorlagen enthält Metadaten für alle gespeicherten Versionen, einschließlich des Zeitpunkts der Aktualisierung, des Benutzers, der sie erstellt hat, und ob sie über die Konsole oder die REST-API erstellt wurde. Hier ist ein Beispiel für ein Versionselement:

{
  "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"
  }]

Rufen Sie eine bestimmte Version der Remote Config-Vorlage ab

Sie können jede spezifische gespeicherte Version der Remote Config-Vorlage abrufen. Zum Beispiel:

Node.js

getTemplate() ohne Argumente, um die neueste Version der Vorlage abzurufen, oder verwenden getTemplateAtVersion() , um eine bestimmte Version abzurufen.

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

Java

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

SICH AUSRUHEN

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

Der URL-Parameter ?version_number ist nur für GET -Operationen gültig; Sie können es nicht verwenden, um Versionsnummern für Updates anzugeben. Eine ähnliche Get-Anfrage ohne den Parameter ?version_number würde die aktuell aktive Vorlage abrufen.

Firebase-Konsole

Standardmäßig zeigt der Detailbereich auf der Registerkarte „ Änderungsverlauf “ die aktuell aktive Vorlage an. Um Details für eine andere Version in der Liste anzuzeigen, wählen Sie sie im rechten Menü aus.

Sie können einen detaillierten Vergleich der aktuell ausgewählten Version und jeder anderen gespeicherten Version anzeigen, indem Sie den Mauszeiger über das Kontextmenü für eine nicht ausgewählte Version bewegen und Mit ausgewählter Version vergleichen auswählen.

Firebase-CLI

firebase remoteconfig:get -v VERSION_NUMBER

Optional können Sie die Ausgabe mit -o, FILENAME in eine angegebene Datei schreiben.

Zurücksetzen auf eine bestimmte gespeicherte Version der Remote-Konfigurationsvorlage

Sie können zu jeder gespeicherten Version der Vorlage zurückkehren. Zum Beispiel:

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

Java

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

SICH AUSRUHEN

Um zu einer gespeicherten Remote-Konfigurationsvorlage zurückzukehren, geben Sie einen HTTP-POST mit der benutzerdefinierten Methode :rollback und im Anforderungstext die anzuwendende spezifische Version aus. Zum Beispiel:

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}'

Die Antwort enthält den Inhalt der jetzt aktiven gespeicherten Vorlage mit den Metadaten der neuen Version.

Firebase-Konsole

Für frühere Vorlagenversionen, die für ein Rollback in Frage kommen, wird oben rechts auf der Seite „ Änderungsverlauf “ eine Optionsschaltfläche zum Zurücksetzen auf diese Version angezeigt. Klicken und bestätigen Sie dies nur, wenn Sie sicher sind, dass Sie zu dieser Version zurückkehren und diese Werte sofort für alle Apps und Benutzer verwenden möchten.

Firebase-CLI

firebase remoteconfig:rollback -v VERSION_NUMBER

Beachten Sie, dass dieser Rollback-Vorgang effektiv eine neue nummerierte Version erstellt. Beispielsweise erstellt ein Rollback von Version 10 auf Version 6 effektiv eine neue Kopie von Version 6, die sich vom Original nur dadurch unterscheidet, dass ihre Versionsnummer 11 ist. Die ursprüngliche Version 6 wird immer noch gespeichert, vorausgesetzt, sie hat ihr Ablaufdatum nicht erreicht, und Version 11 wird zur aktiven Vorlage.

Laden Sie Remote Config-Vorlagen herunter und veröffentlichen Sie sie

Laden Sie Remote-Konfigurationsvorlagen herunter und veröffentlichen Sie sie, um sie in Ihre Versionsverwaltungs- und Build-Systeme zu integrieren, Konfigurationsaktualisierungen zu automatisieren und Parameter und Werte über mehrere Projekte hinweg synchron zu halten.

Sie können die derzeit aktive Remote Config-Vorlage programmgesteuert oder über die Firebase-Konsole herunterladen. Anschließend können Sie die exportierte JSON-Datei aktualisieren und im selben Projekt veröffentlichen oder in einem neuen oder vorhandenen Projekt veröffentlichen.

Angenommen, Sie haben mehrere Projekte, die verschiedene Phasen Ihres Softwareentwicklungslebenszyklus darstellen, wie Entwicklungs-, Test-, Staging- und Produktionsumgebungen. In diesem Fall könnten Sie eine vollständig getestete Vorlage aus Ihrer Staging-Umgebung in Ihre Produktionsumgebung hochstufen, indem Sie sie aus Ihrem Staging-Projekt herunterladen und in Ihrem Produktionsprojekt veröffentlichen.

Sie können diese Methode auch verwenden, um Konfigurationen von einem Projekt zu einem anderen zu migrieren oder ein neues Projekt mit Parametern und Werten aus einem bestehenden Projekt zu füllen.

Parameter und Parameterwerte, die speziell als Varianten in einem A/B-Testing-Experiment erstellt wurden, sind nicht in exportierten Vorlagen enthalten.

So exportieren und importieren Sie Remote Config-Vorlagen:

  1. Laden Sie die aktuelle Remote Config Config-Vorlage herunter .
  2. Validieren Sie die Remote Config-Vorlage .
  3. Veröffentlichen Sie die Remote Config-Vorlage .

Laden Sie die aktuelle Remote-Konfigurationsvorlage herunter

Sie können die aktuelle und aktive Remote-Konfigurationsvorlage programmgesteuert oder über die Firebase-Konsole herunterladen.

Verwenden Sie die folgenden Befehle, um die aktive Remote Config-Vorlage im JSON-Format herunterzuladen:

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

Java

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

SICH AUSRUHEN

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

Dieser Befehl gibt die JSON-Nutzlast in eine Datei und die Header (einschließlich ETag) in eine separate headers -Datei aus.

Firebase-Konsole

  1. Öffnen Sie auf der Registerkarte Remote-Konfigurationsparameter oder -bedingungen das Menü und wählen Sie Aktuelle Konfigurationsdatei herunterladen aus.
  2. Wenn Sie dazu aufgefordert werden, klicken Sie auf Konfigurationsdatei herunterladen , wählen Sie den Speicherort aus, an dem Sie die Datei speichern möchten, und klicken Sie dann auf Speichern .

Firebase-CLI

firebase remoteconfig:get -o filename

Validieren Sie die Remote Config-Vorlage

Sie können Ihre Vorlagenaktualisierungen validieren, bevor Sie sie mit dem Firebase Admin SDK oder der REST-API veröffentlichen. Vorlagen werden auch validiert, wenn Sie versuchen, sie über die Firebase-Befehlszeilenschnittstelle oder die Firebase-Konsole zu veröffentlichen.

Der Vorlagenvalidierungsprozess prüft auf Fehler wie doppelte Schlüssel für Parameter und Bedingungen, ungültige Bedingungsnamen oder nicht vorhandene Bedingungen oder falsch formatierte ETags. Beispielsweise würde eine Anfrage mit mehr als der zulässigen Anzahl von Schlüsseln – 2000 – die Fehlermeldung „ Param count too large “ zurückgeben.

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

Java

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

SICH AUSRUHEN

Validieren Sie Vorlagenaktualisierungen, indem Sie den URL-Parameter ?validate_only=true an Ihre Veröffentlichungsanfrage anhängen:

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

Wenn Ihre Vorlage erfolgreich validiert wurde, gibt der Curl-Befehl die von Ihnen übermittelte JSON-Vorlage zurück, und in der gespeicherten headers -Datei finden Sie einen HTTP/2-Status 200 und ein aktualisiertes ETag mit dem Suffix -0 . Wenn Ihre Vorlage nicht validiert wurde, erhalten Sie den Validierungsfehler in der JSON-Antwort und Ihre headers -Datei enthält eine Nicht-200-Antwort (und kein ETag).

Veröffentlichen Sie die Remote Config-Vorlage

Nachdem Sie eine Vorlage heruntergeladen, alle erforderlichen Änderungen am JSON-Inhalt vorgenommen und ihn validiert haben, können Sie ihn in einem Projekt veröffentlichen.

Beim Veröffentlichen einer Vorlage wird die gesamte vorhandene Konfigurationsvorlage durch die aktualisierte Datei ersetzt und die Vorlagenversion um eins erhöht. Da die gesamte Konfiguration ersetzt wird, wird der Parameter vom Server gelöscht und steht Clients nicht mehr zur Verfügung, wenn Sie einen Parameter aus der JSON-Datei löschen und veröffentlichen.

Nach der Veröffentlichung stehen Änderungen an Parametern und Werten Ihren Apps und Benutzern sofort zur Verfügung. Bei Bedarf können Sie zu einer früheren Version zurückkehren .

Verwenden Sie die folgenden Befehle, um Ihre Vorlage zu veröffentlichen:

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

Java

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

SICH AUSRUHEN

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

Für diesen curl Befehl können Sie den Inhalt angeben, indem Sie das Zeichen „@“ gefolgt vom Dateinamen verwenden.

Firebase-Konsole

  1. Öffnen Sie auf der Registerkarte Remote-Konfigurationsparameter oder -bedingungen das Menü und wählen Sie Aus einer Datei veröffentlichen aus .
  2. Wenn Sie dazu aufgefordert werden, klicken Sie auf Durchsuchen , navigieren Sie zu der Remote-Konfigurationsdatei, die Sie veröffentlichen möchten, wählen Sie sie aus und klicken Sie dann auf Auswählen .
  3. Die Datei wird validiert und Sie können bei Erfolg auf Veröffentlichen klicken, um die Konfiguration Ihren Apps und Benutzern sofort zur Verfügung zu stellen.

Remote Config-Personalisierungen und -Bedingungen sind in heruntergeladenen Vorlagen enthalten, daher ist es wichtig, die folgenden Einschränkungen zu beachten, wenn Sie versuchen, in einem anderen Projekt zu veröffentlichen:

  • Personalisierungen können nicht von Projekt zu Projekt importiert werden.

    Wenn Sie beispielsweise Personalisierungen in Ihrem Projekt aktiviert haben und eine Vorlage herunterladen und bearbeiten, können Sie sie in demselben Projekt veröffentlichen, aber Sie können sie nicht in einem anderen Projekt veröffentlichen, es sei denn, Sie löschen die Personalisierungen aus der Vorlage.

  • Bedingungen können von Projekt zu Projekt importiert werden, aber beachten Sie, dass alle spezifischen Bedingungswerte (wie App-IDs oder Zielgruppen) vor der Veröffentlichung im Zielprojekt vorhanden sein sollten.

    Wenn Sie beispielsweise einen Remote Config-Parameter haben, der eine Bedingung verwendet, die einen Plattformwert von iOS angibt, kann die Vorlage in einem anderen Projekt veröffentlicht werden, da die Plattformwerte für alle Projekte gleich sind. Wenn es jedoch eine Bedingung enthält, die auf einer bestimmten App-ID oder Benutzerzielgruppe basiert, die im Zielprojekt nicht vorhanden ist, schlägt die Validierung fehl.

  • Wenn die Vorlage, die Sie veröffentlichen möchten, Bedingungen enthält, die auf Google Analytics basieren, muss Analytics im Zielprojekt aktiviert sein.

Laden Sie die Standardeinstellungen der Remote Config-Vorlage herunter

Da Ihre App möglicherweise nicht immer mit dem Internet verbunden ist, sollten Sie clientseitige App-Standardwerte für alle Remote Config-Parameter konfigurieren. Sie sollten auch die Standardwerte Ihres App-Clients und die Standardparameterwerte des Remote Config-Backends regelmäßig synchronisieren, da sie sich im Laufe der Zeit ändern können.

Wie in den plattformspezifischen Links am Ende dieses Abschnitts beschrieben, können Sie diese Standardwerte manuell in Ihrer App festlegen oder diesen Prozess rationalisieren, indem Sie Dateien herunterladen, die nur die Schlüssel-Wert-Paare für alle Parameter und ihre Standardwerte in der aktive Remote Config-Vorlage. Sie können diese Datei dann in Ihr Projekt einschließen und Ihre App so konfigurieren, dass diese Werte importiert werden.

Sie können diese Dateien im XML-Format für Android-Apps, im Eigenschaftslistenformat (plist) für iOS-Apps und im JSON-Format für Web-Apps herunterladen.

Wir empfehlen, vor jeder neuen App-Version regelmäßig Remote Config-Standardeinstellungen herunterzuladen, um sicherzustellen, dass Ihre App und das Remote Config-Back-End synchron bleiben.

So laden Sie eine Datei herunter, die Vorlagenvorgaben enthält:

SICH AUSRUHEN

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

Verwenden Sie XML , PLIST oder JSON als format , je nachdem, welches Dateiformat Sie herunterladen möchten.

Firebase-Konsole

  1. Öffnen Sie auf der Registerkarte Parameter das Menü und wählen Sie Standardwerte herunterladen aus .
  2. Wenn Sie dazu aufgefordert werden, klicken Sie auf das Optionsfeld, das dem Dateiformat entspricht, das Sie herunterladen möchten, und klicken Sie dann auf Datei herunterladen .

Weitere Informationen zum Importieren von Remote Config-Standardwerten in Ihre App finden Sie unter: