firebase-admin.remote-config package

Firebase Remote Config.

Funciones

Función Descripción
getRemoteConfig(app) Obtiene el servicio RemoteConfig para la app predeterminada o una app determinada.Se puede llamar a getRemoteConfig() sin argumentos para acceder al servicio RemoteConfig de la app predeterminada o como getRemoteConfig(app) para acceder al servicio RemoteConfig asociado con una app específica.

Clases

Clase Descripción
RemoteConfig La interfaz del servicio RemoteConfig de Firebase

Enumeraciones

Enumeration Descripción
PercentConditionOperator Define los operadores admitidos para las condiciones porcentuales.

Interfaces

Interfaz Descripción
AndCondition Representa una colección de condiciones que se evalúan como verdaderas si todas son verdaderas.
ExpresalParameterValue Interfaz que representa un valor de parámetro explícito.
GetServerTemplateOptions Representa argumentos opcionales que se pueden usar cuando se crea una instancia de ServerTemplate.
InAppDefaultValue Interfaz que representa un valor predeterminado en la app.
InitServerTemplateOptions Representa argumentos opcionales que se pueden usar cuando se crea una instancia de ServerTemplate de forma síncrona.
ListVersionsOptions Interfaz que representa opciones para la operación de versiones de lista de Remote Config.
ListVersionsResult Interfaz que representa una lista de versiones de plantillas de Remote Config.
MicroPercentRange Representa el límite de percentiles al objetivo en microporcentajes. El valor debe estar entre 0 y 10,000,000
NamedCondition Representa una condición de Remote Config en el plano de datos. Una condición se orienta a un grupo específico de usuarios. Una lista de estas condiciones forma parte de una plantilla de Remote Config.
OneOfCondition Representa una condición que puede ser de varios tipos. Solo se procesará el primer campo definido.
OrCondition Representa una colección de condiciones que se evalúan como verdaderas si algunas son verdaderas.
PercentCondition Representa una condición que compara el percentil pseudoaleatorio de la instancia con un límite determinado.
RemoteConfigCondition Interfaz que representa una condición de Remote Config. Una condición se orienta a un grupo específico de usuarios. Una lista de estas condiciones forma parte de una plantilla de Remote Config.
RemoteConfigParameter Interfaz que representa un parámetro de Remote Config. Como mínimo, debe haber una entrada defaultValue o conditionalValues para que el parámetro tenga efecto.
RemoteConfigParameterGroup Interfaz que representa un grupo de parámetros de Remote Config. La agrupación de parámetros solo tiene fines administrativos y no afecta la recuperación de los valores de los parámetros del cliente.
RemoteConfigTemplate Representa una plantilla de cliente de Remote Config.
RemoteConfigUser Interfaz que representa a un usuario de Remote Config.
ServerConfig Representa la configuración producida mediante la evaluación de una plantilla de servidor.
ServerTemplate Representa una abstracción con estado de una plantilla del servidor de Remote Config.
ServerTemplateData Representa los datos en una plantilla del servidor de Remote Config.
Valor Une un valor de parámetro con metadatos y métodos get de tipo seguro.Los métodos get de tipo seguro aíslan la lógica de la aplicación de los cambios remotos a nombres y tipos de parámetros.
Versión Interfaz que representa una versión de plantilla de Remote Config. Solo salida, excepto la descripción de la versión. Contiene metadatos sobre una versión específica de la plantilla de Remote Config. Todos los campos se configuran en el momento en que se publica la plantilla de Remote Config especificada. El campo de descripción de una versión se puede especificar en llamadas a publishTemplate.

Escribe alias

Alias de tipo Descripción
Configuración predeterminada Define el formato para los valores de parámetros predeterminados en la app.
Contexto de evaluación Representa los indicadores de entrada de evaluación de la plantilla.
Tipo de valor del parámetro Tipo que representa un tipo de datos del valor del parámetro de Remote Config. Si no se especifica, el número predeterminado es STRING.
RemoteConfigParameterValue Tipo que representa un valor de parámetro de Remote Config. Un RemoteConfigParameterValue puede ser ExplicitParameterValue o InAppDefaultValue.
ServerTemplateDataType Representa el tipo de una plantilla del servidor de Remote Config que se puede configurar en ServerTemplate. Puede ser un objeto ServerTemplateData o una string JSON de plantilla.
Color de etiqueta Colores asociados con condiciones para fines de visualización.
Fuentedevalor Indica la fuente de un valor.
  • “estático” indica que el valor se definió por una constante estática.
  • “predeterminado” indica que el valor se definió según la configuración predeterminada.
  • "remoto" indica que el valor se definió por la configuración generada mediante la evaluación de una plantilla.

getRemoteConfig(aplicación)

Obtiene el servicio RemoteConfig para la app predeterminada o una app determinada.

Se puede llamar a getRemoteConfig() sin argumentos para acceder al servicio RemoteConfig de la app predeterminada o como getRemoteConfig(app) para acceder al servicio RemoteConfig asociado con una app específica.

Firma:

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

Parámetros

Parámetro Tipo Descripción
app App App opcional para la que se muestra el servicio RemoteConfig. Si no se proporciona, se muestra el servicio RemoteConfig predeterminado.

Muestra:

RemoteConfig

El servicio RemoteConfig predeterminado si no se proporciona ninguna app, o bien el servicio RemoteConfig asociado con la app proporcionada

Ejemplo 1

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

Ejemplo 2

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

Configuración predeterminada

Define el formato para los valores de parámetros predeterminados en la app.

Firma:

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

Contexto de evaluación

Representa los indicadores de entrada de evaluación de la plantilla.

Firma:

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

ParameterValueType

Tipo que representa un tipo de datos del valor del parámetro de Remote Config. Si no se especifica, el número predeterminado es STRING.

Firma:

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

Valor del parámetro RemoteConfig

Tipo que representa un valor de parámetro de Remote Config. Un RemoteConfigParameterValue puede ser ExplicitParameterValue o InAppDefaultValue.

Firma:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

TipoDeDatosDePlantillaDeServidor

Representa el tipo de una plantilla del servidor de Remote Config que se puede configurar en ServerTemplate. Puede ser un objeto ServerTemplateData o una string JSON de plantilla.

Firma:

export type ServerTemplateDataType = ServerTemplateData | string;

Color de la etiqueta

Colores asociados con condiciones para fines de visualización.

Firma:

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

ValorSource

Indica la fuente de un valor.

  • “estático” indica que el valor se definió por una constante estática.
  • “predeterminado” indica que el valor se definió según la configuración predeterminada.
  • "remoto" indica que el valor se definió por la configuración generada mediante la evaluación de una plantilla.

Firma:

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

PercentConditionOperator

Define los operadores admitidos para las condiciones porcentuales.

Firma:

export declare enum PercentConditionOperator

Miembros de enumeración

Miembro Valor Descripción
BETWEEN "BETWEEN" Percentiles objetivo dentro de un intervalo definido por un límite inferior y un límite superior. El límite inferior es un límite exclusivo (abierto) y micro_percent_range_upper_bound es un límite inclusivo (cerrado). Una condición que usa este operador debe especificar microPercentRange.
GREATER_THAN "GREATER_THAN" Percentiles objetivo superiores al porcentaje objetivo. Una condición que usa este operador debe especificar microPercent.
MENOS_O_EQUAL "LESS_OR_EQUAL" Percentiles objetivo inferiores o iguales al porcentaje objetivo. Una condición que usa este operador debe especificar microPercent.
DESCONOCIDO "UNKNOWN" Un caso de error genérico