Remote Config-Vorlagen und -Versionierung


Remote Config-Vorlagen sind JSON-formatierte Parameter und Bedingungen, die Sie für Ihr Firebase-Projekt erstellt haben. Sie können Clientvorlagen erstellen, aus denen Ihre App Werte abrufen kann, und Servervorlagen, aus denen Server-Clients Werte abrufen können.

In diesem Abschnitt werden Servervorlagen behandelt. Informationen zu clientspezifischen Vorlagen finden Sie unter Clientvorlagen.

Sie ändern und verwalten die Vorlage über die Firebase-Konsole, in der der Inhalt der Vorlage auf den Tabs Parameter und Bedingungen in grafischem Format angezeigt wird.

Hier sehen Sie ein Beispiel für eine Server-Vorlagedatei:

{
  "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-Konsole können Sie die folgenden Aufgaben zur Versionsverwaltung ausführen:

  • Alle gespeicherten Vorlagenversionen auflisten
  • Bestimmte Version abrufen
  • Rollback auf eine bestimmte Clientversion durchführen
  • Remote Config Vorlagen auf der Seite Änderungsverlauf löschen

Pro Vorlagentyp (300 Clientvorlagen und 300 Servervorlagen) können insgesamt 300 Versionen gespeichert werden. Dazu gehören auch die 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 Version, die Sie bei Bedarf abrufen oder auf die Sie zurücksetzen können. Die Versionsnummern werden fortlaufend vom von Remote Config gespeicherten Anfangswert erhöht. Alle Vorlagen enthalten ein version-Feld, das Metadaten zu dieser bestimmten Version enthält.

Sie können Remote Config-Vorlagen bei Bedarf über die Seite Änderungsverlauf in der Remote Config-Konsole löschen.

Remote Config-Vorlagenversionen verwalten

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

Alle gespeicherten Versionen der Vorlage Remote Config auflisten

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

  1. Öffne in der Firebase-Konsole Remote Config.

  2. Wählen Sie dann auf dem Tab Parameter oben rechts das Uhrensymbol aus.

    Daraufhin wird die Seite Änderungsverlauf geöffnet. Rechts in einem Listenmenü werden alle gespeicherten Vorlagenversionen aufgelistet.

    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 und Weise, wie sie vorgenommen wurde.

Eine bestimmte Version der Vorlage Remote Config abrufen

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

  1. Öffnen Sie den Detailbereich des Änderungsverlaufs.

  2. Wenn Sie sich Details zu einer anderen Version in der Liste ansehen möchten, wählen Sie sie im Menü rechts aus.

  3. Wenn Sie eine detaillierte Differenz zwischen der aktiven Vorlage und einer anderen gespeicherten Version aufrufen möchten, bewegen Sie den Mauszeiger auf das Kontextmenü einer nicht ausgewählten Version und wählen Sie Mit ausgewählter Version vergleichen aus.

Rollback auf eine bestimmte gespeicherte Version der Remote Config-Vorlage

Sie können zu einer beliebigen gespeicherten Version der Vorlage zurückkehren. So führen Sie ein Rollback für eine Vorlage durch:

  1. Suchen Sie rechts oben auf der Seite Änderungsverlauf nach der Optionsschaltfläche. Klicken Sie nur dann darauf und bestätigen Sie die Aktion, wenn Sie sicher sind, dass Sie zu dieser Version zurückkehren und die Werte sofort für alle Apps und Nutzer verwenden möchten.

Hinweis: Durch diesen Rollback-Vorgang wird effektiv eine neue nummerierte Version erstellt. Wenn Sie beispielsweise von Version 10 auf Version 6 zurückgehen, wird effektiv eine neue Kopie von Version 6 erstellt, die sich nur durch die Versionsnummer 11 vom Original unterscheidet. Die ursprüngliche Version 6 wird weiterhin gespeichert, sofern ihr Ablaufdatum noch nicht erreicht wurde. Version 11 wird zur aktiven Vorlage.

Remote Config-Vorlage löschen

Sie können Remote Config-Vorlagen über die Firebase-Konsole löschen. So löschen Sie eine Remote Config-Vorlage:

1. Klicken Sie auf der Seite Remote Config Parameter auf Änderungsverlauf.

  1. Wechseln Sie zur Vorlage, die Sie löschen möchten, klicken Sie auf das Dreipunkt-Menü Mehr und wählen Sie Löschen aus.

  2. Wenn Sie dazu aufgefordert werden, den Löschvorgang 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 Quellkontroll- und Build-Systeme einzubinden, Konfigurationsupdates zu automatisieren und Parameter und Werte in mehreren Projekten synchron zu halten.

Sie können die derzeit aktive Remote Config-Vorlageüber die Firebase-Konsole herunterladen. Sie können die exportierte JSON-Datei dann aktualisieren und in dasselbe Projekt oder in ein neues oder vorhandenes Projekt veröffentlichen.

Angenommen, Sie haben mehrere Projekte, die verschiedene Phasen des Softwareentwicklungszyklus repräsentieren, 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 übernehmen, indem Sie sie aus Ihrem Staging-Projekt herunterladen und in Ihrem Produktionsprojekt veröffentlichen.

Mit dieser Methode können Sie auch Konfigurationen von einem Projekt in ein anderes migrieren oder ein neues Projekt mit Parametern und Werten aus einem bestehenden Projekt füllen.

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

So exportieren und importieren Sie Remote Config-Vorlagen:

  1. Lade 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

So laden Sie die aktive Remote Config-Vorlage im JSON-Format herunter:

  1. Öffnen Sie auf dem Tab Remote Config Parameter oder Bedingungen das Dreipunkt-Menü und wählen Sie Aktuelle Konfigurationsdatei herunterladen aus.
  2. Klicken Sie auf die Aufforderung hin auf Konfigurationsdatei herunterladen, wählen Sie den Speicherort für die Datei aus und klicken Sie dann auf Speichern.

Remote Config-Vorlage validieren

Servervorlagen werden geprüft, wenn Sie versuchen, über die Firebase-Konsole zu veröffentlichen. Bedingungen vom Typ „Nutzer in zufälligem Prozentwert“ können importiert werden. Nicht unterstützte Bedingungen führen jedoch beim Hochladen zu einem Fehler. Wenn Sie versuchen, eine Vorlage zu veröffentlichen, die ursprünglich aus einer Kundenvorlage exportiert wurde, entfernen Sie zuerst alle clientspezifischen Bedingungen.

Remote Config-Vorlage veröffentlichen

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

Wenn Sie eine Vorlage veröffentlichen, wird die gesamte vorhandene Konfigurationsvorlage durch die aktualisierte Datei ersetzt und die Vorlagenversion wird um eins erhöht. Da die gesamte Konfiguration ersetzt wird, wird der Parameter gelöscht, wenn Sie ihn aus der JSON-Datei löschen und veröffentlichen. Er ist dann nicht mehr auf dem Server verfügbar und kann von den Clients nicht mehr verwendet werden.

Nach der Veröffentlichung sind Änderungen an Parametern und Werten sofort für Ihre Apps und Nutzer verfügbar. Bei Bedarf können Sie auf eine vorherige Version zurücksetzen.

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

  1. Öffnen Sie auf dem Tab Remote Config Parameter oder Bedingungen das Dreipunkt-Menü und wählen Sie Aus einer Datei veröffentlichen aus.
  2. Klicken Sie auf Durchsuchen, suchen Sie die Datei Remote Config, die Sie veröffentlichen möchten, und klicken Sie auf Auswählen.
  3. Die Datei wird validiert. Wenn die Validierung erfolgreich war, können Sie auf Veröffentlichen klicken, um die Konfiguration sofort für Ihre Apps und Nutzer verfügbar zu machen.

Nächste Schritte