Ta strona została przetłumaczona przez Cloud Translation API.

firebase-admin.remote-config package

Zdalna konfiguracja Firebase.

Funkcje

Funkcja	Opis
getRemoteConfig(aplikacja)	Pobiera usługę RemoteConfig dla aplikacji domyślnej lub danej.`getRemoteConfig()` może być wywoływany bez argumentów umożliwiający dostęp do usługi `RemoteConfig` domyślnej aplikacji lub jako `getRemoteConfig(app)`, aby uzyskać dostęp do usługi `RemoteConfig` powiązanej z konkretną aplikacją.

Zajęcia

Klasa	Opis
Zdalna konfiguracja	Interfejs usługi Firebase `RemoteConfig`.

Wyliczenia

Wyliczenie	Opis
Operator PercentCondition	Definiuje obsługiwane operatory dla warunków procentowych.

Interfejsy

Interfejs	Opis
AndCondition	Reprezentuje zbiór warunków, które oceniają wartość prawda, jeśli wszystkie są prawdziwe.
WyraźnyParametrValue	Interfejs przedstawiający jawną wartość parametru.
GetServerTemplateOptions	Reprezentuje opcjonalne argumenty, których można używać podczas tworzenia instancji ServerTemplate.
InAppDefaultValue	Interfejs reprezentujący wartość domyślną w aplikacji.
InitServerTemplateOptions	Reprezentuje opcjonalne argumenty, których można używać podczas synchronicznego tworzenia instancji ServerTemplate.
ListVersionsOptions.	Interfejs przedstawiający opcje operacji na liście wersji Zdalnej konfiguracji.
ListVersionsResult (Wynik listy wersji)	Interfejs przedstawiający listę wersji szablonów Zdalnej konfiguracji.
MicroPercentRange	Reprezentuje limit centyli, na które mają być kierowane reklamy, w mikroprocentach. Wartość musi należeć do zakresu od 0 do 100000000]
NamedCondition	Reprezentuje warunek Zdalnej konfiguracji w planie danych. Warunek jest kierowany na określoną grupę użytkowników. Lista tych warunków zawiera część szablonu Zdalnej konfiguracji.
OneOfCondition,	Reprezentuje warunek, który może być jednym z kilku typów. Przetworzone zostanie tylko pierwsze zdefiniowane pole.
OrCondition	Reprezentuje zbiór warunków, które sprawdzają się jako prawda, jeśli któreś z nich są prawdziwe.
PercentCondition	Reprezentuje warunek, który porównuje pseudolosowy percentyl instancji z podanym limitem.
RemoteConfigCondition	Interfejs reprezentujący warunek Zdalnej konfiguracji. Warunek jest kierowany na określoną grupę użytkowników. Lista tych warunków jest częścią szablonu Zdalnej konfiguracji.
RemoteConfigParametr,	Interfejs przedstawiający parametr Zdalnej konfiguracji. Aby parametr miał skutek, musi zawierać co najmniej wpis `defaultValue` lub `conditionalValues`.
RemoteConfigParametersGroup	Interfejs reprezentujący grupę parametrów Zdalnej konfiguracji. Parametry grupowania służą tylko do zarządzania i nie wpływają na pobieranie wartości parametrów po stronie klienta.
RemoteConfigTemplate,	Reprezentuje szablon klienta Zdalnej konfiguracji.
RemoteConfigUser (Użytkownik zdalnej konfiguracji)	Interfejs reprezentujący użytkownika Zdalnej konfiguracji.
Konfiguracja serwera	Reprezentuje konfigurację wygenerowaną przez ocenę szablonu serwera.
Szablon serwera	Reprezentuje stanową abstrakcję dla szablonu serwera Zdalnej konfiguracji.
ServerTemplateData (Dane szablonu serwera)	Reprezentuje dane w szablonie serwera Zdalnej konfiguracji.
Wartość	Opakowuje wartość parametru metadanymi i elementami pobierającymi bezpieczne do typu.Bezpieczne typy pobierające izolują logikę aplikacji od zdalnych zmian nazw i typów parametrów.
Wersja	Interfejs reprezentujący wersję szablonu Zdalnej konfiguracji. Tylko dane wyjściowe, oprócz opisu wersji. Zawiera metadane dotyczące określonej wersji szablonu Zdalnej konfiguracji. Wszystkie pola są ustawiane w momencie opublikowania określonego szablonu Zdalnej konfiguracji. Pole opisu wersji można określić w wywołaniach funkcji `publishTemplate`.

Aliasy typu

Wpisz alias	Opis
DefaultConfig	Określa format domyślnych wartości parametrów w aplikacji.
Kontekst oceny	Reprezentuje sygnały wejściowe oceny szablonu.
ParametrValueType	Typ danych reprezentujący wartość parametru Zdalnej konfiguracji. Jeśli nie określono inaczej, domyślna wartość to `STRING`.
RemoteConfigParametrValue,	Typ reprezentujący wartość parametru Zdalnej konfiguracji. Elementem `RemoteConfigParameterValue` może być `ExplicitParameterValue` lub `InAppDefaultValue`.
ServerTemplateDataType (Typ danych ServerTemplateDataType)	Reprezentuje typ szablonu serwera Zdalnej konfiguracji, który można ustawić w ServerTemplate. Może to być obiekt ServerTemplateData lub ciąg JSON szablonu.
TagColor	Kolory powiązane z warunkami w celu wyświetlania.
ValueSource,	Wskazuje źródło wartości. „statyczne” wskazuje, że wartość została zdefiniowana przez stałą statyczną. „domyślna” wskazuje wartość zdefiniowaną przez konfigurację domyślną. „pilot” wskazuje wartość zdefiniowaną przez konfigurację wygenerowaną w wyniku oceny szablonu.

getRemoteConfig(aplikacja)

Pobiera usługę RemoteConfig dla aplikacji domyślnej lub danej.

Funkcja getRemoteConfig() może być wywoływana bez argumentów umożliwiających dostęp do usługi RemoteConfig domyślnej aplikacji lub jako getRemoteConfig(app) w celu uzyskania dostępu do usługi RemoteConfig powiązanej z konkretną aplikacją.

Podpis:

export declare function getRemoteConfig(app?: App): RemoteConfig;

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja	Opcjonalna aplikacja, w przypadku której ma zostać zwrócona usługa `RemoteConfig`. Jeśli nie zostanie podana, zwrócona zostanie domyślna usługa `RemoteConfig`.

Zwroty:

Zdalna konfiguracja

Domyślna usługa RemoteConfig w przypadku braku aplikacji lub usługa RemoteConfig powiązana z udostępnioną aplikacją.

Przykład 1

// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();

Przykład 2

// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);

Domyślna konfiguracja

Określa format domyślnych wartości parametrów w aplikacji.

Podpis:

export type DefaultConfig = {
    [key: string]: string | number | boolean;
};

Kontekst oceny

Reprezentuje sygnały wejściowe oceny szablonu.

Podpis:

export type EvaluationContext = {
    randomizationId?: string;
};

Typ wartości parametru

Typ danych reprezentujący wartość parametru Zdalnej konfiguracji. Jeśli nie określono inaczej, domyślna wartość to STRING.

Podpis:

export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';

Wartość parametru RemoteConfig

Typ reprezentujący wartość parametru Zdalnej konfiguracji. Elementem RemoteConfigParameterValue może być ExplicitParameterValue lub InAppDefaultValue.

Podpis:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

Typ danych szablonu serwera

Reprezentuje typ szablonu serwera Zdalnej konfiguracji, który można ustawić w ServerTemplate. Może to być obiekt ServerTemplateData lub ciąg JSON szablonu.

Podpis:

export type ServerTemplateDataType = ServerTemplateData | string;

Kolor tagu

Kolory powiązane z warunkami w celu wyświetlania.

Podpis:

export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';

Źródło wartości

Wskazuje źródło wartości.

„statyczna” wskazuje, że wartość została zdefiniowana przez stałą statyczną.
„domyślna” wskazuje wartość zdefiniowaną przez konfigurację domyślną.
„pilot” wskazuje wartość zdefiniowaną przez konfigurację wygenerowaną w wyniku oceny szablonu.

Podpis:

export type ValueSource = 'static' | 'default' | 'remote';

Operator warunku Percent

Definiuje obsługiwane operatory dla warunków procentowych.

Podpis:

export declare enum PercentConditionOperator

Członkowie wyliczenia

Członek	Wartość	Opis
POMIĘDZY	`"BETWEEN"`	Docelowe centyle w przedziale zdefiniowanym zarówno dolną, jak i górną granicą. Dolna granica jest granicą wyłączności (otwartą), a mikro_percent_zakres_upper_bound granicą uwzględniającą (zamkniętą). Warunek korzystający z tego operatora musi określać parametr microPercentRange.
GREATER_THAN	`"GREATER_THAN"`	Centyl docelowy jest większy niż docelowy odsetek. Warunek wykorzystujący ten operator musi określać parametr microPercent.
MNIEJ_LUB_RÓWNE	`"LESS_OR_EQUAL"`	Docelowe centyle mniejsze lub równe docelowemu procentowi. Warunek wykorzystujący ten operator musi określać parametr microPercent.
BRAK INFORMACJI	`"UNKNOWN"`	Przypadek błędu typu chwyt.