descrição (para análises detalhadas)

Esta página se refere ao parâmetro description, que faz parte de uma análise detalhada.

description também pode ser usado como parte de um campo, conforme descrito na página de documentação do parâmetro description (para campos).

description também pode ser usado como parte de um painel, conforme descrito na página de documentação Parâmetros do painel.

Uso

explore: explore_name {
  description: "Description I Want"
}

Hierarquia Arquivo de modelo explore description

Valor padrão Nenhum Aceita Uma string

Definição

O description permite adicionar informações sobre a Análise detalhada à UI, para que os usuários tenham mais informações ao criar consultas de Análise detalhada. Por exemplo, este é um parâmetro description:

explore: order_items {
  description: "Based on the individual items that comprise customer orders"
}

Se uma description for adicionada a uma análise detalhada, os usuários poderão ver a descrição passando o cursor sobre o ícone de informações ao lado do nome da análise na parte de cima do seletor de campo.

Os usuários também podem conferir uma descrição passando o cursor sobre o mesmo ícone de informações na lista suspensa de análises detalhadas.

Se você não adicionar explicitamente uma description a uma análise, nenhuma descrição será mostrada.

Exemplos

Adicione uma descrição a uma análise chamada Usuário:

explore: user {
  description: "All customer users, staff users are excluded"
}