firebase-admin.remote-config package

Configuração remota do Firebase.

Funções

Função	Descrição
getRemoteConfig(app) (em inglês)	Recebe o serviço RemoteConfig do app padrão ou de um determinado app.getRemoteConfig() pode ser chamado sem argumentos para acessar o serviço RemoteConfig do app padrão ou como getRemoteConfig(app) para acessar o serviço RemoteConfig associado a um app específico.

Aulas

Turma	Descrição
RemoteConfig (em inglês)	A interface do serviço RemoteConfig do Firebase.

Enumerações

Enumeração	Descrição
PercentConditionOperator (link em inglês)	Define os operadores compatíveis para condições percentuais.

Interfaces

Interface	Descrição
AndCondition (link em inglês)	Representa uma coleção de condições que são avaliadas como verdadeiras se todas forem verdadeiras.
explicitParameterValue (link em inglês)	Interface que representa um valor de parâmetro explícito.
GetServerTemplateOptions (em inglês)	Representa argumentos opcionais que podem ser usados ao instanciar ServerTemplate.
InAppDefaultValue (link em inglês)	Interface que representa um valor padrão no app.
InitServerTemplateOptions (em inglês)	Representa argumentos opcionais que podem ser usados ao instanciar ServerTemplate de forma síncrona.
ListVersionsOptions (link em inglês)	Interface que representa opções para a operação de versões da lista do recurso Configuração remota.
ListVersionsResult (link em inglês)	Interface que representa uma lista de versões de modelos da Configuração remota.
MicroPercentRange (em inglês)	Representa o limite de percentis a serem segmentados em microporcentagens. O valor precisa estar no intervalo [0 e 100000000]
NamedCondition (em inglês)	Representa uma condição da Configuração remota no plano de dados. Uma condição segmenta um grupo específico de usuários. Uma lista dessas condições compreende parte de um modelo da Configuração remota.
OneOfCondition (em inglês)	Representa uma condição que pode ser de um dos vários tipos. Somente o primeiro campo definido será processado.
OrCondition (link em inglês)	Representa uma coleção de condições que são avaliadas como verdadeiras se alguma for verdadeira.
PercentCondition (link em inglês)	Representa uma condição que compara o percentil pseudoaleatório da instância com um determinado limite.
RemoteConfigCondition (em inglês)	Interface que representa uma condição da Configuração remota. Uma condição segmenta um grupo específico de usuários. Uma lista dessas condições faz parte de um modelo da Configuração remota.
RemoteConfigParameter	Interface que representa um parâmetro da Configuração remota. No mínimo, uma entrada defaultValue ou conditionalValues precisa estar presente para que o parâmetro tenha efeito.
RemoteConfigParameterGroup (em inglês)	Interface que representa um grupo de parâmetros da Configuração remota. Os parâmetros de agrupamento servem apenas para gerenciamento e não afetam a busca de valores de parâmetro no lado do cliente.
RemoteConfigTemplate (em inglês)	Representa um modelo de cliente da Configuração remota.
RemoteConfigUser (em inglês)	Interface que representa um usuário da Configuração remota.
ServerConfig (em inglês)	Representa a configuração produzida pela avaliação de um modelo de servidor.
ServerTemplate (em inglês)	Representa uma abstração com estado para um modelo de servidor da Configuração remota.
ServerTemplateData (link em inglês)	Representa os dados em um modelo de servidor da Configuração remota.
Valor	Une um valor de parâmetro com metadados e getters de tipo seguro.Os getters com segurança de tipos isolam a lógica do aplicativo de mudanças remotas em nomes e tipos de parâmetros.
Versão	Interface que representa uma versão de modelo da Configuração remota. Apenas saída, exceto para a descrição da versão. Contém metadados sobre uma versão específica do modelo da Configuração remota. Todos os campos são definidos no momento em que o modelo especificado da Configuração remota é publicado. O campo de descrição de uma versão pode ser especificado em chamadas publishTemplate.

Aliases de tipos

Tipo de alias	Descrição
DefaultConfig (em inglês)	Define o formato dos valores de parâmetros padrão no app.
AvalieContext (em inglês)	Representa os indicadores de entrada de avaliação do modelo.
ParameterValueType (em inglês)	Tipo que representa um tipo de dados do valor de parâmetro da Configuração remota. Quando não especificado, o padrão é STRING.
RemoteConfigParameterValue (em inglês)	Tipo que representa um valor de parâmetro da Configuração remota. Um RemoteConfigParameterValue pode ser um ExplicitParameterValue ou um InAppDefaultValue.
ServerTemplateDataType (em inglês)	Representa o tipo de um modelo de servidor da Configuração remota que pode ser definido em ServerTemplate. Pode ser um objeto ServerTemplateData ou uma string JSON de modelo.
TagColor	Cores associadas a condições para fins de exibição.
ValueSource (em inglês)	Indica a origem de um valor. "estático" indica que o valor foi definido por uma constante estática. "default" indica que o valor foi definido pela configuração padrão. "remote" indica que o valor foi definido pela configuração produzida pela avaliação de um modelo.

getRemoteConfig(app)

Recebe o serviço RemoteConfig para o app padrão ou um determinado app.

getRemoteConfig() pode ser chamado sem argumentos para acessar o serviço RemoteConfig do app padrão ou como getRemoteConfig(app) para acessar o serviço RemoteConfig associado a um app específico.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
app	App	App opcional para retornar o serviço RemoteConfig. Caso não seja fornecido, o serviço RemoteConfig padrão será retornado.

Retorna:

RemoteConfig (em inglês)

O serviço RemoteConfig padrão, se nenhum app for fornecido, ou o serviço RemoteConfig associado ao app fornecido.

Exemplo 1

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

Exemplo 2

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

Configuração padrão

Define o formato dos valores de parâmetros padrão no app.

Assinatura:

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

AvaliaçãoContext

Representa os indicadores de entrada de avaliação do modelo.

Assinatura:

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

ParameterValueType

Tipo que representa um tipo de dados do valor de parâmetro da Configuração remota. Quando não especificado, o padrão é STRING.

Assinatura:

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

RemoteConfigParameterValue

Tipo que representa um valor de parâmetro da Configuração remota. Um RemoteConfigParameterValue pode ser um ExplicitParameterValue ou um InAppDefaultValue.

Assinatura:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

Tipo de dados de modelo do servidor

Representa o tipo de um modelo de servidor da Configuração remota que pode ser definido em ServerTemplate. Pode ser um objeto ServerTemplateData ou uma string JSON de modelo.

Assinatura:

export type ServerTemplateDataType = ServerTemplateData | string;

Cor da tag

Cores associadas a condições para fins de exibição.

Assinatura:

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

Origem do Valor

Indica a origem de um valor.

• "estático" indica que o valor foi definido por uma constante estática.
• "default" indica que o valor foi definido pela configuração padrão.
• "remote" indica que o valor foi definido pela configuração produzida pela avaliação de um modelo.

Assinatura:

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

PercentConditionOperator

Define os operadores compatíveis para condições percentuais.

Assinatura:

export declare enum PercentConditionOperator 

Participantes da enumeração

Participante	Valor	Descrição
BETWEEN	"BETWEEN"	Percentis desejados em um intervalo definido por limites mínimos e máximos. O limite inferior é um limite exclusivo (aberto), e o micro_percent_range_upper_bound é um limite inclusivo (fechado). Uma condição que usa esse operador precisa especificar microPercentRange.
GREATER_THAN	"GREATER_THAN"	Percentis maiores que a porcentagem desejada. Uma condição que usa esse operador precisa especificar microPercent.
MENOR_OU_QUAL	"LESS_OR_EQUAL"	Percentis desejados menores ou iguais à porcentagem desejada. Uma condição que usa esse operador precisa especificar microPercent.
DESCONHECIDO	"UNKNOWN"	Um caso de erro abrangente.