Criar plano programado

Versão 4.0.23.2

Criar um plano programado

Crie um plano programado para renderizar uma aparência ou um painel em uma programação recorrente.

Para criar um plano programado, você PRECISA fornecer valores para os seguintes campos: name e look_id, dashboard_id, lookml_dashboard_id ou query_id e cron_tab ou datagroup e pelo menos um scheduled_plan_destination

Um plano programado PRECISA ter pelo menos um scheduled_plan_destination definido.

Quando look_id estiver definido, require_no_results, require_results e require_change serão todos obrigatórios.

Se create_scheduled_plan falhar com um erro 422, verifique as mensagens de erro na resposta que explicam exatamente quais campos estão ausentes ou os valores são incompatíveis.

As consultas que fornecem os dados para a aparência ou o painel são executadas no contexto da conta de usuário que possui o plano programado.

Quando run_as_recipient é false ou não é especificado, as consultas que fornecem os dados para a aparência ou o painel são executadas no contexto da conta do usuário que possui o plano programado.

Quando run_as_recipient é true e todos os destinatários de e-mail são contas de usuário do Looker, as consultas são executadas no contexto de cada destinatário. Portanto, destinatários diferentes podem ver dados diferentes da mesma renderização programada de um painel ou visualização. Veja mais detalhes em Executar como destinatário.

Os administradores podem criar e modificar planos programados em nome de outros usuários especificando um ID de usuário. Os usuários que não são administradores não podem criar ou modificar planos programados por ou para outros usuários.

Permissões de e-mail:

Para ver detalhes sobre as permissões necessárias para programar a entrega de e-mails e as salvaguardas oferecidas pelo Looker contra o envio de e-mails não autorizados, consulte Lista de permissões de domínios de e-mail para aparências programadas.

Formatos de destino do plano programado

Os destinos do plano programado precisam especificar o formato de dados a ser produzido e enviado ao destino.

Formatos:

formato Descrição
json Um objeto JSON com uma propriedade data, que contém uma matriz de objetos JSON, um por linha. Nenhum metadado.
json_detail [informações_técnicas_do_json] Dados de linha mais metadados que descrevem os campos, tabelas dinâmicas, cálculos de tabela e outros aspectos da consulta
in-line_json Igual ao formato JSON, exceto pelo fato de a propriedade data ser uma string que contém dados de linha com escape JSON. As propriedades adicionais descrevem a operação de dados. Esse formato é usado principalmente para enviar dados para web hooks de modo que o web hook não tenha que recodificar os dados da linha JSON para transmiti-los ao seu destino final.
csv Valores separados por vírgula com um cabeçalho
.txt Valores separados por tabulação com um cabeçalho
html HTML simples
xlsx Planilha do MS Excel
wysiwyg_pdf Painel renderizado em um layout em blocos para produzir um documento PDF
montado_pdf Painel renderizado em um layout de coluna única para produzir um documento PDF
Wysiwyg Painel renderizado em um layout em blocos para produzir uma imagem PNG

Os formatos válidos variam de acordo com o tipo de destino e o objeto de origem. wysiwyg_pdf é válido apenas para painéis, por exemplo.

Solicitação

POST /scheduled_plans
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
Plano programado
Expandir definição ScheduledPlan...
nome
string
Nome do plano programado
user_id
string
ID do usuário proprietário do plano programado
executar_como_destinatário
booleano
Se a programação é executada como destinatário (aplicável somente a destinatários de e-mail)
ativado
booleano
Se o ScheduledPlan está ativado
look_id
string
ID de uma aparência
ID do painel
string
ID de um painel
lookml_dashboard_id
string
ID de um painel do LookML
string_de_filtros
string
String de consulta para executar a aparência ou o painel
painéis_filtros
string
(OBSOLETO) Alias para o campo filters_string
requer_resultados
booleano
A exibição deve ocorrer se a execução do painel ou a aparência retornar resultados
requer_não_resultados
booleano
A exibição deve ocorrer se a aparência do painel não retornar resultados
alterar_exigir
booleano
A entrega deve ocorrer se os dados tiverem mudado desde a última execução
enviar_todos_resultados
booleano
Executa uma consulta ilimitada e envia todos os resultados.
Crontab
string
Especificação do crontab no estilo Vixie quando executar
datagroup
string
Nome de um grupo de dados. Se especificado, será executado quando o grupo de dados for acionado (não pode ser usado com uma string cron)
timezone
string
Fuso horário para interpretar o crontab especificado (o padrão é o fuso horário da instância do Looker)
ID da consulta
string
ID da consulta
destination_plan_destination
run_once
booleano
Se o plano em questão precisa ser executado apenas uma vez (geralmente para testes).
links_incluir
booleano
Se links para o Looker devem ser incluídos neste ScheduledPlan
base_url_personalizada
string
Domínio de URL personalizado para a entidade programada
custom_url_params
string
Caminho de URL personalizado e parâmetros para a entidade programada
custom_url_label [rótulo_de_url_personalizado]
string
Rótulo de URL personalizado para a entidade programada
mostrar_URL_personalizado
booleano
Se o link personalizado será mostrado em vez do link padrão
pdf_paper_size
string
O tamanho do papel no qual o PDF deve ser formatado para caber. Os valores válidos são: "letter", "legal", "tabloid", "a0", "a1", "a2", "a3", "a4", "a5".
pdf_paisagem
booleano
Se o PDF deve ser formatado para a orientação paisagem
incorporar
booleano
Se esta programação está em um contexto de incorporação ou não
tema_de_cor
string
Esquema de cores do painel, se aplicável
long_tables
booleano
Se a visualização da tabela deve ou não ser expandida
largura_da_tabela_in-line
integer
A largura do pixel em que renderizamos as visualizações da tabela inline
id
string
ID exclusivo
criado_em
string
Data e hora em que o ScheduledPlan foi criado
atualizado em
string
Data e hora em que o ScheduledPlan foi atualizado pela última vez
title
string
Título
user
UserPublic (em inglês)
Usuário que é o proprietário deste ScheduledPlan
next_run_at
string
Quando o ScheduledPlan será executado novamente (nulo se for executado uma vez)
last_run_at
string
Quando o ScheduledPlan foi executado pela última vez
pode
objeto
Operações que o usuário atual pode realizar neste objeto

Resposta

200: Plano programado

Tipo de dados
Descrição
(objeto)
nome
string
Nome do plano programado
user_id
string
ID do usuário proprietário do plano programado
executar_como_destinatário
booleano
Se a programação é executada como destinatário (aplicável somente a destinatários de e-mail)
ativado
booleano
Se o ScheduledPlan está ativado
look_id
string
ID de uma aparência
ID do painel
string
ID de um painel
lookml_dashboard_id
string
ID de um painel do LookML
string_de_filtros
string
String de consulta para executar a aparência ou o painel
painéis_filtros
string
(OBSOLETO) Alias para o campo filters_string
requer_resultados
booleano
A exibição deve ocorrer se a execução do painel ou a aparência retornar resultados
requer_não_resultados
booleano
A exibição deve ocorrer se a aparência do painel não retornar resultados
alterar_exigir
booleano
A entrega deve ocorrer se os dados tiverem mudado desde a última execução
enviar_todos_resultados
booleano
Executa uma consulta ilimitada e envia todos os resultados.
Crontab
string
Especificação do crontab no estilo Vixie quando executar
datagroup
string
Nome de um grupo de dados. Se especificado, será executado quando o grupo de dados for acionado (não pode ser usado com uma string cron)
timezone
string
Fuso horário para interpretar o crontab especificado (o padrão é o fuso horário da instância do Looker)
ID da consulta
string
ID da consulta
destination_plan_destination
Expandir definição ScheduledPlanDestination...
id
string
ID exclusivo
ID do plano programado
string
ID de um dos seus planos programados
formato
string
O formato de dados a ser enviado para o destino especificado. Os formatos compatíveis variam de acordo com o destino, mas incluem: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf" e "wysiwyg_png".
aplicar_formatação
booleano
Os valores são formatados? (contendo símbolos de moeda, separadores de dígitos etc.
apply_vis
booleano
Indica se as opções de visualização são aplicadas aos resultados.
address
string
Endereço do destinatário. Para e-mail, por exemplo, "usuario@example.com". Para webhooks, por exemplo, "https://examle.domain/path". Para o Amazon S3, por exemplo, "s3://bucket-name/path/". Para SFTP, por exemplo, "sftp://host-name/path/".
looker_recipient
booleano
Se o destinatário é um usuário do Looker na instância atual (aplicável somente a destinatários de e-mail)
tipo
string
Tipo de endereço ("e-mail", "webhook", "s3" ou "sftp")
parâmetros
string
Objeto JSON que contém parâmetros para programação externa. Para o Amazon S3, isso requer chaves e valores para access_key_id e região. Para SFTP, isso exige uma chave e um valor de nome de usuário.
parâmetros_secretos
string
Objeto JSON (somente gravação) contendo parâmetros secretos para programação externa. Para o Amazon S3, isso requer uma chave e um valor para secret_access_key. Para SFTP, isso exige uma chave e um valor para a senha.
mensagem
string
Mensagem opcional a ser incluída nos e-mails programados
run_once
booleano
Se o plano em questão precisa ser executado apenas uma vez (geralmente para testes).
links_incluir
booleano
Se links para o Looker devem ser incluídos neste ScheduledPlan
base_url_personalizada
string
Domínio de URL personalizado para a entidade programada
custom_url_params
string
Caminho de URL personalizado e parâmetros para a entidade programada
custom_url_label [rótulo_de_url_personalizado]
string
Rótulo de URL personalizado para a entidade programada
mostrar_URL_personalizado
booleano
Se o link personalizado será mostrado em vez do link padrão
pdf_paper_size
string
O tamanho do papel no qual o PDF deve ser formatado para caber. Os valores válidos são: "letter", "legal", "tabloid", "a0", "a1", "a2", "a3", "a4", "a5".
pdf_paisagem
booleano
Se o PDF deve ser formatado para a orientação paisagem
incorporar
booleano
Se esta programação está em um contexto de incorporação ou não
tema_de_cor
string
Esquema de cores do painel, se aplicável
long_tables
booleano
Se a visualização da tabela deve ou não ser expandida
largura_da_tabela_in-line
integer
A largura do pixel em que renderizamos as visualizações da tabela inline
id
string
ID exclusivo
criado_em
string
Data e hora em que o ScheduledPlan foi criado
atualizado em
string
Data e hora em que o ScheduledPlan foi atualizado pela última vez
title
string
Título
user
UserPublic (em inglês)
Usuário que é o proprietário deste ScheduledPlan
Expandir definição UserPublic...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID exclusivo
first_name
string
Nome
last_name
string
Sobrenome
display_name
string
Nome completo para exibição (disponível apenas se first_name e last_name estiverem definidos)
URL_do_ avatar
string
URL da imagem de avatar (pode ser genérico)
url
string
Link para obter este item
next_run_at
string
Quando o ScheduledPlan será executado novamente (nulo se for executado uma vez)
last_run_at
string
Quando o ScheduledPlan foi executado pela última vez
pode
objeto
Operações que o usuário atual pode realizar neste objeto

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