Parâmetros e condições da Configuração remota em modelos de cliente

É possível disponibilizar parâmetros e valores de Remote Config de modelos de clientes para qualquer instância de app que implemente os SDKs de cliente do Firebase para Remote Config, incluindo apps Apple, Android, Web, Flutter, Unity e C++.

Ao usar o console de Firebase ou as APIs de back-end de Remote Config, você define um ou mais parâmetros (pares de chave-valor) e informa valores padrão no app para esses parâmetros. É possível substituir os valores padrão no app definindo valores de parâmetros. As chaves e os valores de parâmetros são strings, mas os valores podem ser transmitidos como outros tipos de dados quando você os usa no app.

Com o console de Firebase, Admin SDK ou a API REST de Remote Config, é possível criar novos valores padrão para os parâmetros, além de valores condicionais usados para segmentar grupos de instâncias de app. Sempre que você atualiza a configuração no console do Firebase, o Firebase cria e publica uma nova versão do modelo de Remote Config. A versão anterior é armazenada, o que permite fazer uma recuperação ou reversão conforme necessário. Essas operações estão disponíveis no console de Firebase, em Firebase Admin SDK e na API REST e são descritas em mais detalhes em Gerenciar versões de modelos de Remote Config.

Este guia explica parâmetros, condições, regras, valores condicionais e como os diversos valores de parâmetros são priorizados no back-end de Remote Config e no app. Ele também contém detalhes dos tipos de regras usados para criar condições.

Condições, regras e valores condicionais

Uma condição é usada para segmentar um grupo de instâncias de aplicativos. As condições são constituídas por uma ou mais regras que precisam ser avaliadas como true para que a condição seja avaliada como true em uma determinada instância do aplicativo. Se o valor de uma regra for indefinido (por exemplo, quando não houver valor disponível), essa regra será avaliada como false.

Por exemplo, um parâmetro que define a página inicial de um app pode exibir imagens diferentes com base no tipo de SO usando a regra if device_os = Android:

Como opção, uma condição de tempo pode ser usada para controlar quando seu app exibe itens promocionais especiais.

Um parâmetro pode ter vários valores condicionais que usam condições diferentes, e os parâmetros podem compartilhar condições em um projeto. No console do Firebase, acesse a página DevOps e engajamento > Configuração remota > Parâmetros para conferir a porcentagem de busca dos valores condicionais de cada parâmetro. Essa métrica indica a porcentagem de solicitações nas últimas 24 horas que receberam cada valor.

Adicionar, editar, reordenar ou excluir condições usando o console Firebase

É possível criar, editar, reordenar e excluir condições de segmentação no console do Firebase. As condições são compartilhadas entre parâmetros em um projeto. Veja como gerenciar condições:

1. No console do Firebase, acesse DevOps e engajamento > Configuração remota > página Condições (ou selecione Gerenciar condições na página Parâmetros).
2. Adicionar uma condição: clique em Adicionar condição (ou Criar sua primeira condição), insira um nome que defina o objetivo de segmentação e selecione uma ou mais regras de segmentação.
3. Editar uma condição: clique no nome da condição ou no ícone de edição, modifique as regras conforme necessário e clique em Salvar.
4. Mudar a prioridade da condição: na página Condições, arraste as condições pela alça para reordená-las. As condições mais altas na lista têm precedência sobre as mais baixas.
5. Excluir uma condição: clique no ícone de exclusão ao lado da condição que você quer remover. Se a condição for referenciada por algum parâmetro, a remoção dela também vai remover os valores condicionais associados.

Depois de salvar as mudanças na condição, publique o modelo usando Publicar alterações.

Limitação do IPv6 com controle de acesso baseado em IP

O Remote Config tem compatibilidade limitada com IPv6 quando usado com políticas de acesso baseadas em IP. Se a organização restringir o acesso a intervalos de IP público específicos, a conexão por uma rede IPv6 poderá causar os seguintes problemas:

• Acesso ao console: talvez não seja possível usar determinados recursos do Remote Config no console Firebase, como carregar dados ou configurar o direcionamento.
• Acesso do cliente: os apps cliente podem encontrar erros PERMISSION_DENIED.

Para evitar esses problemas, configure sua rede para usar IPv4 ou adicione os intervalos de IP necessários do Firebase à lista de permissões da sua organização.

Prioridade dos valores de parâmetros

Um parâmetro pode ter diversos valores condicionais associados. Estas regras determinam qual valor é buscado no modelo de Remote Config e qual valor é usado em uma determinada instância de app em um determinado momento:

1. Primeiro, os valores condicionais são aplicados a qualquer condição avaliada como true para uma determinada solicitação de cliente. Se várias condições forem avaliadas como true, a condição superior mostrada na interface do console de Firebase terá precedência e os valores condicionais associados a ela serão fornecidos quando um app recuperar valores do back-end. É possível mudar a prioridade das condições ao arrastá-las e soltá-las na página Condições.

2. Se não houver valores condicionais com condições que sejam avaliadas como true, o valor padrão de Remote Config será fornecido quando um app buscar valores do back-end. Se um parâmetro não existir no back-end ou o valor padrão for definido como Usar padrão no app, nenhum valor será fornecido para o parâmetro quando um app buscar valores.

No seu app, os valores dos parâmetros são retornados por métodos get de acordo com a seguinte lista de prioridades:

1. Se um valor tiver sido buscado no back-end e ativado, o app usará o valor recuperado. Os valores dos parâmetros ativados são permanentes.

2. Se nenhum valor tiver sido buscado no back-end ou os valores buscados no back-end de Remote Config não tiverem sido ativados, o app vai usar o valor padrão que estão nele.

   Para saber como receber e definir valores padrão, acesse Fazer o download dos padrões de modelo de Remote Config.

3. Se nenhum valor padrão no app tiver sido definido, o app vai usar um valor de tipo estático (como 0 para int e false para boolean).

Confira neste gráfico o resumo de como os valores de parâmetro são priorizados no back-end de Remote Config e no app:

Tipos de dados de valores de parâmetros

Remote Config permite selecionar um tipo de dados para cada parâmetro e valida todos os valores de Remote Config em relação a esse tipo antes de uma atualização de modelo. O tipo de dados é armazenado e retornado em uma solicitação getRemoteConfig.

Os tipos de dados compatíveis são:

• String
• Boolean
• Number
• JSON

Na interface do console de Firebase, o tipo de dados pode ser selecionado em um menu suspenso ao lado da chave de parâmetro. Na API REST, é possível definir os tipos usando o campo value_type no objeto de parâmetro.

Grupos de parâmetros

Remote Config permite agrupar parâmetros para ter uma interface mais organizada e melhorar a usabilidade.

Por exemplo, imagine que você precisa ativar ou desativar três tipos diferentes de autenticação ao lançar um novo recurso de login. Com Remote Config, é possível criar os três parâmetros para ativar os tipos que você quer e organizá-los em um grupo chamado Novo login, sem necessidade de adicionar prefixos ou classificação especial.

É possível criar grupos de parâmetros usando o console de Firebase ou a API REST de Remote Config. Cada grupo de parâmetros criado tem um nome exclusivo no modelo de Remote Config. Ao criar grupos de parâmetros, lembre-se do seguinte:

• Os parâmetros podem ser incluídos em apenas um grupo por vez, e uma chave de parâmetro ainda precisa ser exclusiva em todos os parâmetros.
• Os nomes dos grupos de parâmetros são limitados a 256 caracteres.
• Se você usar a API REST e o console de Firebase, verifique se qualquer lógica da API REST está atualizada para lidar com grupos de parâmetros na publicação.

Criar ou modificar grupos de parâmetros usando o console de Firebase

É possível agrupar parâmetros no console do Firebase. Veja como criar ou modificar um grupo:

1. No console do Firebase, acesse a página DevOps e engajamento > Configuração remota > Parâmetros.
2. Selecione Gerenciar grupos.
3. Marque as caixas de seleção dos parâmetros que você quer adicionar e selecione Mover para o grupo.
4. Para selecionar um grupo atual ou criar um novo grupo, digite um nome e uma descrição e selecione Criar novo grupo. Depois de salvar um grupo, ele estará disponível para ser publicado usando o botão Publicar alterações.

Criar grupos de maneira programática

A API REST Remote Config oferece uma maneira automatizada de criar e publicar grupos de parâmetros. Supondo que você esteja familiarizado com o REST e pronto para autorizar solicitações à API, execute estas etapas para gerenciar grupos de maneira programática:

1. Recuperar o modelo atual.
2. Adicione objetos JSON para representar seus grupos de parâmetros.
3. Publicar os grupos de parâmetros usando uma solicitação HTTP PUT.

O objeto parameterGroups contém chaves de grupo, com uma descrição aninhada e uma lista de parâmetros agrupados. Cada chave de grupo precisa ser globalmente exclusiva.

Por exemplo, veja um trecho de uma revisão de modelo que adiciona o grupo de parâmetros "novo menu" com um parâmetro, 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."
        }
      }
    }
  }
}

Condições de indicadores personalizados

Os valores condicionais de indicadores personalizados podem ser usados para corresponder a indicadores arbitrários que você define e envia no aplicativo com condições criadas com base nos indicadores em Remote Config. Isso permite personalizar as experiências do app ou do lado do cliente.

As condições de indicador personalizados estão disponíveis para os seguintes ambientes de cliente:

• iOS: v11.8.0 ou mais recente
• Android: v22.1.0 ou mais recente (BoM do Firebase v33.8.0 ou mais recente)
• Web: v11.2.0 ou mais recente
• Flutter: BoM do Flutter versão 3.6.0 ou mais recente

Por exemplo, suponha que você esteja trabalhando em um app de venda de ingressos em que queira exibir um banner na tela inicial. É possível usar condições de indicador personalizado do lado do cliente para personalizar esses banners com base no local e nos interesses do usuário. Você pode fazer o seguinte:

1. Adicione banner_image_url e banner_link ao modelo de cliente Remote Config. Eles representam a imagem do banner e a página do evento associada a essa imagem.
2. Defina indicadores personalizados do app com os valores city e preferred_event_category.
3. Adicione valores padrão ao modelo de Remote Config específico do cliente e crie valores condicionais com base nos indicadores personalizados definidos na etapa anterior.
4. Adicione valores padrão ao modelo de Remote Config específico do cliente e valores condicionais para cada condição definida.
5. Atualize o código do aplicativo para definir e usar o indicador personalizado.

Agora, o app pode fazer o download do banner_image_url e do banner_link adequados quando buscar esses parâmetros do servidor Remote Config.

Limites

Ao criar condições de indicador personalizados, você precisa seguir os seguintes limites:

• Número de indicadores personalizados: é possível criar até 100 indicadores personalizados por instância de app. Para remover um indicador personalizado, defina o valor dele como nulo.
• Nome do indicador personalizado: cada nome de indicador personalizado pode ter no máximo 250 caracteres.
• Valor de indicador personalizado: cada valor de indicador personalizado pode ter até 500 caracteres. Ao usar expressões regulares, o limite é de 250 caracteres.

Tipos de regra de condição

Os tipos de regras a seguir são compatíveis com o console de Firebase. Recursos equivalentes estão disponíveis na API REST de Remote Config, conforme detalhado na referência de expressão condicional.

Parâmetros e condições de pesquisa

Pesquise as chaves de parâmetro, os valores de parâmetro e as condições do projeto no console de Firebase usando a caixa de pesquisa na parte superior da página DevOps e engajamento > Configuração remota > Parâmetros.

Limites de parâmetros e condições

Dentro de um projeto do Firebase, você tem até 3.000 parâmetros e 2.000 condições. As chaves dos parâmetros podem ter até 256 caracteres e precisam começar com sublinhado ou uma letra (A-Z, a-z), além de incluir números. O tamanho total das strings dos valores de parâmetro não pode exceder 1.000.000 caracteres. Além disso, as regras de condição baseadas em propriedades do usuário podem incluir até 100 valores de propriedade do usuário. Para acessar uma lista completa de limites, consulte Cotas e limites.

Conferir as mudanças nos parâmetros e nas condições

É possível conferir as mudanças mais recentes nos modelos de Remote Config no console de Firebase. Para cada parâmetro e condição individual, é possível:

• Ver o nome do usuário que modificou o parâmetro ou a condição pela última vez.

• Se a mudança ocorreu no mesmo dia, confira o número de minutos ou horas decorridos desde a publicação no modelo ativo de Remote Config.

• Se a mudança ocorreu há um ou mais dias, confira a data em que ela foi publicada no modelo ativo de Remote Config.

Histórico de alterações de parâmetros

No console do Firebase, acesse a página DevOps e engajamento > Configuração remota > Parâmetros. A coluna Última publicação mostra o último usuário que modificou cada parâmetro e a data da última publicação da mudança:

• Para ver os metadados de mudança dos parâmetros agrupados, expanda o grupo de parâmetros.

• Para classificar em ordem crescente ou decrescente por data de publicação, clique no rótulo da coluna Última publicação.

Histórico de alterações de condições

No console do Firebase, acesse DevOps e engajamento > Configuração remota > página Condições. É possível conferir o último usuário que modificou a condição e a data da modificação ao lado de Última modificação, abaixo de cada condição.

Próximas etapas

Para configurar o projeto do Firebase e o app para usar Remote Config, consulte Introdução ao Firebase Remote Config.