Szablony Zdalnej konfiguracji i obsługa wersji


Remote Config szablony to zbiory parametrów i warunków w formacie JSON, które zostały utworzone na potrzeby projektu w Firebase. Możesz tworzyć szablony klientów, z których aplikacja pobiera wartości, oraz szablony serwerów, z których wartości mogą pobierać klienci serwerów.

W tej sekcji omawiamy szablony serwerów. Aby dowiedzieć się więcej o szablonach specyficznych dla klientów, kliknij Szablony klientów.

Szablon możesz modyfikować i zarządzać nim w konsoli Firebase, która wyświetla jego zawartość w formacie graficznym na kartach Parametry i Warunki.

Oto przykład pliku szablonu serwera:

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

W konsoli Firebase możesz wykonywać te zadania związane z zarządzaniem wersjami:

  • Wyświetlanie listy wszystkich zapisanych wersji szablonu
  • Pobieranie konkretnej wersji
  • Wycofaj zmiany do konkretnej wersji klienta
  • Usuwanie szablonów Remote Config ze strony Historia zmian

Łączny limit zapisanych wersji szablonu wynosi 300 (300 szablonów klientów i 300 szablonów serwerów), w tym numery wersji usuniętych szablonów. Jeśli w trakcie cyklu życia projektu opublikujesz więcej niż 300 wersji szablonu danego typu, najstarsze wersje zostaną usunięte, a maksymalna liczba wersji tego typu wyniesie 300.

Za każdym razem, gdy zaktualizujesz parametry, Remote Config utworzy nowy szablon Remote Config z obsługą wersji i zapisze poprzedni szablon jako wersję, którą w razie potrzeby możesz pobrać lub wycofać zmiany. Numery wersji są zwiększane kolejno od wartości początkowej zapisanej przez Remote Config. Wszystkie szablony zawierają pole version (jak pokazano poniżej) z metadanymi dotyczącymi konkretnej wersji.

Szablony Remote Config możesz w razie potrzeby usuwać na stronie Historia zmian w konsoli Remote Config.

Zarządzanie wersjami szablonu Remote Config

W tej sekcji opisujemy, jak zarządzać wersjami szablonu Remote Config.

Wyświetlanie listy wszystkich zapisanych wersji szablonu Remote Config

Możesz pobrać listę wszystkich zapisanych wersji szablonu Remote Config. W tym celu:

  1. W konsoli Firebase otwórz Remote Config.

  2. Następnie na karcie Parametry kliknij ikonę „zegara” w prawym górnym rogu.

    Otworzy się strona Historia zmian , na której po prawej stronie znajduje się menu z listą wszystkich zapisanych wersji szablonu.

    Lista szablonów zawiera metadane wszystkich zapisanych wersji, w tym godzinę aktualizacji, użytkownika, który ją wprowadził, i sposób jej wprowadzenia.

Pobieranie konkretnej wersji szablonu Remote Config

Możesz pobrać dowolną zapisaną wersję szablonu Remote Config. Aby pobrać zapisaną wersję szablonu:

  1. Otwórz okienko szczegółów Historia zmian.

  2. Aby wyświetlić szczegóły innej wersji na liście, wybierz ją w menu po prawej stronie.

  3. Aby wyświetlić szczegółowe porównanie aktywnego szablonu z dowolną inną zapisaną wersją, najedź kursorem na menu kontekstowe dowolnej niewybranej wersji i kliknij Porównaj z wybraną wersją.

Wycofaj zmiany do konkretnej zapisanej wersji szablonu Remote Config

Możesz wycofać zmiany do dowolnej zapisanej wersji szablonu. Aby wycofać zmiany w szablonie:

  1. W prawym górnym rogu strony Historia zmian znajdź przycisk opcji. Kliknij i potwierdź tylko wtedy, gdy masz pewność, że chcesz wycofać zmiany do tej wersji i natychmiast użyć tych wartości we wszystkich aplikacjach i dla wszystkich użytkowników.

Pamiętaj, że ta operacja przywracania powoduje utworzenie nowej wersji z numerem. Na przykład przywrócenie wersji 10 do wersji 6 spowoduje utworzenie nowej kopii wersji 6, która różni się od oryginału tylko numerem wersji (11). Oryginalna wersja 6 jest nadal przechowywana (o ile nie upłynął jej termin ważności), a wersja 11 staje się aktywnym szablonem.

Usuwanie szablonu Remote Config

Szablony Remote Config możesz usuwać w konsoli Firebase. Aby usunąć szablon:Remote Config

1. Na stronie Remote Config Parametry kliknij Historia zmian.

  1. Przełącz się na szablon, który chcesz usunąć, kliknij Więcej, a następnie wybierz Usuń.

  2. Gdy pojawi się prośba o potwierdzenie usunięcia, kliknij Usuń.

Pobieranie i publikowanie szablonów Remote Config

Pobieraj i publikuj szablony Remote Config, aby zintegrować je z systemami kontroli kodu źródłowego i kompilacji, zautomatyzować aktualizacje konfiguracji oraz synchronizować parametry i wartości w wielu projektach.

Aktywny szablon Remote Config możesz pobrać w konsoli Firebase. Następnie możesz zaktualizować wyeksportowany plik JSON i opublikować go w tym samym projekcie lub w nowym bądź istniejącym projekcie.

Załóżmy, że masz kilka projektów, które reprezentują różne etapy cyklu życia oprogramowania, takie jak środowiska deweloperskie, testowe, przejściowe i produkcyjne. W takim przypadku możesz przenieść w pełni przetestowany szablon ze środowiska przejściowego do środowiska produkcyjnego, pobierając go z projektu przejściowego i publikując w projekcie produkcyjnym.

Możesz też użyć tej metody do przenoszenia konfiguracji z jednego projektu do drugiego lub do wypełniania nowego projektu parametrami i wartościami z projektu już istniejącego.

Parametry i wartości parametrów utworzone specjalnie jako warianty w eksperymencie A/B Testing nie są uwzględniane w eksportowanych szablonach.

Aby wyeksportować i zaimportować szablony Remote Config:

  1. Pobierz bieżący szablon konfiguracji Remote Config.
  2. Sprawdź poprawność szablonu Remote Config.
  3. Opublikuj szablon Remote Config.

Pobieranie bieżącego szablonu Zdalnej konfiguracji

Aby pobrać aktywny szablon Remote Config w formacie JSON:

  1. Na karcie Remote Config Parametry lub Warunki otwórz Menu i kliknij Pobierz bieżący plik konfiguracji.
  2. Gdy pojawi się prośba, kliknij Pobierz plik konfiguracji, wybierz lokalizację, w której chcesz zapisać plik, a następnie kliknij Zapisz.

Sprawdzanie poprawności szablonu Zdalnej konfiguracji

Szablony serwerów są weryfikowane, gdy próbujesz opublikować je w Firebase konsoli. Pamiętaj, że warunki User in Random Percentage (Użytkownik w losowym procencie) można importować, ale każdy nieobsługiwany warunek spowoduje błąd podczas przesyłania. Jeśli próbujesz opublikować szablon, który został pierwotnie wyeksportowany z szablonu klienta, najpierw usuń wszystkie warunki specyficzne dla klienta.

Publikowanie szablonu Remote Config

Po pobraniu szablonu, wprowadzeniu niezbędnych zmian w treści JSON i sprawdzeniu jego poprawności możesz opublikować go w projekcie.

Opublikowanie szablonu powoduje zastąpienie całego dotychczasowego szablonu konfiguracji zaktualizowanym plikiem i zwiększenie numeru wersji szablonu o 1. Ponieważ zastępowana jest cała konfiguracja, jeśli usuniesz parametr z pliku JSON i opublikujesz go, parametr zostanie usunięty z serwera i nie będzie już dostępny dla klientów.

Po opublikowaniu zmiany parametrów i wartości są natychmiast dostępne dla aplikacji i użytkowników. W razie potrzeby możesz wycofać zmiany do poprzedniej wersji.

Aby opublikować szablon, użyj tych poleceń:

  1. Na karcie Remote Config Parametry lub Warunki otwórz Menu, i kliknij Opublikuj z pliku.
  2. Gdy pojawi się prośba, kliknij Przeglądaj, znajdź i wybierz plik Remote Config, który chcesz opublikować, a następnie kliknij Wybierz.
  3. Plik zostanie zweryfikowany. Jeśli weryfikacja się powiedzie, możesz kliknąć Opublikuj, aby konfiguracja była natychmiast dostępna dla aplikacji i użytkowników.

Dalsze kroki