Criar dashboard

Versão 3.1.23.4

Criar um novo painel

Cria um novo objeto de painel e retorna os detalhes do painel recém-criado.

Title e space_id são campos obrigatórios. Space_id precisa conter o código de um espaço existente. O title do painel precisa ser exclusivo no espaço em que reside.

Se você receber uma resposta de erro 422 ao criar um painel, verifique o corpo da resposta para informações sobre exatamente quais campos estão ausentes ou contêm dados inválidos.

É possível atualizar um painel existente com update_dashboard().

É possível excluir permanentemente um painel existente usando delete_dashboard().

Solicitação

POST /dashboards
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
Painel
Expandir definição do painel...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
content_favorite_id [código_de_conteúdo]
integer
ID do conteúdo favorito
Content_metadata_id
integer
ID dos metadados de conteúdo
Descrição
string
Descrição
escondida
booleano
Está oculto
id
string
ID exclusivo
modelo
Modelo
fuso horário_de_consulta
string
Fuso horário em que o Painel de controle será executado por padrão.
somente leitura
booleano
É somente leitura
intervalo_de_atualização
string
Intervalo de atualização, como uma frase de duração de tempo como "2 horas e 30 minutos". Um número sem unidades de tempo será interpretado como segundos inteiros.
intervalo_de_atualização_para_i
integer
Intervalo de atualização em milissegundos
pasta
pasta.
title
string
Título do dashboard
user_id
integer
ID do usuário
lesma
string
Lesma dos metadados de conteúdo
visualizador_preferido
string
A rota preferencial para visualizar este painel (por exemplo, painéis ou painéis-próximo)
espaço
Espaço
alerta_sincronização_com_painel_filtro_ativado
booleano
Permite que os alertas fiquem em sincronia com as alterações do filtro do painel
cor_do_plano de fundo
string
Cor do plano de fundo
criado_em
string
Hora em que o painel foi criado.
crossfilter_enabled
booleano
Ativa o cruzamento de filtros em painéis: disponível apenas em painéis de controle (beta)
painéis_elementos
painéis_filtros
painéis_de_painel
excluído
booleano
Se um painel é "soft" excluído.
excluído_em
string
Hora em que o "Painel" foi excluído.
código_de_exclusão
integer
ID do usuário que "soft" excluiu o painel.
editar_uri
string
Caminho relativo do URI do arquivo LookML para editar o painel (somente painel LookML).
enable_viz_full_screen
booleano
Permitir visualizações no modo de tela cheia
contagem_favorita
integer
Número de vezes favorito
bar_filtros_recolhidos
booleano
Define o estado padrão da barra de filtros para ser recolhido ou aberto
filtro_local_superior
booleano
Define o estado padrão do local dos filtros como superior(verdadeiro) ou direito(falso).
last_accessed_at
string
Hora em que o painel foi acessado pela última vez
last_viewed_at
string
Hora da última visualização na IU da Web do Looker
atualizado em
string
Hora em que o painel foi atualizado pela última vez.
ID_do_último_atualizado
integer
ID do usuário que atualizou o painel recentemente.
last_updater_name
string
Nome do usuário que atualizou o painel recentemente.
nome_do_usuário
string
Nome do usuário que criou o painel.
load_configuration [configuração_de_carregamento]
string
que controla como o carregamento do painel ocorrerá.
lookml_link_id
string
Vincula esse painel a um determinado painel do LookML, de modo que chamar uma operação de **sincronização** nesse painel do LookML atualiza o painel para que fique correspondente.
barra_de_filtros_do_programa
booleano
Mostrar barra de filtros. **Observação de segurança:** esta propriedade afeta apenas a aparência *cosmética* do painel, não a capacidade do usuário de acessar dados. Ocultar a barra de filtros **NÃO** impede que os usuários alterem os filtros de outras formas. Para saber como configurar políticas de controle de acesso seguro a dados, consulte [Controlar o acesso do usuário aos dados](https://cloud.google.com/looker/docs/r/api/control-access)
título_programa
booleano
Mostrar título
ID do espaço
string
Código do espaço
ID da pasta
string
ID da pasta
texto_tile_text_color
string
Cor do texto em blocos de texto
cor_do_plano de fundo_do_bloco
string
Cor do plano de fundo do bloco
cor_do_texto_do_bloco
string
Cor do texto do bloco
cor_do_título
string
Cor do título
contagem_de_visualizações
integer
Número de visualizações na IU da Web do Looker
aparência
Configurações visuais do painel aplicáveis apenas a painéis-próximos (beta)

Resposta

200: Painel

Tipo de dados
Descrição
(objeto)
pode
objeto
Operações que o usuário atual pode realizar neste objeto
content_favorite_id [código_de_conteúdo]
integer
ID do conteúdo favorito
Content_metadata_id
integer
ID dos metadados de conteúdo
Descrição
string
Descrição
escondida
booleano
Está oculto
id
string
ID exclusivo
modelo
Modelo
Expandir a definição do LookModel...
id
string
ID do modelo
Rótulo
string
Rótulo do modelo
fuso horário_de_consulta
string
Fuso horário em que o Painel de controle será executado por padrão.
somente leitura
booleano
É somente leitura
intervalo_de_atualização
string
Intervalo de atualização, como uma frase de duração de tempo como "2 horas e 30 minutos". Um número sem unidades de tempo será interpretado como segundos inteiros.
intervalo_de_atualização_para_i
integer
Intervalo de atualização em milissegundos
pasta
pasta.
Expandir a definição de FolderBase...
nome
string
Nome exclusivo
parent_id
string
ID do pai. Se o ID pai for nulo, é uma entrada de nível raiz
id
string
ID exclusivo
Content_metadata_id
integer
ID dos metadados de conteúdo
criado_em
string
Hora em que a pasta foi criada
ID do criador
integer
User ID do criador
contagem_filho
integer
Contagem de crianças
ID_externo
string
Código do incorporador se esta pasta foi gerada automaticamente como uma pasta compartilhada de incorporação via 'external_group_id' em um login de incorporação de SSO
is_embed
booleano
Pasta é uma pasta incorporada
raiz_integrada_compartilhada
booleano
Pasta é a pasta compartilhada incorporada como raiz
is_embed_users_root
booleano
Pasta é a pasta raiz incorporada de usuários
é_pessoal
booleano
Pasta é a pasta pessoal do usuário
is_personal_descendente
booleano
A pasta é descendente da pasta pessoal de um usuário
raiz_compartilhada
booleano
Pasta é a pasta compartilhada raiz
root_users_root
booleano
Pasta é a pasta raiz do usuário
pode
objeto
Operações que o usuário atual pode realizar neste objeto
title
string
Título do dashboard
user_id
integer
ID do usuário
lesma
string
Lesma dos metadados de conteúdo
visualizador_preferido
string
A rota preferencial para visualizar este painel (por exemplo, painéis ou painéis-próximo)
espaço
Espaço
Expandir definição do SpaceBase...
nome
string
Nome exclusivo
parent_id
string
ID do pai. Se o ID pai for nulo, é uma entrada de nível raiz
id
string
ID exclusivo
Content_metadata_id
integer
ID dos metadados de conteúdo
criado_em
string
Horário em que o espaço foi criado
ID do criador
integer
User ID do criador
contagem_filho
integer
Contagem de crianças
ID_externo
string
Código do incorporador se este espaço foi gerado automaticamente como um espaço compartilhado incorporado via "external_group_id" em um login de incorporação de SSO
is_embed
booleano
Um espaço é incorporado
raiz_integrada_compartilhada
booleano
Espaço é o espaço compartilhado incorporado da raiz
is_embed_users_root
booleano
Espaço é o espaço raiz incorporado dos usuários
é_pessoal
booleano
O espaço pessoal do usuário
is_personal_descendente
booleano
O espaço é descendente do espaço pessoal de um usuário
raiz_compartilhada
booleano
Espaço é a raiz compartilhada
root_users_root
booleano
Espaço é o espaço raiz do usuário
pode
objeto
Operações que o usuário atual pode realizar neste objeto
alerta_sincronização_com_painel_filtro_ativado
booleano
Permite que os alertas fiquem em sincronia com as alterações do filtro do painel
cor_do_plano de fundo
string
Cor do plano de fundo
criado_em
string
Hora em que o painel foi criado.
crossfilter_enabled
booleano
Ativa o cruzamento de filtros em painéis: disponível apenas em painéis de controle (beta)
painéis_elementos
Expandir a definição do DashboardElement...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
corpo_texto
string
Texto do corpo do bloco de texto
corpo_texto_como_html
string
Texto do bloco de texto como HTML
ID do painel
string
ID do painel
editar_uri
string
Caminho relativo do URI do arquivo LookML para editar o elemento do painel (somente painel LookML).
id
string
ID exclusivo
tenham a mesma aparência
LookWithQuery (link em inglês)
Look
Expandir a definição de LookWithQuery...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
Content_metadata_id
integer
ID dos metadados de conteúdo
id
integer
ID exclusivo
title
string
Título do visual
content_favorite_id [código_de_conteúdo]
integer
ID do conteúdo favorito
criado_em
string
Hora em que a aparência foi criada.
excluído
booleano
Indica se um visual foi excluído de maneira reversível.
excluído_em
string
Hora em que a aparência foi excluída.
código_de_exclusão
integer
ID do usuário que excluiu a aparência.
Descrição
string
Descrição
URL_incorporado
string
Incorporar URL
excel_file_url
string
URL do arquivo do Excel
contagem_favorita
integer
Número de vezes favorito
Planilha_de_planilhas
string
Fórmula da planilha do Google
imagem_incorporada_url
string
URL de incorporação de imagem
is_run_on_load
booleano
executar consulta automaticamente quando a visualização tiver sido visualizada
last_accessed_at
string
Hora em que o acesso foi acessado pela última vez por qualquer usuário
ID_do_último_atualizado
integer
ID do usuário que atualizou a aparência pela última vez.
last_viewed_at
string
Hora da última visualização na IU da Web do Looker
modelo
Modelo
público
booleano
É público
lesma_pública
string
Lesma pública
URL_público
string
URL público
ID da consulta
integer
ID da consulta
URL_curto
string
URL curto
pasta
Pasta desta aparência
ID da pasta
string
ID da pasta
atualizado em
string
Hora em que a aparência foi atualizada.
user_id
integer
ID do usuário
contagem_de_visualizações
integer
Número de visualizações na IU da Web do Looker
user
UserIdOnly (em inglês)
(USO SUSPENSO) Usuário
ID do espaço
string
ID do espaço
espaço
Espaço deste visual
consulta
Consulta
url
string
URL
look_id
string
ID da aparência
lookml_link_id
string
ID do link LookML
código_do_resultado_da_mesclagem
string
ID do resultado da mesclagem
display_display
string
Exibição da nota
estado_da_nota
string
Estado da nota
texto_da_nota
string
Texto da nota
nota_texto_como_html
string
Nota em formato HTML
consulta
Consulta
Expandir definição da consulta...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
integer
ID exclusivo
modelo
string
Modelo
visualização
string
Explorar nome
campos
string[]
pivôs
string[]
fill_fields
string[]
filters
objeto
Filtros
expressao_de_filtro
string
Expressão de filtro
classificações
string[]
limite
string
Limite
limit_column
string
Limite de colunas
total
booleano
Total
total da linha
string
Total bruto
subtotais
string[]
vis_config
objeto
Propriedades de configuração da visualização. Essas propriedades geralmente são opacas e diferem com base no tipo de visualização usada. Não há um conjunto especificado de chaves permitidas. Os valores podem ser qualquer tipo compatível com JSON. Uma chave de "tipo" com um valor de string geralmente está presente e é usada pelo Looker para determinar qual visualização será exibida. As visualizações ignoram as propriedades vis_config desconhecidas.
configuração_do_filtro
objeto
O valor de "filter_config" representa o estado da IU do filtro na página de exploração de uma determinada consulta. Ao executar uma consulta por meio da IU do Looker, esse parâmetro tem precedência sobre "filtros". Ao criar uma consulta ou modificar uma consulta existente, "filter_config" deve ser definido como nulo. Definir como qualquer outro valor pode causar um comportamento inesperado de filtragem. O formato deve ser considerado opaco.
_UI_sections visíveis
string
Seções de IU visíveis
lesma
string
Slug
dynamic_fields
string
Campos dinâmicos
client_id
string
ID do cliente: usado para gerar URLs de exploração encurtados. Se definido pelo cliente, deve ser uma sequência alfanumérica única de 22 caracteres. Caso contrário, será gerado um.
url_de_compartilhamento
string
Compartilhar URL
url_de_compartilhamento_expandido
string
URL de compartilhamento expandido
url
string
URL expandido
fuso horário_de_consulta
string
Fuso horário da consulta
has_table_calculations
booleano
Tem cálculos de tabela
runtime
number
(OBSOLETO) Tempo de execução (obsoleto)
ID da consulta
integer
ID da consulta
intervalo_de_atualização
string
Intervalo de atualização
intervalo_de_atualização_para_i
integer
Atualizar intervalo como número inteiro
criador_de_resultados
Dados sobre o criador de resultados.
Expandir a definição de ResultMakerWithIdVisConfigAndDynamicFields...
id
integer
ID exclusivo.
dynamic_fields
string
String JSON de informações de campo dinâmico.
filtráveis
classificações
string[]
código_do_resultado_da_mesclagem
string
ID do resultado da mesclagem se este for um merge_result.
total
booleano
Total da consulta constituinte, consulta ou mesclagem de consulta
ID da consulta
integer
ID da consulta, se for uma consulta.
id_consulta_sql
string
ID da consulta SQL, se for uma consulta do SQL Runner
consulta
Consulta
vis_config
objeto
Configuração de visualização da consulta constituinte ou Mesclar consulta.
código_do_produto_de_resultado
integer
ID da entrada ResultMakerLookup.
texto do subtítulo
string
Texto do subtítulo do bloco do texto
title
string
Título do elemento do painel
título_oculto
booleano
Se o título está oculto
texto_título
string
Título do bloco de texto
tipo
string
Tipo
contagem_de_alertas
integer
Contagem de alertas associados a um elemento do painel
rich_content_json
string
JSON com todas as propriedades necessárias para elementos ricos de editor e botões
título_texto_como_html
string
Texto do título do bloco de texto como HTML
subtitle_text_as_html
string
Texto do subtítulo do bloco de texto como HTML
painéis_filtros
Expandir a definição do DashboardFilter...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID exclusivo
ID do painel
string
ID do painel
nome
string
Nome do filtro
title
string
Título do filtro
tipo
string
Tipo de filtro: um de data, número, string ou campo
default_value
string
Valor padrão do filtro
modelo
string
Modelo de filtro (obrigatório se type = campo)
explore
string
Explorar filtro (obrigatório se type = campo)
dimensão
string
Dimensão do filtro (obrigatório se type = campo)
campo
objeto
Informações do campo
linha
integer
Ordem de exibição desse filtro em relação a outros filtros
escutas_para_filtros
string[]
permitir_vários_valores
booleano
Se o filtro permite vários valores de filtro (descontinuado na versão mais recente dos painéis)
obrigatório
booleano
Se o filtro exige um valor para executar o painel
ui_config
objeto
A configuração visual desse filtro. Usado para configurar a aparência da IU desse filtro.
painéis_de_painel
Expandir a definição do DashboardLayout...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID exclusivo
ID do painel
string
ID do painel
tipo
string
Tipo
ativo
booleano
Está ativo
coluna_largura
integer
Largura da coluna
largura
integer
Largura
excluído
booleano
Se o layout do painel é excluído ou não.
título_do_painel
string
Título extraído do painel que este layout representa.
painéis_layout_components
Expandir a definição de DashboardLayoutComponent...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID exclusivo
ID do painel_de_painel
string
ID do layout do painel
painel_element_id [código_do_elemento_do_painel]
string
ID do elemento do painel
linha
integer
Linha
coluna
integer
Coluna
largura
integer
Largura
altura
integer
Altura
excluído
booleano
Se o componente de layout do painel é excluído
título_elemento
string
Título do elemento do painel, extraído do elemento do painel.
elemento_título_oculto
booleano
Se o título do elemento do painel é exibido ou não.
tipo_vis
string
Tipo de visualização, extraído do vis_config de uma consulta
excluído
booleano
Se um painel é "soft" excluído.
excluído_em
string
Hora em que o "Painel" foi excluído.
código_de_exclusão
integer
ID do usuário que "soft" excluiu o painel.
editar_uri
string
Caminho relativo do URI do arquivo LookML para editar o painel (somente painel LookML).
enable_viz_full_screen
booleano
Permitir visualizações no modo de tela cheia
contagem_favorita
integer
Número de vezes favorito
bar_filtros_recolhidos
booleano
Define o estado padrão da barra de filtros para ser recolhido ou aberto
filtro_local_superior
booleano
Define o estado padrão do local dos filtros como superior(verdadeiro) ou direito(falso).
last_accessed_at
string
Hora em que o painel foi acessado pela última vez
last_viewed_at
string
Hora da última visualização na IU da Web do Looker
atualizado em
string
Hora em que o painel foi atualizado pela última vez.
ID_do_último_atualizado
integer
ID do usuário que atualizou o painel recentemente.
last_updater_name
string
Nome do usuário que atualizou o painel recentemente.
nome_do_usuário
string
Nome do usuário que criou o painel.
load_configuration [configuração_de_carregamento]
string
que controla como o carregamento do painel ocorrerá.
lookml_link_id
string
Vincula esse painel a um determinado painel do LookML, de modo que chamar uma operação de **sincronização** nesse painel do LookML atualiza o painel para que fique correspondente.
barra_de_filtros_do_programa
booleano
Mostrar barra de filtros. **Observação de segurança:** esta propriedade afeta apenas a aparência *cosmética* do painel, não a capacidade do usuário de acessar dados. Ocultar a barra de filtros **NÃO** impede que os usuários alterem os filtros de outras formas. Para saber como configurar políticas de controle de acesso seguro a dados, consulte [Controlar o acesso do usuário aos dados](https://cloud.google.com/looker/docs/r/api/control-access)
título_programa
booleano
Mostrar título
ID do espaço
string
Código do espaço
ID da pasta
string
ID da pasta
texto_tile_text_color
string
Cor do texto em blocos de texto
cor_do_plano de fundo_do_bloco
string
Cor do plano de fundo do bloco
cor_do_texto_do_bloco
string
Cor do texto do bloco
cor_do_título
string
Cor do título
contagem_de_visualizações
integer
Número de visualizações na IU da Web do Looker
aparência
Configurações visuais do painel aplicáveis apenas a painéis-próximos (beta)
Expandir a definição de DashboardAppearance...
margens_da_página_da_página
integer
Largura da margem da página (lateral)
cor_do_plano de fundo da página
string
Cor do plano de fundo do painel
alinhamento_título_do_bloco
string
Alinhamento de título em blocos do painel
espaço_entre_blocos
integer
Espaço entre os blocos
cor_do_plano de fundo_do_bloco
string
Cor do plano de fundo para blocos
sombra_do_bloco
booleano
Sombra de bloco ativada/desativada
cor_da_chave
string
Cor da chave

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

409: recurso já existe

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

422: erro de validação

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
Expandir a definição de ValidationErrorDetail...
campo
string
Campo com erro
código
string
Código do erro
mensagem
string
Mensagem de erro
url_da_documentação
string
Link da documentação
url_da_documentação
string
Link da documentação

429: Solicitações demais

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

Examples