Remote Config-Vorlagen und -Versionierung


Remote Config-Vorlagen sind Gruppen von JSON-formatierten Parametern und Bedingungen, 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.

In diesem Abschnitt werden Servervorlagen behandelt. Wenn Sie mehr über clientspezifische Vorlagen erfahren möchten, klicken Sie auf Clientvorlagen.

Sie können die Vorlage in der Firebase-Konsole ändern und verwalten. Dort wird der Inhalt der Vorlage auf den Tabs Parameter und Bedingungen in grafischer Form dargestellt.

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

Sie können diese Aufgaben zur Versionsverwaltung mit der Firebase-Konsole ausführen:

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

Es gibt ein Gesamtlaufzeitlimit von 300 gespeicherten Versionen pro Vorlagentyp (300 Clientvorlagen und 300 Servervorlagen). Das Limit umfasst auch gespeicherte Versionsnummern für gelöschte Vorlagen. Wenn Sie im Laufe 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, wird in Remote Config eine neue versionierte Remote Config-Vorlage erstellt und die vorherige Vorlage als Version gespeichert, die Sie bei Bedarf abrufen oder auf die Sie ein Rollback durchführen können. Versionsnummern werden sequenziell ab dem von Remote Config gespeicherten Anfangswert erhöht. Alle Vorlagen enthalten das version-Feld, wie unten dargestellt, mit Metadaten zu dieser spezifischen Version.

Sie können Remote Config-Vorlagen bei Bedarf auf der Seite Änderungsverlauf 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. So funktionierts:

  1. Öffnen Sie Remote Config in der Firebase-Konsole.

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

    Dadurch wird die Seite Änderungsverlauf geöffnet. Dort werden alle gespeicherten Vorlagenversionen in einem Listenmenü auf der rechten Seite aufgeführt.

    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.

Eine bestimmte Version der Vorlage Remote Config abrufen

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

  1. Öffnen Sie den Detailbereich von Änderungsverlauf.

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

  3. Wenn Sie einen detaillierten Vergleich der aktiven Vorlage mit 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 zu einer bestimmten gespeicherten Version der Vorlage Remote Config durchführen

Sie können zu jeder gespeicherten Version der Vorlage zurückkehren. So machen Sie eine Vorlage rückgängig:

  1. Suchen Sie oben rechts auf der Seite Änderungsverlauf nach der Optionsschaltfläche. Klicken Sie nur dann auf „Bestätigen“, wenn Sie sicher sind, dass Sie ein Rollback auf diese Version durchführen und diese Werte sofort für alle Apps und Nutzer verwenden möchten.

Bei diesem Rollback-Vorgang wird eine neue nummerierte Version erstellt. Wenn Sie beispielsweise von Version 10 zu Version 6 zurückkehren, wird effektiv 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 noch nicht abgelaufen ist. 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 dann Löschen aus.

  2. Wenn Sie zur Bestätigung der Löschung aufgefordert werden, klicken Sie auf Löschen.

Remote Config-Vorlagen herunterladen und veröffentlichen

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

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

Angenommen, Sie haben mehrere Projekte, die verschiedene Phasen Ihres 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 übernehmen, 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-Test 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. Remote Config-Vorlage validieren
  3. Veröffentlichen Sie die Remote Config-Vorlage.

Aktuelle Remote Config-Vorlage herunterladen

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

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

Remote Config-Vorlage validieren

Servervorlagen werden validiert, wenn Sie versuchen, über die Firebase-Konsole zu veröffentlichen. Bedingungen vom Typ „Nutzer in zufälligem Prozentwert“ können importiert werden. Bei nicht unterstützten Bedingungen wird jedoch beim Hochladen ein Fehler ausgegeben. Wenn Sie versuchen, eine Vorlage zu veröffentlichen, die ursprünglich aus einer Clientvorlage exportiert wurde, müssen Sie zuerst alle clientspezifischen Bedingungen entfernen.

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 wird um eins erhöht. Da die gesamte Konfiguration ersetzt wird, wird ein Parameter, den Sie aus der JSON-Datei löschen und veröffentlichen, auch vom Server gelöscht und ist für Clients nicht mehr verfügbar.

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 auf eine frühere Version durchführen.

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

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

Nächste Schritte