Szablony Zdalnej konfiguracji i obsługa wersji


Remote Config to zbiory parametrów i warunków w formacie JSON utworzone przez Ciebie na potrzeby projektu Firebase. Możesz tworzyć szablony klienta, z których aplikacja pobiera wartości, oraz szablony serwera, z których klienci serwera mogą pobierać wartości.

Ta sekcja dotyczy szablonów serwera. Aby dowiedzieć się więcej o szablonach klientów, kliknij Szablony klientów.

Szablon możesz modyfikować i nim zarządzać za pomocą konsoli Firebase, która wyświetla zawartość szablonu 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
  }
}

Te czynności związane z zarządzaniem wersjami możesz wykonywać w konsoli Firebase:

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

Istnieje łączny limit 300 przechowywanych wersji na typ szablonu (300 szablonów klienta i 300 szablonów serwera), który obejmuje przechowywane numery wersji usuniętych szablonów. Jeśli w trakcie trwania 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 aktualizujesz parametry, Remote Config tworzy nowy szablon z wersją Remote Config i zapisuje poprzedni szablon jako wersję, którą możesz w razie potrzeby przywrócić. Numery wersji są zwiększane kolejno od wartości początkowej przechowywanej przez Remote Config. Wszystkie szablony zawierają pole version, jak pokazano, z metadanymi dotyczącymi tej konkretnej wersji.

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

Zarządzanie wersjami szablonu Remote Config

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

Wyświetlanie listy wszystkich zapisanych wersji szablonu Remote Config

Możesz pobrać listę wszystkich zapisanych wersji szablonu Remote Config. Aby to zrobić:

  1. Na 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 znajdziesz menu z listą wszystkich zapisanych wersji szablonu.

    Lista szablonów zawiera metadane wszystkich zapisanych wersji, w tym czas aktualizacji, użytkownika, który ją wprowadził, oraz sposób wprowadzenia zmiany.

Pobieranie konkretnej wersji szablonu Remote Config

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

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

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

  3. Wyświetl szczegółowe porównanie aktywnego szablonu z dowolną inną zapisaną wersją, najeżdżając kursorem na menu kontekstowe dowolnej niewybranej wersji i klikając Porównaj z wybraną wersją.

Cofnij do określonej zapisanej wersji szablonu Remote Config

Możesz przywrócić dowolną zapisaną wersję szablonu. Aby przywrócić szablon:

  1. W prawym górnym rogu strony Historia zmian znajdź przycisk opcji. Kliknij i potwierdź tylko wtedy, gdy masz pewność, że chcesz przywrócić tę wersję i natychmiast używać tych wartości we wszystkich aplikacjach i w przypadku wszystkich użytkowników.

Pamiętaj, że ta operacja wycofania powoduje utworzenie nowej wersji numerowanej. Na przykład przywrócenie wersji 10 do wersji 6 powoduje 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 okres ważności), a wersja 11 staje się aktywnym szablonem.

Usuwanie szablonu Remote Config

Szablony Remote Config możesz usunąć z Firebase konsoli. 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

Pobierz i opublikuj szablony Remote Config, aby zintegrować je z systemami kontroli wersji i kompilacji, zautomatyzować aktualizacje konfiguracji oraz synchronizować parametry i wartości w wielu projektach.

Obecnie aktywny Remote Configszablonz Firebasekonsoli. 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, np. środowiska programistyczne, testowe, przejściowe i produkcyjne. W takim przypadku możesz promować w środowisku produkcyjnym w pełni przetestowany szablon ze środowiska testowego, pobierając go z projektu testowego i publikując w projekcie produkcyjnym.

Możesz też użyć tej metody, aby przenieść konfiguracje z jednego projektu do drugiego lub wypełnić nowy projekt parametrami i wartościami z istniejącego projektu.

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

Aby wyeksportować i zaimportować szablony Remote Config:

  1. Pobierz bieżący Remote Config szablon konfiguracji.
  2. Sprawdź Remote Configszablon.
  3. Opublikuj Remote Configszablon.

Pobieranie bieżącego szablonu Zdalnej konfiguracji

Aby pobrać aktywny szablon Remote Config w formacie JSON, wykonaj te czynności:

  1. Na karcie Remote Config Parametry lub warunki otwórz Menu i wybierz Pobierz bieżący plik konfiguracji.
  2. Gdy pojawi się odpowiedni komunikat, kliknij Pobierz plik konfiguracyjny, wybierz miejsce, w którym chcesz zapisać plik, a następnie kliknij Zapisz.

Weryfikowanie szablonu Zdalnej konfiguracji

Szablony serwera są weryfikowane, gdy próbujesz opublikować je z Firebasekonsoli. Pamiętaj, że warunki „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 poprawności możesz opublikować go w projekcie.

Opublikowanie szablonu powoduje zastąpienie całego istniejącego szablonu konfiguracji zaktualizowanym plikiem i zwiększenie numeru wersji szablonu o 1. Ponieważ cała konfiguracja jest zastępowana, 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 przywrócić poprzednią wersję.

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 zobaczysz komunikat, kliknij Przeglądaj, przejdź do plikuRemote Config, który chcesz opublikować, i wybierz go, a potem kliknij Wybierz.
  3. Plik zostanie zweryfikowany. Jeśli weryfikacja zakończy się powodzeniem, możesz kliknąć Opublikuj, aby konfiguracja była od razu dostępna dla Twoich aplikacji i użytkowników.

Dalsze kroki