Plan erstellen

Version 4.0.23.6 (neueste Version)

Plan für Plan erstellen

Erstellen Sie einen geplanten Plan, um einen Look oder ein Dashboard mit einem wiederkehrenden Zeitplan zu rendern.

Um einen Plan zu erstellen, MÜSSEN Sie Werte für die folgenden Felder angeben: name und look_id, dashboard_id, lookml_dashboard_id oder query_id sowie cron_tab oder datagroup und mindestens ein geplantes_Ziel

Für einen geplanten Plan muss mindestens ein geplantes_Ziel festgelegt sein.

Wenn look_id festgelegt ist, sind require_no_results, require_results und require_change erforderlich.

Wenn create_scheduled_plan mit einem 422-Fehler fehlschlägt, sehen Sie sich die Fehlermeldungen in der Antwort an, um genau zu erklären, welche Felder fehlen oder welche Werte nicht kompatibel sind.

Die Abfragen, die die Daten für den Look oder das Dashboard bereitstellen, werden im Kontext des Nutzerkontos ausgeführt, zu dem der geplante Plan gehört.

Wenn run_as_recipient false oder nicht angegeben ist, werden die Abfragen mit den Daten für den Look oder das Dashboard im Kontext des Nutzerkontos ausgeführt, zu dem der geplante Plan gehört.

Wenn run_as_recipient den Wert true hat und alle E-Mail-Empfänger Looker-Nutzerkonten sind, werden die Abfragen im Kontext jedes Empfängers ausgeführt. So können verschiedene Empfänger unterschiedliche Daten über dasselbe geplante Rendering eines Looks oder Dashboards sehen. Weitere Informationen finden Sie unter Als Empfänger ausführen.

Administratoren können geplante Pläne für andere Nutzer erstellen und ändern, indem sie eine Nutzer-ID angeben. Nutzer, die keine Administratoren sind, dürfen keine geplanten Pläne erstellen oder ändern.

E-Mail-Berechtigungen:

Informationen zu den erforderlichen Berechtigungen für die Planung der Zustellung an E-Mails und zu den Sicherheitsmaßnahmen von Looker zum Schutz vor dem Senden an nicht autorisierte E-Mail-Ziele finden Sie unter Zulassungsliste für E-Mail-Domains für geplante Looks.

Geplante Formate für den Plan

Für Ziele des geplanten Plans muss das Datenformat angegeben werden, das erstellt und an das Ziel gesendet werden soll.

Formate:

Format Beschreibung
json Ein JSON-Objekt mit einem data-Attribut, das ein Array von JSON-Objekten enthält, eines pro Zeile. Keine Metadaten.
JSON-Details Zeilendaten plus Metadaten, die die Felder, Pivots, Tabellenkalkulationen und andere Aspekte der Abfrage beschreiben
inline_json Wie im JSON-Format, nur dass das Attribut data ein String mit JSON-Escape-Zeilendaten ist. Zusätzliche Eigenschaften beschreiben den Datenvorgang. Dieses Format wird hauptsächlich zum Senden von Daten an Webhooks verwendet, damit die JSON-Zeilendaten vom Webhook nicht neu codiert werden müssen, um sie an das endgültige Ziel zu übergeben.
CSV Kommagetrennte Werte mit einem Header
TXT Tabulatorgetrennte Werte mit einer Überschrift
html Einfaches HTML
xlsx Microsoft Excel-Tabelle
Logo: wysiwyg Dashboard mit gekacheltem Layout, um ein PDF-Dokument zu erstellen
kompiliertes_PDF Dashboard wird in einem einzigen Spaltenlayout gerendert, um ein PDF-Dokument zu erstellen
Logo: wysiwyg Dashboard mit gekacheltem Layout, um ein PNG-Bild zu erstellen

Die gültigen Formate variieren je nach Zieltyp und Quellobjekt. wysiwyg_pdf ist beispielsweise nur für Dashboards gültig.

Anfrage

POST /scheduled_plans
Datentyp
Beschreibung
Anfrage
HTTPRequest
body
HTTP-Text
HTTPBody-Definition maximieren...
body
Geplanter Plan
GeplantePlandefinition maximieren...
name
String
Name dieses Plans
user_id
String
Nutzer-ID, zu der dieser Plan gehört
Run_as_Recipient
boolean
Ob der Zeitplan als Empfänger ausgeführt wird (gilt nur für E-Mail-Empfänger)
aktiviert
boolean
Gibt an, ob der Planplan aktiviert ist
Look_ID
String
ID eines Looks
Dashboard-ID
String
ID eines Dashboards
Lookml-Dashboard_ID
String
ID eines LookML-Dashboards
Filterstring
String
Abfragestring zur Ausführung des Looks oder Dashboards
Dashboard_Filter
String
(VERWORFEN) Alias für das Feld „filter_string“
Anforderungsergebnisse
boolean
Die Auslieferung sollte erfolgen, wenn beim Ausführen des Dashboards oder Ergebnisses Ergebnisse zurückgegeben werden
no_no_results erforderlich
boolean
Die Auslieferung sollte erfolgen, wenn im Dashboard keine Ergebnisse zurückgegeben werden
Änderung erforderlich
boolean
Die Auslieferung sollte erfolgen, wenn sich Daten seit der letzten Ausführung geändert haben
Ergebnisse_alle_senden
boolean
Es wird eine unbegrenzte Abfrage ausgeführt und alle Ergebnisse werden gesendet.
Crontab
String
Vixie-Style-Crontab-Spezifikation für die Ausführung
Datengruppe
String
Name einer Datengruppe; sofern angegeben, wird sie ausgeführt, wenn die Gruppe ausgelöst wurde (kann nicht mit Cron-String verwendet werden)
Zeitzone
String
Zeitzone zur Interpretation des angegebenen Crontabs (Standardeinstellung ist die Looker-Instanzzeitzone)
Abfrage-ID
String
Abfrage-ID
geplantes_Ziel
einmal ausführen
boolean
Ob der betreffende Plan nur einmal ausgeführt werden soll (normalerweise für Tests)
Links einfügen
boolean
Gibt an, ob Links zu Looker in diesen Plan aufgenommen werden sollen
Benutzerdefinierte_URL_Basis
String
Domain der benutzerdefinierten URL für die geplante Entität
Benutzerdefinierte URL-Parameter
String
Benutzerdefinierter URL-Pfad und Parameter für die geplante Entität
Benutzerdefiniertes_URL-Label
String
Benutzerdefiniertes URL-Label für die geplante Entität
Benutzerdefinierte_URL
boolean
Gibt an, ob der benutzerdefinierte Link statt des Standard-Looker-Links angezeigt werden soll
PDF_papiergröße
String
Das Papierformat der PDF-Datei muss entsprechend formatiert sein. Gültige Werte sind: „letter“, „legal“, „tabloid“, „a0“, „a1“, „a2“, „a3“, „a4“, „a5“.
PDF_Querformat
boolean
Ob die PDF-Datei im Querformat formatiert werden soll
eingebettetes Objekt
boolean
Ob dieser Zeitplan in einem eingebetteten Kontext liegt oder nicht
Farbdesign
String
Farbschema des Dashboards, falls zutreffend
Lange_Tabellen
boolean
Gibt an, ob die Tabellenansicht auf volle Länge erweitert werden soll
Inline-Tabellenbreite
integer
Die Pixelbreite, in der die Inline-Tabellenvisualisierungen gerendert werden
id
String
Eindeutige ID
erstellt am
String
Datum und Uhrzeit der Erstellung des "geplanten Plans"
Aktualisiert am
String
Datum und Uhrzeit der letzten Aktualisierung von "GeplantePlan"
title
String
Titel
Nutzer
Nutzer, der Inhaber dieses Plans ist
nächste_Run_at
String
Wann der GeplantePlan als Nächstes ausgeführt wird (bei einmaliger Ausführung null)
Letzter_Durchlauf
String
Wann der GeplantePlan zuletzt ausgeführt wurde
kann
Objekt
Vorgänge, die der aktuelle Nutzer für dieses Objekt ausführen kann

Antwort

200: Geplanter Plan

Datentyp
Beschreibung
(Objekt)
name
String
Name dieses Plans
user_id
String
Nutzer-ID, zu der dieser Plan gehört
Run_as_Recipient
boolean
Ob der Zeitplan als Empfänger ausgeführt wird (gilt nur für E-Mail-Empfänger)
aktiviert
boolean
Gibt an, ob der Planplan aktiviert ist
Look_ID
String
ID eines Looks
Dashboard-ID
String
ID eines Dashboards
Lookml-Dashboard_ID
String
ID eines LookML-Dashboards
Filterstring
String
Abfragestring zur Ausführung des Looks oder Dashboards
Dashboard_Filter
String
(VERWORFEN) Alias für das Feld „filter_string“
Anforderungsergebnisse
boolean
Die Auslieferung sollte erfolgen, wenn beim Ausführen des Dashboards oder Ergebnisses Ergebnisse zurückgegeben werden
no_no_results erforderlich
boolean
Die Auslieferung sollte erfolgen, wenn im Dashboard keine Ergebnisse zurückgegeben werden
Änderung erforderlich
boolean
Die Auslieferung sollte erfolgen, wenn sich Daten seit der letzten Ausführung geändert haben
Ergebnisse_alle_senden
boolean
Es wird eine unbegrenzte Abfrage ausgeführt und alle Ergebnisse werden gesendet.
Crontab
String
Vixie-Style-Crontab-Spezifikation für die Ausführung
Datengruppe
String
Name einer Datengruppe; sofern angegeben, wird sie ausgeführt, wenn die Gruppe ausgelöst wurde (kann nicht mit Cron-String verwendet werden)
Zeitzone
String
Zeitzone zur Interpretation des angegebenen Crontabs (Standardeinstellung ist die Looker-Instanzzeitzone)
Abfrage-ID
String
Abfrage-ID
geplantes_Ziel
GeplantePlan-Zieldefinition maximieren...
id
String
Eindeutige ID
Plan_ID
String
ID eines Plans, dessen Inhaber Sie sind
Format
String
Das Datenformat, das an das angegebene Ziel gesendet werden soll. Die unterstützten Formate variieren je nach Ziel, umfassen aber „txt“, „csv“, „inline_json“, „json“, „json_detail“, „XLSx“, „html“, „wysiwyg_pdf“, „kompiliered_pdf“, „wysiwyg_png“
"formatieren" anwenden
boolean
Sind die Werte formatiert? (einschließlich Währungssymbolen, Zifferntrennzeichen usw.)
"bewerben"
boolean
Gibt an, ob Visualisierungsoptionen auf die Ergebnisse angewendet werden.
adresse
String
Adresse des Empfängers. Für E-Mail-Adressen, z.B. „nutzer@beispiel.de“. Für Webhooks, z.B. „https://examle.domain/path“. Für Amazon S3, z.B. „s3://bucket-name/path/“. Für SFTP, z.B. „sftp://host-name/pfad/“.
Empfänger
boolean
Ob der Empfänger ein Looker-Nutzer auf der aktuellen Instanz ist (nur für E-Mail-Empfänger gilt)
Typ
String
Typ der Adresse („E-Mail“, „Webhook“, „s3“ oder „sftp“)
Parameter
String
JSON-Objekt, das Parameter für die externe Planung enthält. Für Amazon S3 sind dafür Schlüssel und Werte für „access_key_id“ und „region“ erforderlich. Bei SFTP sind für den Nutzernamen ein Schlüssel und ein Wert erforderlich.
Secret-Parameter
String
(Nur Schreibzugriff) JSON-Objekt mit geheimen Parametern für externe Planung. Für Amazon S3 sind ein Schlüssel und ein Wert für „secret_access_key“ erforderlich. Bei SFTP sind dafür ein Schlüssel und ein Wert für das Passwort erforderlich.
nachricht
String
Optionale Nachricht, die in geplante E-Mails aufgenommen werden soll
einmal ausführen
boolean
Ob der betreffende Plan nur einmal ausgeführt werden soll (normalerweise für Tests)
Links einfügen
boolean
Gibt an, ob Links zu Looker in diesen Plan aufgenommen werden sollen
Benutzerdefinierte_URL_Basis
String
Domain der benutzerdefinierten URL für die geplante Entität
Benutzerdefinierte URL-Parameter
String
Benutzerdefinierter URL-Pfad und Parameter für die geplante Entität
Benutzerdefiniertes_URL-Label
String
Benutzerdefiniertes URL-Label für die geplante Entität
Benutzerdefinierte_URL
boolean
Gibt an, ob der benutzerdefinierte Link statt des Standard-Looker-Links angezeigt werden soll
PDF_papiergröße
String
Das Papierformat der PDF-Datei muss entsprechend formatiert sein. Gültige Werte sind: „letter“, „legal“, „tabloid“, „a0“, „a1“, „a2“, „a3“, „a4“, „a5“.
PDF_Querformat
boolean
Ob die PDF-Datei im Querformat formatiert werden soll
eingebettetes Objekt
boolean
Ob dieser Zeitplan in einem eingebetteten Kontext liegt oder nicht
Farbdesign
String
Farbschema des Dashboards, falls zutreffend
Lange_Tabellen
boolean
Gibt an, ob die Tabellenansicht auf volle Länge erweitert werden soll
Inline-Tabellenbreite
integer
Die Pixelbreite, in der die Inline-Tabellenvisualisierungen gerendert werden
id
String
Eindeutige ID
erstellt am
String
Datum und Uhrzeit der Erstellung des "geplanten Plans"
Aktualisiert am
String
Datum und Uhrzeit der letzten Aktualisierung von "GeplantePlan"
title
String
Titel
Nutzer
Nutzer, der Inhaber dieses Plans ist
UserPublic-Definition maximieren...
kann
Objekt
Vorgänge, die der aktuelle Nutzer für dieses Objekt ausführen kann
id
String
Eindeutige ID
first_name
String
Vorname
last_name
String
Nachname
display_name
String
Vollständiger Name für Anzeige (nur verfügbar, wenn sowohl „first_name“ als auch „last_name“ festgelegt sind)
Avatar-URL
String
URL für das Avatarbild (möglicherweise generisch)
URL
String
Link zum Abrufen dieses Artikels
nächste_Run_at
String
Wann der GeplantePlan als Nächstes ausgeführt wird (bei einmaliger Ausführung null)
Letzter_Durchlauf
String
Wann der GeplantePlan zuletzt ausgeführt wurde
kann
Objekt
Vorgänge, die der aktuelle Nutzer für dieses Objekt ausführen kann

400: Ungültige Anfrage

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

404: Nicht gefunden

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

409: Ressource ist bereits vorhanden

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

422: Validierungsfehler

Datentyp
Beschreibung
nachricht
String
Fehlerdetails
ValidationErrorDetail-Definition maximieren...
Feld
String
Feld mit Fehler
Code
String
Fehlercode
nachricht
String
Fehlermeldung
Dokumentations-URL
String
Link zur Dokumentation
Dokumentations-URL
String
Link zur Dokumentation

429: Zu viele Anfragen

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

Beispiele