Szablony Zdalnej konfiguracji i obsługa wersji


Remote Config szablony to zestawy parametrów i warunków w formacie JSON utworzonych w Twoim projekcie 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.

W tej sekcji omówiono szablony serwera. Aby dowiedzieć się więcej o szablonach dla klientów, kliknij Szablony dla 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
  }
}

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

  • Wyświetlanie listy wszystkich zapisanych wersji szablonu
  • Pobieranie konkretnej wersji
  • Przywracanie do konkretnej wersji klienta
  • Usuń Remote Config szablonów ze strony Historia zmian

Łączny limit liczby zapisanych wersji na typ szablonu (300 szablonów klienta i 300 szablonów serwera) wynosi 300 wersji, w tym wersji usuniętych szablonów. Jeśli w trakcie trwania projektu opublikujesz więcej niż 300 wersji szablonu na typ szablonu, najstarsze wersje zostaną usunięte, zachowując maksymalnie 300 wersji tego typu.

Za każdym razem, gdy aktualizujesz parametry, Remote Config tworzy nową wersję szablonu Remote Config i przechowuje poprzednią wersję szablonu jako wersję, do której możesz wrócić w razie potrzeby. Numery wersji są zwiększane sekwencyjnie od wartości początkowej zapisanej przez parametr Remote Config. Wszystkie szablony zawierają pole version, które zawiera metadane dotyczące danej wersji.

W razie potrzeby możesz usuwać szablony Remote Config na stronie Historia zmian konsoli Remote Config.

Zarządzanie wersjami szablonu Remote Config

W tej sekcji opisaliśmy, 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. Aby to zrobić:

  1. W konsoli Firebase otwórz Remote Config.

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

    Spowoduje to otwarcie strony Historia zmian, na której w menu po prawej stronie znajdziesz wszystkie przechowywane wersje szablonu.

    Lista szablonów zawiera metadane wszystkich zapisanych wersji, w tym czas wprowadzenia aktualizacji, użytkownika, który ją wprowadził, oraz 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 panel szczegółów w sekcji Historia zmian.

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

  3. Aby wyświetlić szczegółowe informacje o różnicach między aktywnym szablonem a inną zapisaną wersją, najedź kursorem na menu kontekstowe dowolnej niewybranej wersji i wybierz Porównaj z wybraną wersją.

Przywróć określoną zapisaną wersję szablonu Remote Config

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

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

Pamiętaj, że ta operacja przywracania spowoduje 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 tym, że jej numer wersji to 11. Pierwotna wersja 6 jest nadal przechowywana, o ile nie minął jej okres 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. Przejdź do szablonu, 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 integrować je z systemami kontroli źródła i kompilacji, automatyzować aktualizacje konfiguracji oraz utrzymywać parametry i wartości w zsynchronizowanym stanie w wielu projektach.

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

Załóżmy, że masz wiele projektów, które reprezentują różne etapy cyklu życia rozwoju oprogramowania, takie jak środowisko programistyczne, testowe, przejściowe i produkcyjne. W takim przypadku możesz przenieść w środowisku produkcyjnym szablon, który został w pełni przetestowany w środowisku testowym. Aby to zrobić, pobierz go z projektu testowego i opublikuj w projekcie produkcyjnym.

Możesz też użyć tej metody do migracji konfiguracji z jednego projektu do innego lub do wypełnienia nowego projektu parametrami i wartościami z istniejącego projektu.

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

Aby eksportować i importować szablony Remote Config:

  1. Pobierz bieżący szablon konfiguracji Remote Config.
  2. Sprawdź szablon 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 wybierz Pobierz bieżący plik konfiguracji.
  2. Gdy pojawi się odpowiedni komunikat, kliknij Pobierz plik konfiguracji, wybierz lokalizację, w której chcesz zapisać plik, a następnie kliknij Zapisz.

Weryfikacja szablonu Zdalnej konfiguracji

Szablony serwera są weryfikowane, gdy próbujesz opublikować je w konsoli Firebase. Pamiętaj, że warunki Użytkownik w losowym odsetku można importować, ale każdy nieobsługiwany warunek spowoduje błąd podczas przesyłania. Jeśli próbujesz opublikować szablon wyeksportowany z szablonu klienta, najpierw usuń wszystkie warunki dotyczące tego klienta.

Publikowanie szablonu Remote Config

Po pobraniu szablonu, wprowadzeniu w nim niezbędnych zmian i sprawdzeniu go możesz opublikować go w projekcie.

Publikowanie szablonu powoduje zastąpienie całego dotychczasowego szablonu konfiguracji zaktualizowanym plikiem i zwiększenie wersji szablonu o 1. Ponieważ cała konfiguracja zostaje zastąpiona, 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 ConfigParametry lub Warunki kliknij Menu i wybierz Opublikuj z pliku.
  2. Gdy pojawi się odpowiedni komunikat, kliknij Przeglądaj, przejdź do pliku Remote Config, który chcesz opublikować, i 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