Parametry i warunki Zdalnej konfiguracji w szablonach klienta

Możesz wyświetlać parametry i wartości Remote Config z szablonów klienta w dowolnych instancjach aplikacji, które implementują pakiety SDK klienta Firebase dla Remote Config, w tym w aplikacjach na platformy Apple, Android, Flutter, Unity i C++ oraz w aplikacjach internetowych.

Gdy używasz konsoli Firebase lub interfejsów API backendu Remote Config, definiujesz co najmniej 1 parametr (pary klucz-wartość) i podajesz domyślne wartości tych parametrów w aplikacji. Możesz zastąpić domyślne wartości w aplikacji, definiując wartości parametrów. Klucze i wartości parametrów są ciągami znaków, ale wartości parametrów można rzutować na inne typy danych, gdy używasz ich w aplikacji.

Za pomocą konsoli Firebase, Admin SDK lub interfejsu API REST Remote Config możesz tworzyć nowe wartości domyślne parametrów, a także wartości warunkowe, które są używane do kierowania na grupy instancji aplikacji. Za każdym razem, gdy aktualizujesz konfigurację w konsoli Firebase, Firebase tworzy i publikuje nową wersję szablonu Remote Config. Poprzednia wersja jest przechowywana, dzięki czemu możesz ją pobrać lub przywrócić w razie potrzeby. Te operacje są dostępne w konsoli Firebase, Firebase Admin SDK i interfejsie REST API. Są one opisane bardziej szczegółowo w artykule Zarządzanie wersjami szablonów Remote Config.

Z tego przewodnika dowiesz się, czym są parametry, warunki, reguły i wartości warunkowe oraz jak ustalane są priorytety różnych wartości parametrów w backendzie Remote Config i w aplikacji. Znajdziesz tu też szczegółowe informacje o typach reguł używanych do tworzenia warunków.

Warunki, reguły i wartości warunkowe

Warunek służy do kierowania na grupę instancji aplikacji. Warunki składają się z co najmniej 1 reguły, która musi mieć wartość true, aby warunek miał wartość true w przypadku danej instancji aplikacji. Jeśli wartość reguły jest niezdefiniowana (np. gdy nie jest dostępna żadna wartość), reguła zwraca wartość false.

Na przykład parametr, który definiuje ekran powitalny aplikacji, może wyświetlać różne obrazy w zależności od typu systemu operacyjnego, korzystając z reguły if device_os = Android:

Możesz też użyć warunku czasowego, aby kontrolować, kiedy aplikacja ma wyświetlać specjalne produkty promocyjne.

Parametr może mieć wiele wartości warunkowych, które używają różnych warunków, a parametry mogą współdzielić warunki w projekcie. W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Parametry, aby wyświetlić odsetek pobrań dla wartości warunkowych każdego parametru. Ten wskaźnik pokazuje odsetek żądań z ostatnich 24 godzin, które otrzymały każdą wartość.

Dodawanie, edytowanie i usuwanie warunków oraz zmienianie ich kolejności za pomocą konsoli Firebase

W konsoli Firebase możesz tworzyć, edytować, usuwać i zmieniać kolejność warunków kierowania. Warunki są współdzielone przez parametry w projekcie. Aby zarządzać warunkami:

1. W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Warunki (lub wybierz Zarządzaj warunkami na stronie Parametry).
2. Dodawanie warunku: kliknij Dodaj warunek (lub Utwórz pierwszy warunek), wpisz nazwę, która określa cel kierowania, i wybierz co najmniej 1 regułę kierowania.
3. Edytowanie warunku: kliknij nazwę warunku lub ikonę edycji, zmodyfikuj reguły i kliknij Zapisz.
4. Zmienianie priorytetu warunków: na stronie Warunki przeciągnij warunki za uchwyt, aby zmienić ich kolejność. Warunki znajdujące się wyżej na liście mają pierwszeństwo przed warunkami znajdującymi się niżej.
5. Usuwanie warunku: kliknij ikonę usuwania obok warunku, który chcesz usunąć. Jeśli warunek jest używany przez jakiś parametr, usunięcie go spowoduje też usunięcie powiązanych wartości warunkowych.

Po zapisaniu zmian w warunkach opublikuj szablon, klikając Opublikuj zmiany.

Ograniczenie IPv6 związane z kontrolą dostępu na podstawie adresów IP

Remote Config ma ograniczoną obsługę protokołu IPv6, gdy jest używany z zasadami dostępu opartymi na adresach IP. Jeśli Twoja organizacja ogranicza dostęp do określonych zakresów publicznych adresów IP, połączenie przez sieć IPv6 może powodować te problemy:

• Dostęp do konsoli: możesz nie mieć możliwości korzystania z niektórych funkcji Remote Config w konsoli Firebase, takich jak wczytywanie danych czy konfigurowanie kierowania.
• Dostęp klienta: aplikacje klienckie mogą napotkać błędy PERMISSION_DENIED.

Aby zapobiec tym problemom, skonfiguruj sieć tak, aby używała protokołu IPv4, lub dodaj wymagane zakresy adresów IP Firebase do listy dozwolonych w organizacji.

Priorytet wartości parametru

Z parametrem może być powiązanych kilka wartości warunkowych. Te reguły określają, która wartość jest pobierana z szablonu Remote Config i która jest używana w danej instancji aplikacji w określonym momencie:

1. Najpierw stosowane są wartości warunkowe dla wszystkich warunków, które w przypadku danego żądania klienta mają wartość true. Jeśli kilka warunków ma wartość true, pierwszeństwo ma warunek wyświetlany u góry w interfejsie konsoli Firebase, a wartości warunkowe powiązane z tym warunkiem są podawane, gdy aplikacja pobiera wartości z backendu. Priorytet warunków możesz zmienić, przeciągając je i upuszczając na stronie Warunki.

2. Jeśli nie ma wartości warunkowych, które spełniają warunki true, podczas pobierania wartości z backendu przez aplikację podawana jest domyślna wartość Remote Config. Jeśli parametr nie istnieje w backendzie lub jeśli wartość domyślna jest ustawiona na Użyj wartości domyślnej w aplikacji, podczas pobierania wartości przez aplikację nie jest podawana żadna wartość tego parametru.

W aplikacji wartości parametrów są zwracane przez metody get zgodnie z tą listą priorytetów

1. Jeśli wartość została pobrana z backendu, a następnie aktywowana, aplikacja używa pobranej wartości. Aktywowane wartości parametrów są trwałe.

2. Jeśli z backendu nie została pobrana żadna wartość lub jeśli wartości pobrane z backendu Remote Config nie zostały aktywowane, aplikacja używa wartości domyślnej.

   Więcej informacji o uzyskiwaniu i ustawianiu wartości domyślnych znajdziesz w artykule Pobieranie domyślnych wartości szablonu Remote Config.

3. Jeśli nie ustawiono domyślnej wartości w aplikacji, aplikacja używa wartości typu statycznego (np. 0 dla int i false dla boolean).

Ta grafika podsumowuje, jak ustalane są priorytety wartości parametrów w systemie zaplecza Remote Config i w aplikacji:

Typy danych wartości parametrów

Remote Config umożliwia wybranie typu danych dla każdego parametru i sprawdza wszystkie wartości Remote Config pod kątem tego typu przed aktualizacją szablonu. Typ danych jest przechowywany i zwracany w odpowiedzi na żądanie getRemoteConfig.

Obsługiwane typy danych:

• String
• Boolean
• Number
• JSON

W interfejsie konsoli Firebase typ danych można wybrać z menu obok klucza parametru. W interfejsie REST API typy można ustawiać za pomocą pola value_type w obiekcie parametru.

Grupy parametrów

Remote Config umożliwia grupowanie parametrów, co pozwala na lepsze uporządkowanie interfejsu i zwiększenie użyteczności.

Załóżmy na przykład, że podczas wdrażania nowej funkcji logowania musisz włączyć lub wyłączyć 3 różne typy uwierzytelniania. W Remote Config możesz utworzyć 3 parametry, aby włączyć odpowiednie typy, a następnie uporządkować je w grupie o nazwie „Nowe logowanie” bez konieczności dodawania prefiksów ani specjalnego sortowania.

Grupy parametrów możesz tworzyć za pomocą konsoli Firebase lub interfejsu API REST Remote Config. Każda utworzona grupa parametrów ma unikalną nazwę w szablonie Remote Config. Podczas tworzenia grup parametrów pamiętaj o tych kwestiach:

• Parametry mogą być uwzględniane tylko w jednej grupie naraz, a klucz parametru musi być unikalny we wszystkich parametrach.
• Nazwy grup parametrów mogą mieć maksymalnie 256 znaków.
• Jeśli używasz zarówno interfejsu API typu REST, jak i konsoli Firebase, upewnij się, że logika interfejsu API typu REST została zaktualizowana, aby obsługiwać grupy parametrów podczas publikowania.

Tworzenie i modyfikowanie grup parametrów za pomocą konsoli Firebase

Parametry możesz grupować w konsoli Firebase. Aby utworzyć lub zmodyfikować grupę:

1. W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Parametry.
2. Wybierz Zarządzaj grupami.
3. Zaznacz pola wyboru obok parametrów, które chcesz dodać, i kliknij Przenieś do grupy.
4. Wybierz istniejącą grupę lub utwórz nową, wpisując nazwę i opis, a następnie klikając Utwórz nową grupę. Po zapisaniu grupy możesz ją opublikować, klikając przycisk Opublikuj zmiany.

Tworzenie grup automatycznie

Interfejs REST API Remote Config umożliwia automatyczne tworzenie i publikowanie grup parametrów. Jeśli znasz REST i masz skonfigurowaną autoryzację żądań do interfejsu API, możesz wykonać te czynności, aby zarządzać grupami programowo:

1. pobrać bieżący szablon,
2. Dodaj obiekty JSON, które będą reprezentować grupy parametrów.
3. Opublikuj grupy parametrów za pomocą żądania HTTP PUT.

Obiekt parameterGroups zawiera klucze grup z zagnieżdżonym opisem i listą pogrupowanych parametrów. Pamiętaj, że każdy klucz grupy musi być globalnie unikalny.

Oto przykład fragmentu wersji szablonu, który dodaje grupę parametrów „new menu” z jednym parametrem pumpkin_spice_season:

{
  "parameters": {},
  "version": {
    "versionNumber": "1",

    …

  },
  "parameterGroups": {
    "new menu": {
      "description": "New Menu",
      "parameters": {
        "pumpkin_spice_season": {
          "defaultValue": {
            "value": "true"
          },
          "description": "Whether it's pumpkin spice season."
        }
      }
    }
  }
}

Warunki sygnału niestandardowego

Wartości warunkowe sygnałów niestandardowych mogą służyć do dopasowywania dowolnych sygnałów, które definiujesz i wysyłasz w aplikacji, do warunków utworzonych na podstawie sygnałów w usłudze Remote Config. Dzięki temu możesz dostosowywać działanie aplikacji lub strony klienta.

Warunki sygnałów niestandardowych są dostępne w przypadku tych środowisk klienta:

• iOS: wersja 11.8.0 lub nowsza,
• Android: wersja 22.1.0 lub nowsza (Firebase BoM w wersji 33.8.0 lub nowszej)
• Internet: wersja 11.2.0 lub nowsza
• Flutter: Flutter BoM w wersji 3.6.0 lub nowszej

Załóżmy na przykład, że pracujesz nad aplikacją do sprzedaży biletów i chcesz wyświetlać baner na ekranie głównym. Możesz używać warunków niestandardowych sygnałów po stronie klienta, aby personalizować te banery na podstawie lokalizacji i zainteresowań użytkownika. Możesz wykonać te czynności:

1. Dodaj banner_image_url i banner_link do szablonu klienta Remote Config. Reprezentują one obraz banera i powiązaną z nim stronę wydarzenia.
2. Ustaw sygnały niestandardowe z aplikacji z wartościami city i preferred_event_category.
3. Dodaj wartości domyślne do szablonu Remote Config dla klienta i utwórz wartości warunkowe na podstawie sygnałów niestandardowych ustawionych w poprzednim kroku.
4. Dodaj wartości domyślne do szablonu Remote Config dla klienta i wartości warunkowe dla każdego zdefiniowanego warunku.
5. Zaktualizuj kod aplikacji, aby ustawić i używać warunków sygnałów niestandardowych.

Teraz aplikacja może pobrać odpowiednie wartości banner_image_url i banner_link, gdy pobiera te parametry z serwera Remote Config.

Limity

Podczas tworzenia warunków sygnałów niestandardowych musisz przestrzegać tych limitów:

• Liczba sygnałów niestandardowych: możesz utworzyć maksymalnie 100 sygnałów niestandardowych na instancję aplikacji. Sygnał niestandardowy możesz usunąć, ustawiając jego wartość na null.
• Nazwa sygnału niestandardowego: każda nazwa sygnału niestandardowego może mieć maksymalnie 250 znaków.
• Wartość sygnału niestandardowego: każda wartość sygnału niestandardowego może mieć maksymalnie 500 znaków. Jeśli używasz wyrażeń regularnych, limit wynosi 250 znaków.

Typy reguł warunków

W konsoli Firebase obsługiwane są te typy reguł: Równoważne funkcje są dostępne w interfejsie Remote Config REST API, jak opisano w dokumentacji wyrażeń warunkowych.

Parametry i warunki wyszukiwania

Klucze parametrów, wartości parametrów i warunki projektu możesz wyszukiwać w konsoli Firebase za pomocą pola wyszukiwania u góry strony DevOps i zaangażowanie > Zdalna konfiguracja > Parametry.

Limity parametrów i warunków

W projekcie w Firebase możesz mieć maksymalnie 3000 parametrów i 2000 warunków. Klucze parametrów mogą mieć maksymalnie 256 znaków, muszą zaczynać się od podkreślenia lub litery z alfabetu angielskiego (A–Z, a–z) i mogą zawierać cyfry. Łączna długość ciągów znaków wartości parametrów w projekcie nie może przekraczać 1 000 000 znaków. Dodatkowo reguły warunków oparte na właściwościach użytkownika mogą zawierać maksymalnie 100 wartości właściwości użytkownika. Pełną listę limitów znajdziesz w artykule Limity.

Wyświetlanie zmian parametrów i warunków

Najnowsze zmiany w szablonach Remote Config możesz wyświetlić w konsoli Firebase. W przypadku każdego parametru i warunku możesz:

• Wyświetlanie nazwy użytkownika, który ostatnio zmodyfikował parametr lub warunek.

• Jeśli zmiana nastąpiła tego samego dnia, wyświetl liczbę minut lub godzin, które upłynęły od opublikowania zmiany w aktywnym szablonie Remote Config.

• Jeśli zmiana została wprowadzona co najmniej dzień wcześniej, sprawdź datę opublikowania zmiany w aktywnym szablonie Remote Config.

Historia zmian parametrów

W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Parametry. Kolumna Ostatnio opublikowane zawiera informacje o ostatnim użytkowniku, który zmodyfikował dany parametr, oraz o ostatniej dacie opublikowania zmiany:

• Aby wyświetlić metadane zmian w przypadku zgrupowanych parametrów, rozwiń grupę parametrów.

• Aby posortować w kolejności rosnącej lub malejącej według daty publikacji, kliknij etykietę kolumny Ostatnio opublikowane.

Historia zmian warunków

W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Warunki. Obok opcji Ostatnia modyfikacja pod każdym warunkiem możesz zobaczyć, kto i kiedy ostatnio go zmodyfikował.

Dalsze kroki

Aby skonfigurować projekt w Firebase i aplikację pod kątem korzystania z Remote Config, zapoznaj się z artykułem Pierwsze kroki z Firebase Remote Config.