Crea piano pianificato

Versione 3.1.23.2

Crea un piano pianificato

Crea un piano pianificato per visualizzare un Look o una dashboard in base a una pianificazione ricorrente.

Per creare un piano pianificato, DEVI fornire valori per i seguenti campi: name e look_id, dashboard_id, lookml_dashboard_id o query_id e cron_tab o datagroup e almeno un destinazione_piano_pianificato

Un piano pianificato DEVE avere definito almeno uno schedule_plan_destination.

Quando look_id è impostato, sono richiesti require_no_results, require_results e require_change.

Se create_scheduled_plan restituisce un errore 422, assicurati di leggere i messaggi di errore nella risposta, che spiegano esattamente i campi mancanti o i valori incompatibili.

Le query che forniscono i dati per l'aspetto o la dashboard vengono eseguite nel contesto dell'account utente proprietario del piano pianificato.

Quando run_as_recipient è false o non è specificato, le query che forniscono i dati per l'aspetto o la dashboard vengono eseguite nel contesto dell'account utente proprietario del piano pianificato.

Quando run_as_recipient è impostato su true e tutti i destinatari delle email sono account utente Looker, le query vengono eseguite nel contesto di ciascun destinatario, quindi destinatari diversi potrebbero visualizzare dati diversi dello stesso rendering pianificato di un look o di una dashboard. Per maggiori dettagli, vedi Esegui come destinatario.

Gli amministratori possono creare e modificare i piani pianificati per conto di altri utenti specificando un ID utente. Gli utenti non amministratori non possono creare o modificare piani pianificati da o per altri utenti.

Autorizzazioni email:

Per informazioni dettagliate sulle autorizzazioni necessarie per programmare la consegna alle email e le misure di salvaguardia Looker offre misure di protezione dall'invio a destinazioni email non autorizzate, consulta la sezione Lista consentita dominio email per look pianificati.

Formati di destinazione dei piani pianificati

Le destinazioni dei piani pianificati devono specificare il formato dei dati da inviare e inviare alla destinazione.

Formati:

formato Descrizione
json Un oggetto JSON contenente una proprietà data contenente un array di oggetti JSON, uno per riga. Nessun metadati.
json_dettaglio Dati sulle righe più metadati che descrivono i campi, i pivot, le tabelle dei calcoli e altri aspetti della query
JSON_in linea Uguale al formato JSON, tranne per il fatto che la proprietà data è una stringa contenente dati di riga con escape JSON. Proprietà aggiuntive descrivono l'operazione relativa ai dati. Questo formato viene utilizzato principalmente per inviare dati agli webhook in modo che non sia necessario ricodificare i dati delle righe JSON per trasmetterli alla destinazione finale.
csv Valori separati da virgola con un'intestazione
file txt Valori separati da tabulazione con un'intestazione
html HTML semplice
xlsx Foglio di lavoro MS Excel
wysiwyg_pdf Dashboard visualizzata con un layout a mosaico per produrre un documento PDF
pdf_assembrato Dashboard visualizzata in un layout a colonna singola per produrre un documento PDF
Logo wysiwyg_png Dashboard visualizzata in un layout a mosaico per produrre un'immagine PNG

I formati validi variano in base al tipo di destinazione e all'oggetto di origine. wysiwyg_pdf è valido solo per le dashboard, ad esempio.

Richiesta

POST /scheduled_plans
Tipo di dati
Descrizione
Richiesta
HTTPRequest
body
HTTPBody
Espandi definizione HTTPBody...
body
Piano pianificato
Espandi definizione PianificaPlan...
name
string
Nome di questo piano pianificato
ID_utente
integer
ID utente proprietario di questo piano pianificato
run_as_recipient
boolean
Indica se la pianificazione viene eseguita come destinatario (applicabile solo per i destinatari dell'email)
abilitato
boolean
Se il PianificaPlan è abilitato
look_id
integer
ID di un look
ID_dashboard
integer
ID di una dashboard
lookml_dashboard_id
string
ID di una dashboard LookML
stringa_filtri
string
Stringa di query con cui eseguire l'aspetto o la dashboard
filtri_dashboard
string
(DEPRECATO) Alias per il campo filter_string
risultati_richiesti
boolean
La pubblicazione avviene se viene eseguita la dashboard o se vengono restituiti risultati
request_no_results
boolean
La pubblicazione avviene se l'aspetto della dashboard non restituisce risultati.
richiesta_modifica
boolean
La consegna deve avvenire se i dati sono cambiati dall'ultima esecuzione
invia_tutti_i_risultati
boolean
Eseguirà una query illimitata e invierà tutti i risultati.
crontab
string
Specifica Vixie-Style crontab quando eseguire
gruppo di dati
string
Nome di un gruppo di dati; se specificato, verrà eseguito quando il gruppo di dati è stato attivato (non può essere utilizzato con la stringa cron)
fuso orario
string
Fuso orario per l'interpretazione della crontab specificata (il valore predefinito è il fuso orario dell'istanza di Looker)
id_query
string
ID query
destinazione_piano_pianificata
run_once
boolean
Indica se il piano in questione deve essere eseguito una sola volta (di solito per i test)
includi_link
boolean
Indica se i link per tornare a Looker devono essere inclusi in questo PianificaPlan
url_base_personalizzato
string
Dominio URL personalizzato per l'entità pianificata
parametri_url_personalizzati
string
Percorso e parametri dell'URL personalizzato per l'entità pianificata
etichetta_url_personalizzata
string
Etichetta URL personalizzata per l'entità pianificata
url_programma_personalizzato
boolean
Se mostrare di nuovo il link personalizzato anziché il link standard
pdf_whitepaper_size
string
Il formato della carta in cui deve essere formattato il PDF. I valori validi sono: "lettera", "legal", "tabloid", "a0", "a1", "a2", "a3", "a4", "a5".
pdf_orizzontale
boolean
Indica se il PDF deve essere formattato per l'orientamento orizzontale.
incorporamento
boolean
Indica se la pianificazione si trova in un contesto di incorporamento o meno
tema_colore
string
Combinazione di colori della dashboard, se applicabile
tabelle_lunghe
boolean
Indica se espandere o meno la visualizzazione della tabella a lunghezza intera
larghezza_tabella_inline
integer
La larghezza in pixel della visualizzazione delle tabelle in linea
id
integer
ID univoco
creata_alle
string
Data e ora in cui è stato creato PianificaPlan
aggiornato_in
string
Data e ora dell'ultimo aggiornamento di PianificaPlan
title
string
Title
user
Utente proprietario di questo PianificaPlan
prossima_esecuzione_alle
string
Alla prossima esecuzione di PianificaPlan (null se eseguita una volta)
ultima_esecuzione_alle
string
Quando è stata eseguita l'ultima esecuzione di PianificaPlan
può
oggetto
Operazioni che l'utente corrente può eseguire su questo oggetto

Risposta

200: piano pianificato

Tipo di dati
Descrizione
(oggetto)
name
string
Nome di questo piano pianificato
ID_utente
integer
ID utente proprietario di questo piano pianificato
run_as_recipient
boolean
Indica se la pianificazione viene eseguita come destinatario (applicabile solo per i destinatari dell'email)
abilitato
boolean
Se il PianificaPlan è abilitato
look_id
integer
ID di un look
ID_dashboard
integer
ID di una dashboard
lookml_dashboard_id
string
ID di una dashboard LookML
stringa_filtri
string
Stringa di query con cui eseguire l'aspetto o la dashboard
filtri_dashboard
string
(DEPRECATO) Alias per il campo filter_string
risultati_richiesti
boolean
La pubblicazione avviene se viene eseguita la dashboard o se vengono restituiti risultati
request_no_results
boolean
La pubblicazione avviene se l'aspetto della dashboard non restituisce risultati.
richiesta_modifica
boolean
La consegna deve avvenire se i dati sono cambiati dall'ultima esecuzione
invia_tutti_i_risultati
boolean
Eseguirà una query illimitata e invierà tutti i risultati.
crontab
string
Specifica Vixie-Style crontab quando eseguire
gruppo di dati
string
Nome di un gruppo di dati; se specificato, verrà eseguito quando il gruppo di dati è stato attivato (non può essere utilizzato con la stringa cron)
fuso orario
string
Fuso orario per l'interpretazione della crontab specificata (il valore predefinito è il fuso orario dell'istanza di Looker)
id_query
string
ID query
destinazione_piano_pianificata
Espandi definizione PianificaPlanDestination...
id
integer
ID univoco
ID_piano_programmato
integer
ID di un piano pianificato di tua proprietà
formato
string
Il formato dei dati da inviare alla destinazione specificata. I formati supportati variano in base alla destinazione, ma includono: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png"
applica_formattazione
boolean
I valori sono formattati? (contiene simboli di valuta, separatori di cifre ecc.)
applica_vis
boolean
Indica se applicare le opzioni di visualizzazione ai risultati.
indirizzo
string
Indirizzo del destinatario. Per l'email, ad esempio "utente@example.com". Per i webhook, ad esempio "https://examle.domain/path". Per Amazon S3, ad esempio "s3://bucket-name/path/". Per l'SFTP, ad esempio "sftp-name/path/".
destinatario_looker
boolean
Se il destinatario è un utente Looker sull'istanza attuale (applicabile solo per i destinatari dell'email)
tipo
string
Tipo di indirizzo ("email", "hook web", "s3" o "sftp")
Parametri
string
Oggetto JSON contenente parametri per la pianificazione esterna. Per Amazon S3, sono richieste chiavi e valori per access_key_id e per la regione. Per l'SFTP, sono necessari una chiave e un valore per il nome utente.
parametri_secret
string
(Solo scrittura) Oggetto JSON contenente parametri segreti per la pianificazione esterna. Per Amazon S3, questo richiede una chiave e un valore per secret_access_key. Per l'SFTP, sono necessari una chiave e un valore per la password.
messaggio
string
Messaggio facoltativo da includere nelle email pianificate
run_once
boolean
Indica se il piano in questione deve essere eseguito una sola volta (di solito per i test)
includi_link
boolean
Indica se i link per tornare a Looker devono essere inclusi in questo PianificaPlan
url_base_personalizzato
string
Dominio URL personalizzato per l'entità pianificata
parametri_url_personalizzati
string
Percorso e parametri dell'URL personalizzato per l'entità pianificata
etichetta_url_personalizzata
string
Etichetta URL personalizzata per l'entità pianificata
url_programma_personalizzato
boolean
Se mostrare di nuovo il link personalizzato anziché il link standard
pdf_whitepaper_size
string
Il formato della carta in cui deve essere formattato il PDF. I valori validi sono: "lettera", "legal", "tabloid", "a0", "a1", "a2", "a3", "a4", "a5".
pdf_orizzontale
boolean
Indica se il PDF deve essere formattato per l'orientamento orizzontale.
incorporamento
boolean
Indica se la pianificazione si trova in un contesto di incorporamento o meno
tema_colore
string
Combinazione di colori della dashboard, se applicabile
tabelle_lunghe
boolean
Indica se espandere o meno la visualizzazione della tabella a lunghezza intera
larghezza_tabella_inline
integer
La larghezza in pixel della visualizzazione delle tabelle in linea
id
integer
ID univoco
creata_alle
string
Data e ora in cui è stato creato PianificaPlan
aggiornato_in
string
Data e ora dell'ultimo aggiornamento di PianificaPlan
title
string
Title
user
Utente proprietario di questo PianificaPlan
Espandi definizione di Pubblico...
può
oggetto
Operazioni che l'utente corrente può eseguire su questo oggetto
id
integer
ID univoco
first_name
string
Nome
last_name
string
Cognome
nome_visualizzazione
string
Nome completo da visualizzare (disponibile solo se sono impostati sia nome che cognome)
url_avatar
string
URL dell'immagine dell'avatar (potrebbe essere generico)
url
string
Link per acquistare questo articolo
prossima_esecuzione_alle
string
Alla prossima esecuzione di PianificaPlan (null se eseguita una volta)
ultima_esecuzione_alle
string
Quando è stata eseguita l'ultima esecuzione di PianificaPlan
può
oggetto
Operazioni che l'utente corrente può eseguire su questo oggetto

400: Richiesta errata

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

404: Non trovata

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

409: Risorsa già esistente

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

422: Errore di convalida

Tipo di dati
Descrizione
messaggio
string
Error details (Dettagli errore)
Espandi definizione ValidationErrorDetails...
campo
string
Campo con errore
codice
string
Codice di errore
messaggio
string
Messaggio informativo sull'errore
documentazione_url
string
Link alla documentazione
documentazione_url
string
Link alla documentazione

429: Troppe richieste

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

Esempi