RemoteConfig

Um RemoteConfig representa um modelo do Remote Config.

O modelo do Configuração remota de um projeto é avaliado durante a busca de cada instância do aplicativo.

O valor resolvido de um parâmetro é determinado da seguinte forma:

Dados os conditional values que se referem a conditions true para a instância do aplicativo, o valor resolvido do parâmetro é o valor condicional cujo name é o primeiro na conditions list .

Caso contrário, se o parâmetro tiver um default value , o valor resolvido será definido como o valor padrão.

Caso contrário, o parâmetro não tem valor e é omitido do resultado que a instância do aplicativo busca.

Por exemplo, suponha que temos o parâmetro key fruit , com o valor padrão pear e o submap de valor condicional {"is_ios": "apple", "is_in_20_percent": "banana"} onde "is_ios" e "is_20_percent" são nomes de condições na ordem lista de condições. O valor de fruit seria avaliado como apple se is_ios for verdadeiro. Caso contrário, se is_in_20_percent for true , fruit será avaliado como banana e se is_ios e is_in_20_percent forem ambos false, fruit será avaliado como pear . Se nenhum valor padrão for especificado e is_ios e is_in_20_percent forem ambos falsos, nenhum valor para fruit será retornado do servidor do Remote Config para o cliente.

Depois que o modelo do Configuração remota de um projeto for publicado por meio de uma chamada projects.updateRemoteConfig bem-sucedida, os clientes poderão buscar esses valores de parâmetro e exibi-los aos usuários.

Representação JSON
{
  "conditions": [
    {
      object (RemoteConfigCondition)
    }
  ],
  "parameters": {
    string: {
      object (RemoteConfigParameter)
    },
    ...
  },
  "version": {
    object (Version)
  },
  "parameterGroups": {
    string: {
      object (RemoteConfigParameterGroup)
    },
    ...
  }
}
Campos
conditions[]

object ( RemoteConfigCondition )

Uma lista de condições em ordem decrescente por prioridade.

Os valores das entradas google.firebase.remoteconfig.v1.RemoteConfigCondition.name devem ser exclusivos.

parameters

map (key: string, value: object ( RemoteConfigParameter ))

Mapa de chaves de parâmetro para seus valores padrão opcionais e valores condicionais opcionais.

Um objeto contendo uma lista de "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

version

object ( Version )

Saída apenas, exceto para a description da versão. Metadados associados a uma versão específica de um modelo. O campo de descrição de uma versão pode ser especificado em chamadas projects.updateRemoteConfig .

parameterGroups

map (key: string, value: object ( RemoteConfigParameterGroup ))

Mapa de nomes de grupos de parâmetros para suas descrições e parâmetros agrupados. O nome de um grupo é mutável, mas deve ser exclusivo entre os grupos na configuração. O nome está limitado a 256 caracteres e destina-se a ser legível por humanos. Todos os caracteres Unicode são permitidos.

Os grupos têm uma lista de parâmetros que permite que os usuários da API agrupem parâmetros associados ao mesmo recurso ou tema para facilitar o acesso organizacional.

Por exemplo, um grupo de parâmetros com o nome "Pesquisa V2" pode ter a description "Nova visualização de pesquisa móvel" e conter parâmetros para o layout e a fonte da nova pesquisa.

Um objeto contendo uma lista de "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Condição de Configuração Remota

Uma condição direcionada a um grupo específico de usuários. Uma lista dessas condições faz parte de um objeto RemoteConfig.

Representação JSON
{
  "name": string,
  "expression": string,
  "tagColor": enum (ConditionDisplayColor)
}
Campos
name

string

Requeridos. Um nome não vazio e exclusivo dessa condição.

expression

string

Requeridos. A lógica desta condição.

Consulte a documentação sobre Expressões de Condição para obter a sintaxe esperada deste campo.

tagColor

enum ( ConditionDisplayColor )

Opcional. A cor associada a essa condição para fins de exibição no Firebase Console. Não especificar esse valor ou ter "CONDITION_DISPLAY_COLOR_UNSPECIFIED" faz com que o Console escolha uma cor arbitrária para associar à condição.

CondiçãoDisplayColor

Lista de cores associadas a Condições para fins de exibição.

Enums
CONDITION_DISPLAY_COLOR_UNSPECIFIED
BLUE Azul
BROWN Marrom
CYAN Ciano
DEEP_ORANGE também conhecido como "laranja vermelha"
GREEN Verde
INDIGO Índigo
LIME Lima
ORANGE Laranja
PINK Rosa
PURPLE Roxo
TEAL Cerceta

RemoteConfigParameter

Um valor de parâmetro associado a uma chave de parâmetro em google.firebase.remoteconfig.v1.RemoteConfig.parameters .

No mínimo, uma entrada defaultValue ou conditionalValues ​​deve estar presente para que o parâmetro tenha algum efeito.

Representação JSON
{
  "defaultValue": {
    object (RemoteConfigParameterValue)
  },
  "conditionalValues": {
    string: {
      object (RemoteConfigParameterValue)
    },
    ...
  },
  "description": string,
  "valueType": enum (ParameterValueType)
}
Campos
defaultValue

object ( RemoteConfigParameterValue )

Opcional - valor para definir o parâmetro quando nenhuma das condições nomeadas for avaliada como true .

conditionalValues

map (key: string, value: object ( RemoteConfigParameterValue ))

Opcional - um mapa ( condition name , valor). O condition_name da prioridade mais alta (o listado primeiro na lista de condições do RemoteConfig) determina o valor desse parâmetro.

Um objeto contendo uma lista de "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

description

string

Opcional. Uma descrição para este parâmetro. Seu comprimento deve ser menor ou igual a 256 caracteres. Uma descrição pode conter quaisquer caracteres Unicode.

valueType

enum ( ParameterValueType )

O tipo de dados para todos os valores desse parâmetro na versão atual do modelo. O padrão é ParameterValueType.STRING se não for especificado.

RemoteConfigParameterValue

Um recurso RemoteConfigParameterValue contém o valor que um parâmetro pode ter.

Representação JSON
{

  // Union field value_option can be only one of the following:
  "value": string,
  "useInAppDefault": boolean,
  "personalizationValue": {
    object (PersonalizationValue)
  }
  // End of list of possible types for union field value_option.
}
Campos
Campo de união value_option . Um RemoteConfigParameterValue consiste em uma string (valor) ou um booleano (use_in_app_default, definido como true se aplicável). value_option pode ser apenas um dos seguintes:
value

string

O valor de string para o qual o parâmetro está definido.

useInAppDefault

boolean

Se true, o parâmetro é omitido dos valores de parâmetro retornados a um cliente.

personalizationValue

object ( PersonalizationValue )

Um valor dinâmico específico do usuário calculado quando a configuração é buscada.

Valor de personalização

Contém as informações necessárias para buscar um valor personalizado.

Representação JSON
{
  "personalizationId": string
}
Campos
personalizationId

string

Identificador que representa uma definição de personalização. Essa definição é usada para resolver o valor no momento da busca de configuração. Este valor gerado pelo sistema não deve ser modificado.

ParameterValueType

Tipos de dados aceitos para valores de parâmetro.

Enums
PARAMETER_VALUE_TYPE_UNSPECIFIED Catch-all para valores enum não reconhecidos.
STRING Representa valores de String.
BOOLEAN Representa valores booleanos ("true" ou "false").
NUMBER Representa valores inteiros e flutuantes positivos e negativos.
JSON Representa valores JSON.

RemoteConfigParameterGroup

Um grupo nomeado de parâmetros. O agrupamento de parâmetros é apenas para fins de gerenciamento e não afeta a busca de valores de parâmetro do lado do cliente.

Representação JSON
{
  "description": string,
  "parameters": {
    string: {
      object (RemoteConfigParameter)
    },
    ...
  }
}
Campos
description

string

Opcional. Uma descrição para o grupo. Seu comprimento deve ser menor ou igual a 256 caracteres. Uma descrição pode conter quaisquer caracteres Unicode.

parameters

map (key: string, value: object ( RemoteConfigParameter ))

Mapa de chaves de parâmetro para seus valores padrão opcionais e valores condicionais opcionais para parâmetros que pertencem a este grupo. Um parâmetro aparece apenas uma vez por RemoteConfig: um parâmetro desagrupado aparece no nível superior; um parâmetro organizado dentro de um grupo aparece dentro do mapa de parâmetros de seu grupo.

Um objeto contendo uma lista de "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .