Parâmetros

Com os parâmetros, você pode interagir com os dados fornecidos pelo usuário. Por exemplo, é possível criar campos calculados que incluam entradas de pessoas que usam seu relatório ou retornar valores à consulta SQL usada pela fonte de dados. Com os parâmetros, seus relatórios ficam mais interativos. Também é possível usar parâmetros para criar modelos de relatórios.

Neste artigo:

• Como os parâmetros funcionam
• Criar um parâmetro
• Parâmetros e conectores da comunidade
• Editar um parâmetro existente
• Configurar um parâmetro
• Definir os valores de parâmetro
• Usar parâmetros
• Exibir / ocultar parâmetros em relatórios
• Copiar um componente com parâmetros
• Corrigir parâmetros inválidos
• Recursos relacionados

Como os parâmetros funcionam

Eles agem como variáveis em uma linguagem de programação e possibilitam estes três usos principais:

• Aplicá-los em campos calculados para exibir os resultados com base na entrada do usuário
• Retorná-los à consulta SQL personalizada em uma fonte de dados do BigQuery
• Enviá-los de volta a um conector da comunidade

Os parâmetros recebem dados dos seguintes locais:

• De um valor padrão definido para ele
• Do painel de propriedades do componente
• De um controle inserido no relatório
• Do link para o relatório

Os parâmetros ficam na parte de baixo das listas de campos nos editores de relatórios e fontes de dados, em roxo.

Como os parâmetros compartilham seus dados nos relatórios

Os editores dos seus relatórios e fontes de dados podem acessar todas as informações controladas pelos parâmetros.

Os parâmetros permitem que os editores de relatórios solicitem informações diferentes do padrão. Antes de ativar os parâmetros para sua fonte de dados, é preciso entender como as alterações nos valores de parâmetro afetam as informações dos relatórios. Alguns parâmetros talvez só retornem dados relativamente "seguros", como o clima em uma nova localidade. Por outro lado, há aqueles que permitem a solicitação de conjuntos de dados totalmente novos. Por exemplo, um parâmetro de número de conta ou o nome de uma tabela de banco de dados provavelmente retorna informações que você não pretende compartilhar ou talvez retorne um esquema diferente que pode ser incompatível com os gráficos atuais do relatório.

Criar um parâmetro

É possível criar parâmetros nos seguintes locais:

Em uma fonte de dados

1. Edite a fonte de dados.
2. No canto superior direito, clique em ADICIONAR UM PARÂMETRO.
   Também é possível criar um parâmetro ao editar um relatório. Para isso, selecione um componente e, no canto inferior direito, clique em ADICIONAR UM PARÂMETRO. Selecione um componente com base na fonte de dados desejada.
3. Configure as opções e o valor padrão do parâmetro (confira abaixo).

Ao editar um relatório, é possível usar o link +Adicionar um parâmetro no painel de dados para criar um parâmetro na fonte de dados selecionada.

No conector do BigQuery

É possível enviar os parâmetros para uma consulta SQL personalizada no conector do BigQuery. Ele define vários parâmetros padrão que transmitem as datas de início e término do relatório, além do endereço de e-mail do usuário, quando disponível. Também é possível enviar parâmetros personalizados. Saiba mais

Parâmetros e conectores da comunidade

O conector da comunidade pode incluir parâmetros substituíveis, que permitem aos editores de relatórios modificar os valores padrão em uma fonte de dados. Se você puder editar a conexão de uma fonte de dados criada com um conector da comunidade, especifique quais parâmetros os editores vão poder alterar:

1. Edite a fonte de dados.
2. No canto superior esquerdo, clique em EDITAR CONEXÃO.
3. Se o conector oferece parâmetros editáveis, eles aparecerão na parte inferior da página. Os conectores que permitem definir parâmetros personalizados mostrarão instruções na página.
4. Use as caixas de seleção Permitir que <nome do parâmetro> seja modificado nos relatórios para habilitar ou desabilitar a edição dele.
5. No canto superior direito, clique em RECONECTAR.

Depois de criar uma fonte de dados pelo conector da comunidade, as alterações nos parâmetros dele não aparecerão automaticamente na fonte. Será preciso reconectá-la para conferir os parâmetros novos, removidos ou modificados.

Editar um parâmetro existente

Para alterar a configuração de um parâmetro existente:

1. Edite a fonte de dados que o contém.
2. Localize o parâmetro na lista de campos.
3. Clique no sinal @ à direita do nome do parâmetro.
4. Faça as alterações e clique em SALVAR no canto inferior direito.

Configurar um parâmetro

Use estas opções para configurar um parâmetro na fonte de dados. Para consultar os parâmetros do conector do BigQuery e da comunidade, confira os artigos mencionados acima.

Nome do parâmetro: vai aparecer nas listas de campos nos relatórios e nas fontes de dados. Também é o nome que você usará para se referir ao parâmetro em um campo calculado.

ID do parâmetro: definido por padrão e usado internamente pelo Looker Studio para identificar o parâmetro. Os leitores de relatórios não têm acesso a ele.

Alterar o ID do parâmetro interrompe os componentes e os campos calculados que incluem o parâmetro.

Tipo de dados: os parâmetros podem armazenar texto, números ou valores booleanos (true/false).

Valores permitidos: especifica os valores que podem ser inseridos pelo usuário.

Para especificar uma lista de valores, escolha essa opção e digite o valor aceitável e um nome de exibição opcional. Clique em Adicionar opção para incluir mais itens à lista.

Para especificar um intervalo de valores permitidos, digite os valores mínimo e máximo do intervalo.

Valor padrão: especifique um valor inicial para o parâmetro.

Definir os valores de parâmetro

É possível fazer isso das seguintes maneiras:

Definir um valor padrão para o parâmetro

Você pode definir valores padrão para um parâmetro ao criá-lo. Siga as etapas acima para editar o parâmetro.

Usar um controle para saber as informações dos usuários

Os controles são componentes que as pessoas usam para interagir com um relatório. Para armazenar a entrada do usuário em um parâmetro, adicione esse parâmetro à propriedade Campo "Controle" de um controle:

1. Edite o relatório.
2. Na parte de cima, clique em Adicionar um controle.
3. Escolha o tipo de controle que você quer incluir.

4. No painel Propriedades, selecione a guia CONFIGURAÇÃO.

5. Adicione o parâmetro ao campo "Controle".

Saiba mais sobre os controles.

Modificar valores de parâmetros padrão em um componente

É possível substituir os valores padrão dos parâmetros editando os componentes individuais no relatório:

1. Edite o relatório.
2. Selecione um componente com base em uma fonte de dados que inclua parâmetros.
3. Na parte inferior da guia DADOS do componente, edite os valores padrão do parâmetro.

Também é possível editar parâmetros no nível do relatório e da página:

1. Edite o relatório.
2. Selecione Arquivo > Configurações de relatórios ou Página > Configurações da página atual.
3. Edite os valores dos parâmetros.

Herança de parâmetro

Os parâmetros seguem as mesmas regras de herança das propriedades de filtro. Especificamente, os parâmetros em componentes de prioridade mais alta substituem aqueles com prioridade mais baixa. A ordem de prioridade (da menor para a maior) é:

1. fonte de dados (padrão);
2. relatório;
3. página;
4. grupo;
5. gráfico ou controle individual.

Modificar parâmetros pelo link do relatório

Ao definir parâmetros pelo URL do relatório, os desenvolvedores e usuários avançados conseguem criar relatórios que podem ser configurados de maneira programática.

Os parâmetros de relatório do Looker Studio e os valores correspondentes são enviados como strings JSON codificadas que são anexadas ao URL do relatório usando parâmetros de consulta "params".

Saiba mais no guia para desenvolvedores.

Gerenciar parâmetros de URL do relatório

Por padrão, os parâmetros nos relatórios não podem ser editados pelo URL do relatório.

Para selecionar os parâmetros que os usuários do relatório podem modificar:

1. Edite o relatório.
2. Selecione Recurso > Gerenciar parâmetros de URL do relatório.
3. Na coluna Permitir a configuração pelo URL do relatório, marque os parâmetros que você quer autorizar.

Essa página também exibe o parâmetro de URL de cada parâmetro. Esse é o nome que você usará (não o nome do parâmetro) quando construir o objeto codificado. Para editar, clique no ícone de lápis. Cada parâmetro de URL em um relatório precisa ser exclusivo.

Editar o nome do parâmetro de URL não afeta o modo como ele será usado no relatório.

Usar parâmetros

Depois de criados, você poderá usar os parâmetros nos campos calculados e nos componentes dos relatórios da mesma forma que faria com as dimensões e métricas.

Usar um parâmetro em um campo calculado

Você pode usar um parâmetro da mesma forma que usaria uma dimensão ou métrica em um campo calculado.

Campo calculado com exemplo de parâmetro

Por exemplo, digamos que você queira ver as vendas estimadas permitindo que alguém insira um multiplicador das suas vendas do último trimestre.

Primeiro, crie o parâmetro que vai conter o multiplicador de estimativa:

1. Faça login no Looker Studio.
2. Edite sua fonte de dados.
3. No canto superior direito, clique em ADICIONAR UM PARÂMETRO.
4. Dê um nome a ele (por exemplo, "Multiplicador de estimativa").
5. Defina o Tipo de dado como Número.
6. Para simplificar, mantenha a opção Valores permitidos definida como Qualquer valor.
   É possível usar as outras opções para permitir que o usuário faça uma escolha em uma lista de valores ou restringir a entrada a um intervalo de valores.
7. Defina o Valor padrão como 1.
8. Clique em Salvar.
9. Para voltar à lista de campos da fonte de dados, clique em TODOS OS CAMPOS à esquerda.

Depois, crie o campo calculado:

1. No canto superior direito, clique em ADICIONAR UM CAMPO.
2. Dê um nome a ele (por exemplo, "Estimativa de vendas com parâmetro").
3. Na fórmula, multiplique o campo "Vendas" da sua fonte de dados pelo parâmetro Multiplicador de estimativa. Por exemplo, se a fonte de dados tiver um campo chamado Receita, insira:
   Receita * Multiplicador de estimativa.
4. Clique em Salvar.

Adicione um controle para coletar a entrada do usuário:

1. Edite ou crie um relatório.
2. Se necessário, adicione sua fonte de dados ao relatório.
3. Na parte de cima, clique em Adicionar um controle.
4. Selecione o controle Caixa de entrada.
   Com ele, você pode digitar valores de parâmetro diretamente. Com outros tipos de controle, é possível selecionar uma opção em uma lista, usar um controle deslizante ou ativar/desativar valores booleanos com uma caixa de seleção.
5. À direita, nas propriedades DADOS, adicione o parâmetro Multiplicador da estimativa criado anteriormente.

Por fim, veja o campo calculado parametrizado em um gráfico.

1. Na parte superior, clique em  Adicionar um gráfico.
2. Para simplificar, selecione Visão geral.
3. À direita, nas propriedades DADOS, adicione o campo calculado Estimativa de vendas com parâmetro como métrica.

Faça um teste:

1. No canto superior direito, clique em Vista.
2. Digite um número no controle do Multiplicador de estimativa e pressione Enter.
3. O valor na visão geral será alterado quando for multiplicado pelo valor inserido.

Usar um parâmetro em uma visualização

Você pode adicionar um parâmetro a um gráfico, assim como faria com uma dimensão ou métrica. Se você usar um parâmetro numérico como métrica, o valor dele será agregado.

Exibir / ocultar parâmetros em relatórios

Para mostrar ou ocultar os parâmetros que você criou em uma fonte de dados:

1. Edite sua fonte de dados.
2. Localize o parâmetro.
3. À direita do parâmetro, clique em Opções.
4. Selecione Mostrar (se o parâmetro estiver oculto) ou Ocultar (se o parâmetro estiver sendo mostrado).

Ao ocultar um parâmetro, ele é removido da lista de campos no painel Dados e corrompe todos os componentes que o utilizam. Se o parâmetro for usado em um campo calculado, a fórmula vai aplicar o valor padrão.

Copiar um componente com parâmetros

Fazer isso copia os valores de parâmetro conforme definido no painel de propriedades. É possível modificar os parâmetros da cópia editando o componente.

Corrigir parâmetros inválidos

Se a configuração do parâmetro mudar no conector, todos os gráficos que usam esses parâmetros podem ser interrompidos. Por exemplo, o desenvolvedor do conector pode remover a capacidade de substituir um valor de parâmetro, e o valor que você forneceu no relatório não retorna mais dados válidos. Nesse caso, você verá uma mensagem de erro em todos os gráficos afetados por essa alteração.

Para corrigir isso, localize o componente que contém o parâmetro "now-invalid". Na seção Parâmetros das propriedades DADOS desse componente, clique em Corrigir valores inválidos.

Lembre-se de que os parâmetros podem ser definidos no nível do relatório, da página e do grupo, bem como em gráficos individuais. Portanto, talvez seja necessário procurar em vários lugares para localizar e corrigir o erro.

Recursos relacionados

Sobre os controles