Remote Config-Vorlagen und -Versionierung

Remote Config Vorlagen sind Gruppen von Parametern und Bedingungen im JSON-Format , die Sie für Ihr Firebase-Projekt erstellt haben. Sie können Clientvorlagen erstellen, aus denen Ihre App Werte abruft, und Servervorlagen, aus denen Serverclients Werte abrufen können.

Sie können die Vorlage in der Firebase Console ändern und verwalten. Dort wird der Inhalt der Vorlage auf den Die Tabs „Parameter“ und „Bedingungen“.

Sie können Ihre Clientvorlage auch mit der REST API und dem Admin SDK oder der Firebase CLI ändern und verwalten.Remote Config

Hier sehen Sie ein Beispiel für eine Servervorlagendatei:

{
  "parameters": {
    "preamble_prompt": {
      "defaultValue": {
        "value": "You are a helpful assistant who knows everything there is to know about Firebase! "
      },
      "description": "Add this prompt to the user's prompt",
      "valueType": "STRING"
    },
    "model_name": {
      "defaultValue": {
        "value": "gemini-pro-test"
      },
      "valueType": "STRING"
    },
    "generation_config": {
      "defaultValue": {
        "value": "{\"temperature\": 0.9, \"maxOutputTokens\": 2048, \"topP\": 0.9, \"topK\": 20}"
      },
      "valueType": "JSON"
    },
  },
  "version": {
    "versionNumber": "19",
    "isLegacy": true
  }
}

Mit der Firebase Console können Sie die folgenden Aufgaben zur Versionsverwaltung ausführen:

• Alle gespeicherten Vorlagenversionen auflisten
• Eine bestimmte Version abrufen
• Rollback zu einer bestimmten Clientversion durchführen
• Remote Config Vorlagen auf der Seite „Änderungsverlauf“ löschen

Es gilt ein Limit von insgesamt 300 gespeicherten Versionen pro Vorlagentyp (300 Clientvorlagen und 300 Servervorlagen), einschließlich der gespeicherten Versionsnummern für gelöschte Vorlagen. Wenn Sie während der Lebensdauer eines Projekts mehr als 300 Vorlagenversionen pro Vorlagentyp veröffentlichen, werden die ältesten Versionen gelöscht, sodass maximal 300 Versionen dieses Typs vorhanden sind.

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 bei Bedarf abrufen oder auf die Sie ein Rollback durchführen können. Die Versionsnummern werden sequenziell ab dem von Remote Config gespeicherten Anfangswert erhöht. Alle Vorlagen enthalten das Feld version mit Metadaten zu dieser bestimmten Version.

Sie können Remote Config Vorlagen bei Bedarf auf der Änderungsverlauf auf der Remote Config Konsole löschen.

Vorlagenversionen verwaltenRemote Config

In diesem Abschnitt wird beschrieben, wie Sie Versionen Ihrer Remote Config Vorlage verwalten.

Alle gespeicherten Versionen der Remote Config Vorlage auflisten

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

firebase remoteconfig:versions:list

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

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

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

Die Liste der Vorlagen enthält Metadaten für alle gespeicherten Versionen, einschließlich des Zeitpunkts der Aktualisierung, des Nutzers, der sie vorgenommen hat, und der Art der Aktualisierung. Hier sehen Sie ein Beispiel für ein Versionselement:

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

Eine bestimmte Version der Remote Config Vorlage abrufen

Sie können jede gespeicherte Version der Remote Config Vorlage abrufen. So rufen Sie eine gespeicherte Vorlagenversion ab:

firebase remoteconfig:get -v VERSION_NUMBER

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

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

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

Rollback zu einer bestimmten gespeicherten Version der Remote Config Vorlage durchführen

Sie können ein Rollback zu jeder gespeicherten Version der Vorlage durchführen. So führen Sie ein Rollback für eine Vorlage durch:

firebase remoteconfig:rollback -v VERSION_NUMBER

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

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

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

Bei diesem Rollback-Vorgang wird effektiv eine neue nummerierte Version erstellt. Wenn Sie beispielsweise ein Rollback von Version 10 zu Version 6 durchführen, wird eine neue Kopie von Version 6 erstellt, die sich vom Original nur dadurch unterscheidet, dass ihre Versionsnummer 11 ist. Die ursprüngliche Version 6 ist weiterhin gespeichert, sofern sie nicht abgelaufen ist, und Version 11 wird zur aktiven Vorlage.

Vorlage löschenRemote Config

Sie können Remote Config Vorlagen in der Firebase Console löschen. So löschen Sie eine Remote Config Vorlage:

1. Wechseln Sie zu der Vorlage, die Sie löschen möchten, klicken Sie auf more_vertMehr und wählen Sie Löschen aus.

2. Wenn Sie aufgefordert werden, das Löschen zu bestätigen, klicken Sie auf Löschen.

Remote Config-Vorlagen herunterladen und veröffentlichen

Sie können Remote Config Vorlagen herunterladen und veröffentlichen, um sie in Ihre Quellcodeverwaltung und Ihre Build-Systeme zu integrieren, Konfigurationsaktualisierungen zu automatisieren und Parameter und Werte in mehreren Projekten zu synchronisieren.

Sie können die aktuell aktive Remote Config Vorlage in der Firebase Console herunterladen. Anschließend können Sie die exportierte JSON-Datei aktualisieren und im selben Projekt oder in einem neuen oder vorhandenen Projekt veröffentlichen.

Angenommen, Sie haben mehrere Projekte, die verschiedene Phasen des Softwareentwicklungszyklus darstellen, z. B. Entwicklungs-, Test-, Staging- und Produktionsumgebungen. In diesem Fall können Sie eine vollständig getestete Vorlage aus Ihrer Staging-Umgebung in Ihre Produktionsumgebung übertragen, 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 in ein anderes 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 Konfigurationsvorlage herunter.
2. Validieren Sie die Remote Config Vorlage.
3. Veröffentlichen Sie die Remote Config Vorlage.

Aktuelle Remote Config-Vorlage herunterladen

Verwenden Sie Folgendes, um die aktive Remote Config Vorlage in JSON-Format herunterzuladen:

firebase remoteconfig:get -o filename

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

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

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

Remote Config-Vorlage validieren

Bei der Vorlagenvalidierung wird nach Fehlern wie doppelten Schlüsseln für Parameter und Bedingungen, ungültigen oder nicht vorhandenen Bedingungsnamen oder falsch formatierten ETags gesucht. Wenn eine Anfrage beispielsweise mehr als die zulässige Anzahl von Schlüsseln (2.000) enthält, wird die Fehlermeldung Param count too large zurückgegeben.

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

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

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

Remote Config Vorlage veröffentlichen

Nachdem Sie eine Vorlage heruntergeladen, die erforderlichen Änderungen am JSON-Inhalt vorgenommen und sie validiert haben, können Sie sie 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 ist für Clients nicht mehr verfügbar, wenn Sie einen Parameter aus der JSON-Datei löschen und sie veröffentlichen.

Nach der Veröffentlichung sind Änderungen an Parametern und Werten sofort für Ihre Apps und Nutzer verfügbar. Bei Bedarf können Sie ein Rollback zu einer früheren Version durchführen.

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

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

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

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

Remote Config Personalisierungen und Bedingungen sind in heruntergeladenen Vorlagen enthalten. Daher müssen Sie die folgenden Einschränkungen beachten, wenn Sie versuchen, in einem anderen Projekt zu veröffentlichen:

• Personalisierungen können nicht von einem Projekt in ein anderes importiert werden.

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

• Bedingungen können von einem Projekt in ein anderes importiert werden. Alle spezifischen bedingten Werte (z. B. App-IDs oder Zielgruppen) müssen jedoch im Zielprojekt vorhanden sein, bevor Sie veröffentlichen.

  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 sie jedoch eine Bedingung enthält, die auf einer bestimmten App-ID oder Zielgruppe 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, Analytics basieren, muss im Ziel Projekt aktiviert sein.

Standardwerte für Vorlagen herunterladenRemote Config

Da Ihre App möglicherweise nicht immer mit dem Internet verbunden ist, sollten Sie Standardwerte für alle Remote Config Parameter auf Clientseite konfigurieren. Außerdem sollten Sie die Standardwerte für Ihre App-Clients und die Standardparameterwerte für das Remote Config Backend 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. Sie können diesen Prozess aber auch optimieren, indem Sie Dateien herunterladen, die nur die Schlüssel-Wert-Paare für alle Parameter und ihre Standardwerte in der aktiven Remote Config Vorlage enthalten. Anschließend können Sie diese Datei in Ihr Projekt einfügen und Ihre App so konfigurieren, dass diese Werte importiert werden.

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

Wir empfehlen, die Remote Config Standardwerte vor jeder neuen App-Version herunterzuladen, um sicherzustellen, dass Ihre App und das Remote Config Backend synchron bleiben.

So laden Sie eine Datei mit Vorlagenstandardwerten herunter:

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

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

• Standardparameterwerte in der App für Android festlegen

• Standardparameterwerte in der App für iOS festlegen

• Standardparameterwerte in der App für das Web festlegen

• Standardparameterwerte in der App für Unity festlegen

• Standardparameterwerte in der App für C++ festlegen