Eingebettete JavaScript-Ereignisse

Nachdem du eine Einbettung erstellt hast – was öffentlich, privat, über signierte Einbettung oder über die API möglich ist, kannst du mithilfe von JavaScript mit diesen iFrames interagieren. Je nach Status des eingebetteten Elements können Sie die Seite dynamischer gestalten und sogar von Ihrer Webseite aus Änderungen am eingebetteten Element vornehmen.

Beachten Sie, dass Looker nicht die Reihenfolge bestimmt, in der Browser Ereignisse an Webanwendungen senden. Das bedeutet, dass die Reihenfolge der Ereignisse in verschiedenen Browsern oder Plattformen nicht garantiert ist. Achten Sie darauf, dass Ihr JavaScript-Code korrekt geschrieben wird, um die Verarbeitung von Ereignissen in verschiedenen Browsern zu berücksichtigen.

Sie können JavaScript auf eine der folgenden Arten für eingebettete Inhalte in Looker verwenden:

  • Mit dem Einbettungs-Software Development Kit (SDK) von Looker, das auf der Dokumentationsseite zum Embed SDK beschrieben ist
  • JavaScript-Ereignisse verwenden, wie im Abschnitt Auf Ereignisse mit JavaScript zugreifen auf dieser Seite beschrieben

Vorbereitung

Bevor Sie mit dem eingebetteten iFrame interagieren können, müssen Sie die folgenden Schritte ausführen:

ID zum iFrame hinzufügen

Wenn Sie später Daten aus dem iFrame abrufen, müssen Sie prüfen, ob die Informationen, mit denen Sie arbeiten, tatsächlich aus dem iFrame von Looker stammen. Fügen Sie Ihrem iFrame eine ID hinzu, falls Sie dies noch nicht getan haben. Im folgenden Beispiel legen Sie die ID auf looker fest, indem Sie id="looker" dem iFrame hinzufügen:

<iframe id="looker" src="https://instance_name.looker.com/embed/dashboards/1"></iframe>

Domain der eingebetteten Inhalte dem iFrame-Attribut src hinzufügen

Geben Sie in das Attribut src des iFrames die Domain an, in der der iFrame verwendet wird. Im folgenden Beispiel können Sie myownpersonaldomain.com als Domain angeben, indem Sie ?embed_domain=https://myownpersonaldomain.com" am Ende der URL im Attribut src hinzufügen:

<iframe
  id="looker"
  src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://myownpersonaldomain.com">
</iframe>

Wenn du die signierte Einbettung verwendest, musst du die embed_domain in die Einbettungs-URL einfügen.

Wenn du das Embed SDK verwendest, füge sdk=2 am Ende der Einbettungs-URL hinzu. Der Parameter sdk=2 gibt an, dass das SDK vorhanden ist und Looker zusätzliche Funktionen des SDK nutzen kann, z. B. das Senden von JavaScript-Ereignissen zwischen dem Looker-iFrame und Ihrer Domain. Das SDK kann diesen Parameter nicht selbst hinzufügen, da er Teil der signierten URL ist. Beispiel:

<iframe
  id="looker"
  src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://myownpersonaldomain.com&sdk=2">
</iframe>

Eingebettete Domain auf die Zulassungsliste setzen

Schließlich müssen Sie die Domain, in der der iFrame verwendet wird, der Zulassungsliste auf der Seite Einbetten im Admin-Bereich von Looker hinzufügen. Gehen Sie dazu so vor:

  1. Geben Sie in das Feld Zulassungsliste für eingebettete Domains die Domain ein, in der der iFrame verwendet wird. Drücken Sie dann die Tabulatortaste, damit die Domain in einem Feld innerhalb des Felds erscheint.

  2. Klicken Sie auf Aktualisieren.

Sie können den Platzhalter * in der Zulassungsliste verwenden, um ein Domainmuster zu erstellen. Beispielsweise sind für https://*.myownpersonaldomain.com sowohl https://analytics.myownpersonaldomain.com als auch https://data.myownpersonaldomain.com zulässig.

Wenn Sie die Einbettung ohne Cookies mit Looker 23.8 oder höher verwenden, kann die Einbettungsdomain beim Abrufen der Sitzung ohne Cookies angegeben werden. Das ist eine Alternative zum Hinzufügen der eingebetteten Domain zur Zulassungsliste über das Steuerfeld Admin > Einbetten. Lesen Sie die Best Practices für die Sicherheit, wenn Sie diese Funktion nutzen möchten.

Daten aus dem iFrame abrufen

Nachdem Sie die Vorbereitungsschritte abgeschlossen haben, können Sie auf postMessage-Ereignisse warten, um auf die Ereignisse zuzugreifen, die zwischen dem Looker-iFrame und Ihrer Domain übergeben werden.

Der eingebettete iFrame kann verschiedene Ereignistypen erstellen. Weitere Informationen dazu finden Sie auf dieser Seite im Abschnitt Ereignistyp-Referenz.

Auf Ereignisse in JavaScript zugreifen

Hier ist ein Beispiel, wie Sie diese Ereignisse in nativem JavaScript überwachen und dann in der Console protokollieren:

window.addEventListener("message", function(event) {
  if (event.source === document.getElementById("looker").contentWindow) {
    if (event.origin === "https://instance_name.looker.com") {
      console.log(JSON.parse(event.data));
    }
  }
});

Hier ist ein Beispiel für das Überwachen dieser Ereignisse in jQuery und anschließendes Logging in der Konsole:

$(window).on("message", function(event) {
  if (event.originalEvent.source === $("#looker")[0].contentWindow) {
    if (event.origin === "https://instance_name.looker.com") {
      console.log(JSON.parse(event.data));
    }
  }
});

Tabelle mit der Zusammenfassung der Ereignistypen

In der folgenden Tabelle sind die Ereignistypen zusammengefasst. Wählen Sie einen Ereignistyp aus, um die Details zu diesem Ereignis aufzurufen.

Ereignistyp Ursache des Ereignisses
dashboard:loaded In Dashboards, in denen die Tiles nicht auf „Automatisch ausgeführt“ festgelegt sind, wurden ein Dashboard und seine Elemente geladen, es werden jedoch noch keine Abfragen ausgeführt.
dashboard:run:start Das Laden eines Dashboards hat begonnen, und seine Kacheln haben mit dem Laden und Abfragen von Daten begonnen.
dashboard:run:complete Ein Dashboard ist beendet und alle Kacheln wurden vollständig geladen und abgefragt.
dashboard:download Der Download eines Dashboards wurde gestartet.
dashboard:edit:start ADDED 22.20 Ein Dashboard wurde in den Bearbeitungsmodus gewechselt. Das Ereignis dashboard:save:complete wird ausgelöst, wenn das Dashboard erfolgreich gespeichert wurde.
dashboard:edit:cancel ADDED 22.20 Für ein Dashboard im Bearbeitungsmodus wurde der Bearbeitungsmodus ohne Speichern beendet.
dashboard:save:complete Ein Dashboard wurde bearbeitet und gespeichert.
dashboard:delete:complete Ein Dashboard wurde gelöscht.
dashboard:tile:start Eine Kachel hat mit dem Laden oder Abfragen von Daten begonnen.
dashboard:tile:complete Eine Kachel hat die Ausführung der Abfrage beendet.
dashboard:tile:download Der Download der Daten einer Kachel wurde gestartet.
dashboard:tile:explore Ein Benutzer hat in einer Dashboard-Kachel auf die Option Von hier aus explorieren geklickt.
dashboard:tile:view Ein Nutzer hat in einer Dashboard-Kachel auf die Option Ursprünglichen Look ansehen geklickt.
dashboard:filters:changed Die Filter eines Dashboards wurden angewendet oder geändert.
look:ready Ein Look hat mit dem Laden von Abfragedaten begonnen, unabhängig davon, ob die Abfrage ausgeführt wird oder nicht.
look:run:start Ein Look hat mit dem Laden von Abfragedaten begonnen und die Abfrage wird ausgeführt.
look:run:complete Die Ausführung eines Looks ist abgeschlossen.
look:save:complete Ein Look wurde bearbeitet und gespeichert.
look:delete:complete Ein Look wurde in den Ordner Papierkorb verschoben.
drillmenu:click Ein Nutzer hat in einem Dashboard auf ein Aufschlüsselungsmenü geklickt, das mit dem LookML-Parameter link erstellt wurde.
drillmodal:download Ein Nutzer hat ein Aufschlüsselungsdialogfeld über eine Dashboard-Kachel geöffnet und auf die Option Herunterladen geklickt.
drillmodal:explore Ein Nutzer hat in einem Dialogfeld zur Aufschlüsselung auf die Option Von hier aus explorieren geklickt.
explore:ready Ein Explore hat mit dem Laden von Abfragedaten begonnen, unabhängig davon, ob die Abfrage ausgeführt wird oder nicht.
explore:run:start Ein Explore hat mit dem Laden von Abfragedaten begonnen und die Abfrage wird ausgeführt.
explore:run:complete Ein Explore hat die Ausführung der Abfrage abgeschlossen.
explore:state:changed Die URL einer Explore-Seite hat sich infolge der Aktionen des Nutzers geändert.
page:changed Ein Nutzer hat eine neue Seite im iFrame aufgerufen.
page:properties:changed Die Höhe eines Dashboard-iFrames hat sich geändert.
session:tokens Der Looker-Client benötigt Tokens, um fortzufahren.
session:status Sendet Informationen zum Status einer Sitzung.
env:client:dialog Es wurde ein Dialogfeld geöffnet, das möglicherweise teilweise nicht sichtbar ist, z. B. eine Aufschlüsselung. Mit diesem Ereignis kann die Hosting-Anwendung durch das Dialogfeld scrollen.

Ereignistypreferenz

Der eingebettete iFrame kann viele verschiedene Arten von Ereignissen erstellen:

dashboard:loaded

In Dashboards, in denen die Tiles nicht automatisch ausgeführt werden, wird dieses Ereignis erstellt, nachdem ein Dashboard und seine Elemente geladen wurden, aber bevor Abfragen ausgeführt werden.


type: "dashboard:loaded",
status: "complete",
dashboard: {
  id: 1,
  title: "Business Pulse",
  canEdit: true,
  dashboard_filters: {
    "date": "Last 6 Years",
    "state": ""
  },
  absoluteUrl: "https://self-signed.looker.com:9999/embed/dashboards/1?embed_domain=https%3A%2F%2Fself-signed.looker.com%3A9999&date=Last+6+Years&state=",
  url: "/embed/dashboards/1?embed_domain=https%3A%2F%2Fself-signed.looker.com%3A9999&date=Last+6+Years&state=",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Attribut Format Beschreibung
status String Gibt an, ob das Dashboard und seine Elemente geladen wurden.
dashboard.id Nummer/String Die ID des Dashboards.
dashboard.title String Der Titel, wie oben im Dashboard angezeigt.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.dashboard_filters Objekt Die auf das Dashboard angewendeten Filter. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.absoluteUrl String Die vollständige Dashboard-URL.
dashboard.url String Die relative Dashboard-URL (nur der Pfad).
dashboard.options Objekt Eigenschaften und Werte für Dashboard-Layout, Dashboard-Layoutkomponente und Dashboard-Element. Allen im options-Objekt zurückgegebenen Eigenschaften können mithilfe des Ereignisses dashboard:options:set aktualisierte Werte zugewiesen werden.

dashboard:run:start

Dieses Ereignis wird erstellt, wenn das Laden eines Dashboards begonnen hat, wenn die Kachel des Dashboards geladen wird und Daten abgefragt werden.

type: "dashboard:run:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards.
dashboard.title String Der Titel, wie oben im Dashboard angezeigt.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad).
dashboard.absoluteUrl String Die vollständige Dashboard-URL.
dashboard.dashboard_filters Objekt Die auf das Dashboard angewendeten Filter. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:run:complete

Dieses Ereignis wird erstellt, wenn die Ausführung eines Dashboards und das Laden und Abfragen aller Kacheln abgeschlossen sind. Dieses Ereignis wird unabhängig davon erstellt, ob alle Kacheln erfolgreich geladen werden.

type: "dashboard:run:complete",
status: "complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://my.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Attribut Format Beschreibung
status String Gibt an, ob das Dashboard und seine Elemente erfolgreich ausgeführt wurden. Wenn das Dashboard und seine Elemente erfolgreich ausgeführt wurden, gibt status "complete" zurück. Andernfalls gibt status "error" zurück. Wurde das ausgeführte Dashboard beendet, entweder über die Benutzeroberfläche oder mit der Aktion dashboard:stop, gibt status "stopped" zurück.
dashboard.id Nummer/String Die ID des Dashboards.
dashboard.title String Der Titel, wie oben im Dashboard angezeigt.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad).
dashboard.absoluteUrl String Die vollständige Dashboard-URL.
dashboard.dashboard_filters Objekt Die auf das Dashboard angewendeten Filter. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.options Objekt Eigenschaften und Werte für Dashboard-Layout, Dashboard-Layoutkomponente und Dashboard-Element. Allen im options-Objekt zurückgegebenen Eigenschaften können mithilfe der Aktion dashboard:options:set aktualisierte Werte zugewiesen werden.
dashboard.tileStatuses Objektarray Ein Array von Objekten, die Kachelstatuswerte angeben. Objektattribute sind:

  • tileId: Die ID-Nummer der Kachel.
  • status: Wenn die Kachelabfrage erfolgreich ausgeführt wurde, gibt status den Wert "complete" zurück. Andernfalls gibt status den Wert "error" zurück.
  • errors: Wird ausgefüllt, wenn die Property status den Wert "error" hat. Ein Array von Objekten, die Details zum Fehler liefern, einschließlich des Fehlermeldungstexts, einer ausführlicheren Beschreibung des Fehlers und der SQL-Abfrage der Kachel, die den Fehler verursacht hat.

dashboard:download

Dieses Ereignis wird erstellt, wenn der Download einer PDF-Datei eines Dashboards gestartet wurde.

type: "dashboard:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
fileFormat: "pdf"
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards.
dashboard.title String Der Titel, wie oben im Dashboard angezeigt.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad).
dashboard.absoluteUrl String Die vollständige Dashboard-URL.
dashboard.dashboard_filters Objekt Die auf das Dashboard angewendeten Filter. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
fileFormat String Das Format des heruntergeladenen Dashboards (derzeit nur "pdf").

dashboard:edit:start

ADDED 22.20 Dieses Ereignis wird erstellt, wenn ein Dashboard in den Bearbeitungsmodus versetzt wird.

type: "dashboard:edit:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards.
dashboard.title String Der Titel, wie oben im Dashboard angezeigt.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad).
dashboard.absoluteUrl String Die vollständige Dashboard-URL.
dashboard.dashboard_filters Objekt Die auf das Dashboard angewendeten Filter. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:edit:cancel

ADDED 22.20 Dieses Ereignis wird erstellt, wenn für ein Dashboard im Bearbeitungsmodus der Bearbeitungsmodus beendet wird, ohne zu speichern.

type: "dashboard:edit:cancel",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards.
dashboard.title String Der Titel, wie oben im Dashboard angezeigt.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad).
dashboard.absoluteUrl String Die vollständige Dashboard-URL.
dashboard.dashboard_filters Objekt Die auf das Dashboard angewendeten Filter. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:save:complete

Dieses Ereignis wird erstellt, wenn ein Dashboard bearbeitet und dann gespeichert wird.

type: "dashboard:save:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  url: "/embed/dashboards/...",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards.
dashboard.title String Der Titel, wie oben im Dashboard angezeigt.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.dashboard_filters Objekt Die auf das Dashboard angewendeten Filter. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.absoluteUrl String Die vollständige Dashboard-URL.
dashboard.url String Die relative Dashboard-URL (nur der Pfad).
dashboard.options Objekt Eigenschaften und Werte für Dashboard-Layout, Dashboard-Layoutkomponente und Dashboard-Element. Allen im options-Objekt zurückgegebenen Eigenschaften können mithilfe des Ereignisses dashboard:options:set aktualisierte Werte zugewiesen werden.

dashboard:delete:complete

Dieses Ereignis wird erstellt, wenn ein Dashboard gelöscht wird.

type: "dashboard:delete:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  url: "/embed/dashboards/...",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards.
dashboard.title String Der Titel, wie oben im Dashboard angezeigt.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.dashboard_filters Objekt Die auf das Dashboard angewendeten Filter. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.absoluteUrl String Die vollständige Dashboard-URL.
dashboard.url String Die relative Dashboard-URL (nur der Pfad).
dashboard.options Objekt Eigenschaften und Werte für Dashboard-Layout, Dashboard-Layoutkomponente und Dashboard-Element. Allen im options-Objekt zurückgegebenen Eigenschaften können mithilfe des Ereignisses dashboard:options:set aktualisierte Werte zugewiesen werden.

dashboard:tile:start

Dieses Ereignis wird erstellt, wenn eine Kachel mit dem Laden oder Abfragen von Daten beginnt.

type: "dashboard:tile:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards, zu dem die Kachel gehört.
dashboard.title String Der Dashboard-Titel, wie oben im Dashboard angezeigt, zu dem die Tile gehört.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad), zu der die Kachel gehört.
dashboard.absoluteUrl String Die vollständige Dashboard-URL, zu der die Kachel gehört.
dashboard.dashboard_filters Objekt Die Filter, die auf das Dashboard angewendet wurden, zu dem die Kachel gehört. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer Die ID-Nummer des Ereignisses, nicht die Kachel.
tile.title String Der Kacheltitel, wie oben in der Kachel angezeigt
tile.listen Objekt Die globalen Dashboardfilter, die diese Kachel beobachtet. Dieses Objekt hat folgendes Format: {"Filter Label": "Filter Field", ...}

dashboard:tile:complete

Dieses Ereignis wird erstellt, wenn die Ausführung der Abfrage einer Kachel beendet ist.

type: "dashboard:tile:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
status: "complete",
truncated: false,
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards, zu dem die Kachel gehört.
dashboard.title String Der Dashboard-Titel, wie oben im Dashboard angezeigt, zu dem die Tile gehört.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad), zu der die Kachel gehört.
dashboard.absoluteUrl String Die vollständige Dashboard-URL, zu der die Kachel gehört.
dashboard.dashboard_filters Objekt Die Filter, die auf das Dashboard angewendet wurden, zu dem die Kachel gehört. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
status String Gibt an, ob die Kachelabfrage erfolgreich abgeschlossen wurde. Mögliche Werte sind "complete" und "error".
truncated Boolesch Gibt an, ob die Kachelabfrageergebnisse abgeschnitten wurden, da die Abfrage mehr Zeilen als das Abfragezeilenlimit zurückgegeben hat. Das Zeilenlimit kann entweder ein vom Nutzer angegebenes Zeilenlimit oder das Looker-Standardzeilenlimit von 5.000 sein.
tile.id Integer Die ID-Nummer des Ereignisses, nicht die Kachel.
tile.title String Der Kacheltitel, wie oben in der Kachel angezeigt
tile.listen Objekt Die globalen Dashboardfilter, die diese Kachel beobachtet. Dieses Objekt hat folgendes Format: {"Filter Label": "Filter Field", ...}
tile.errors Objektarray Wird ausgefüllt, wenn das Attribut status den Wert "error" hat. Ein Array von Objekten, die Details zum Fehler liefern, einschließlich des Fehlermeldungstexts, einer ausführlicheren Beschreibung des Fehlers und der SQL-Abfrage der Kachel, die den Fehler verursacht hat.

dashboard:tile:download

Dieses Ereignis wird erstellt, wenn mit dem Download der Daten einer Kachel begonnen wurde.

type: "dashboard:tile:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales"
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
fileFormat: "pdf"
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards, zu dem die Kachel gehört.
dashboard.title String Der Dashboard-Titel, wie oben im Dashboard angezeigt, zu dem die Tile gehört.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad), zu der die Kachel gehört.
dashboard.absoluteUrl String Die vollständige Dashboard-URL, zu der die Kachel gehört.
dashboard.dashboard_filters Objekt Die Filter, die auf das Dashboard angewendet wurden, zu dem die Kachel gehört. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer Die ID-Nummer des Ereignisses, nicht die Kachel.
tile.title String Der Kacheltitel, wie oben in der Kachel angezeigt
tile.listen Objekt Die globalen Dashboardfilter, die diese Kachel beobachtet. Dieses Objekt hat folgendes Format: {"Filter Label": "Filter Field", ...}
fileFormat String Das Format der heruntergeladenen Kachel (derzeit nur "pdf").

dashboard:tile:explore

Dieses Ereignis wird erstellt, wenn ein Nutzer in einer Dashboard-Kachel auf die Option Von hier aus analysieren klickt.

type: "dashboard:tile:explore",
label: 'Explore From Here',
url: '/embed/explore/model/view...',
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Attribut Format Beschreibung
label String Die Beschriftung der Schaltfläche.
url String Die relative URL (nur der Pfad) des Explores, das angezeigt werden soll.
dashboard.id Nummer/String Die ID des Dashboards, zu dem die Kachel gehört.
dashboard.title String Der Dashboard-Titel, wie oben im Dashboard angezeigt, zu dem die Tile gehört.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad), zu der die Kachel gehört.
dashboard.absoluteUrl String Die vollständige Dashboard-URL, zu der die Kachel gehört.
dashboard.dashboard_filters Objekt Die Filter, die auf das Dashboard angewendet wurden, zu dem die Kachel gehört. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer Die ID-Nummer des Ereignisses, nicht die Kachel.
tile.title String Der Kacheltitel, wie oben in der Kachel angezeigt
tile.listen Objekt Die globalen Dashboardfilter, die diese Kachel beobachtet. Dieses Objekt hat folgendes Format: {"Filter Label": "Filter Field", ...}

dashboard:tile:view

Dieses Ereignis wird erstellt, wenn ein Nutzer in einer Dashboardkachel auf die Option Ursprünglichen Look ansehen klickt.

type: "dashboard:tile:view",
label: 'View Original Look',
url: '/embed/look/...',
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Attribut Format Beschreibung
label String Die Beschriftung der Schaltfläche.
url String Die relative URL (nur der Pfad) des Looks, der angezeigt werden soll.
dashboard.id Nummer/String Die ID des Dashboards, zu dem die Kachel gehört.
dashboard.title String Der Dashboard-Titel, wie oben im Dashboard angezeigt, zu dem die Tile gehört.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad), zu der die Kachel gehört.
dashboard.absoluteUrl String Die vollständige Dashboard-URL, zu der die Kachel gehört.
dashboard.dashboard_filters Objekt Die Filter, die auf das Dashboard angewendet wurden, zu dem die Kachel gehört. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer Die ID-Nummer des Ereignisses, nicht die Kachel.
tile.title String Der Kacheltitel, wie oben in der Kachel angezeigt
tile.listen Objekt Die globalen Dashboardfilter, die diese Kachel beobachtet. Dieses Objekt hat folgendes Format: {"Filter Label": "Filter Field", ...}

dashboard:filters:changed

Dieses Ereignis wird erstellt, wenn die Filter eines Dashboards angewendet oder geändert wurden.

type: "dashboard:filters:changed",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards.
dashboard.title String Der Titel, wie oben im Dashboard angezeigt.
dashboard.canEdit Boolesch ADDED 22.20 Wenn true, kann der Nutzer das Dashboard bearbeiten.
dashboard.url String Die relative Dashboard-URL (nur der Pfad).
dashboard.absoluteUrl String Die vollständige Dashboard-URL.
dashboard.dashboard_filters Objekt Die auf das Dashboard angewendeten Filter. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.options Objekt Eigenschaften und Werte für Dashboard-Layout, Dashboard-Layoutkomponente und Dashboard-Element. Allen im options-Objekt zurückgegebenen Eigenschaften können mithilfe des Ereignisses dashboard:options:set aktualisierte Werte zugewiesen werden.

look:ready

Dieses Ereignis wird erstellt, wenn mit dem Laden von Abfragedaten in einem Look begonnen wird, unabhängig davon, ob die Abfrage ausgeführt wird oder nicht.

type: "look:ready",
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}
Attribut Format Beschreibung
look.url String Die relative Look-URL (nur der Pfad)
look.absoluteUrl String Die vollständige Look-URL

look:run:start

Dieses Ereignis wird erstellt, wenn mit dem Laden von Abfragedaten in einen Look begonnen und die Abfrage ausgeführt wird.

type: "look:run:start",
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}
Attribut Format Beschreibung
look.url String Die relative Look-URL (nur der Pfad)
look.absoluteUrl String Die vollständige Look-URL

look:run:complete

Dieses Ereignis wird erstellt, wenn die Ausführung eines Looks die Abfrage beendet hat.

type: look:run:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}
Attribut Format Beschreibung
look.url String Die relative Look-URL (nur der Pfad)
look.absoluteUrl String Die vollständige Look-URL

look:save:complete

Dieses Ereignis wird erstellt, wenn ein Look bearbeitet und gespeichert wird. Dieses Ereignis wird erstellt, wenn ein Nutzer eine der folgenden Aufgaben ausführt:

Dieses Ereignis wird nicht erstellt, wenn der Look mit der Menüoption Speichern > Im vorhandenen Dashboard oder Einstellungen bearbeiten gespeichert wird.

type: look:save:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  folderid: 123
  }
}
Attribut Format Beschreibung
look.url String Die relative Look-URL (nur der Pfad)
look.absoluteUrl String Die vollständige Look-URL
look.folderid Integer Die Ordner-ID, in der der Look gespeichert ist

look:delete:complete

Dieser Termin wird erstellt, wenn ein Look in den Ordner Papierkorb verschoben wird.

type: look:delete:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
}
Attribut Format Beschreibung
look.url String Die relative Look-URL (nur der Pfad)
look.absoluteUrl String Die vollständige Look-URL

drillmenu:click

Dieses Ereignis wird erstellt, wenn ein Nutzer auf ein Aufschlüsselungsmenü in einem Dashboard klickt, das mit dem LookML-Parameter link erstellt wurde. Mit dem folgenden LookML-Code wird beispielsweise ein Drilldown-Menü erstellt, in dem ein Nutzer Daten ansehen kann, die nach der Dimension state gefiltert sind:


dimension: state {
  type: string
  sql: ${TABLE}.state ;;
  link: {
    label: "Filter by {{ state | encode_uri }}"
    url: "filter::q={{ state | encode_uri }}"
    icon_url: "https://google.com/favicon.ico"
  }
}

Wenn der Filter state auf Illinois gesetzt ist, gibt das Ereignis drillmenu:click Folgendes an den Host des iFrames zurück:

type: "drillmenu:click",
label: "Filter by Illinois",
link_type: "url",
modal: false,
target: '_self',
url: "#filter::state=Illinois"
context: ' '
Attribut Format Beschreibung
label String Das Linklabel, wie im Aufschlüsselungsmenü angezeigt
link_type String Der Objekttyp am Linkziel
modal Boolesch Ob das Dialogfeld für die Aufschlüsselung anstelle der Browsernavigation verwendet wird
target String _self ist, wenn das Linkziel den aktuellen iFrame ersetzt, oder _blank, wenn durch das Linkziel ein neues Fenster geöffnet wird.
url String URL des Linkziels
context String Internes Attribut, das von einigen Visualisierungstypen verwendet wird

Sandbox im iFrame verhindert, dass Klicks auf das Drilldown-Menü in einem neuen Fenster geöffnet werden. Verwenden Sie diese Sandbox-Werte innerhalb des iFrame-Tags:

sandbox = "allow-same-origin allow-scripts"

drillmodal:download

Dieses Ereignis wird erstellt, wenn ein Nutzer ein Aufschlüsselungsdialogfeld über eine Dashboard-Kachel öffnet und auf die Option Herunterladen klickt.

{
type: "drillmodal:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/…",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/…",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
drillExploreUrl: "/embed...",
fileFormat: "pdf"
}
Attribut Format Beschreibung
dashboard.id Nummer/String Die ID des Dashboards, zu dem die Kachel gehört.
dashboard.title String Der Dashboard-Titel, wie oben im Dashboard angezeigt, zu dem die Tile gehört.
dashboard.url String Die relative Dashboard-URL (nur der Pfad), zu der die Kachel gehört.
dashboard.absoluteUrl String Die vollständige Dashboard-URL, zu der die Kachel gehört.
dashboard.dashboard_filters Objekt Die Filter, die auf das Dashboard angewendet wurden, zu dem die Kachel gehört. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
drillExploreUrl String Die relative Explore-URL (nur der Pfad), die heruntergeladen werden soll.
fileFormat String Das Dateiformat des Datendownloads.

drillmodal:explore

Dieses Ereignis wird erstellt, wenn ein Nutzer in einem Aufschlüsselungsdialogfeld auf die Option Von hier aus explorieren klickt.

type: "drillmodal:explore",
label: "Explore From Here",
url: "/embed/explore/model/view..."
Attribut Format Beschreibung
label String Die Beschriftung der Schaltfläche, wie im Aufschlüsselungsmenü zu sehen
url String Die relative Explore-URL (nur der Pfad), die angezeigt werden soll.

explore:ready

Dieses Ereignis wird erstellt, wenn ein Explore mit dem Laden von Abfragedaten beginnt, unabhängig davon, ob die Abfrage ausgeführt wird oder nicht.

type: "explore:ready",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
}
Attribut Format Beschreibung
explore.url String Die relative Explore-URL (nur der Pfad)
explore.absoluteUrl String Die vollständige Explore-URL

explore:run:start

Dieses Ereignis wird erstellt, wenn ein Explore mit dem Laden von Abfragedaten beginnt und die Abfrage ausgeführt wird.

type: "explore:run:start",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
}
Attribut Format Beschreibung
explore.url String Die relative Explore-URL (nur der Pfad)
explore.absoluteUrl String Die vollständige Explore-URL

explore:run:complete

Dieses Ereignis wird erstellt, wenn ein Explore die Abfrage beendet hat.

type: "explore:run:complete",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
}
Attribut Format Beschreibung
explore.url String Die relative Explore-URL (nur der Pfad)
explore.absoluteUrl String Die vollständige Explore-URL

explore:state:changed

Dieses Ereignis wird erstellt, wenn sich die URL einer Explore-Seite infolge der Aktionen des Nutzers ändert.

type: "explore:state:changed",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/..."
}
Attribut Format Beschreibung
explore.url String Die relative Explore-URL (nur der Pfad)
explore.absoluteUrl String Die vollständige Explore-URL

page:changed

Dieses Ereignis wird erstellt, wenn ein Nutzer im iFrame zu einer neuen Seite navigiert.

type: "page:changed",
page: {
  type: "dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/..."
}
Attribut Format Beschreibung
page.type String Der Seitentyp, der gerade aufgerufen wurde, z. B. "dashboard", "look" oder "explore"
page.url String Die relative URL (nur der Pfad) der Seite, die soeben aufgerufen wurde
page.absoluteUrl String Die vollständige URL der Seite, die gerade navigiert wurde

page:properties:changed

Dieses Ereignis wird erstellt, wenn sich die Höhe eines Dashboard-iFrames ändert. Es ist für Looks oder Explores nicht verfügbar, da die Höhe dieser Elemente automatisch an die Größe des iFrames angepasst wird.

type: "page:properties:changed",
height: 1000
Attribut Format Beschreibung
height Integer Höhe des Dashboard-iFrames in Pixeln

session:tokens

Dieses Ereignis zeigt an, dass der Looker-Client Tokens benötigt, um fortzufahren. Dieses Ereignis wird unmittelbar beim Erstellen des iFrames und danach regelmäßig für die Dauer der Sitzung erstellt.

{
  "type": "session:tokens",
  "api_token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3NlbGYtc2lnbmVkLmxvb2tlci5jb206OTk5OSIsImV4cCI6MTY3MDYyNjMzMCwic3ViIjoiYVdrNWFGUzM4RnRwNzFFWXhuS3ZaMXdKRmV3ZjB2VzYtTV9zLWtCcHE1dXIiLCJ0b2tlbl90eXBlIjoiYXBpX3Rva2VuIiwicmFuZG9taXplciI6IkxjYnpOeDNTVjNOb3o3UVlqTVJjNmhlMkdodjh1a2UwWUhiZWNRMHVCYm1KIn0.CBv1__QGc_H7bKNe31SHMMQCsc5ya1xOiEv1UDWAyxM",
  "api_token_ttl": 463,
  "navigation_token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3NlbGYtc2lnbmVkLmxvb2tlci5jb206OTk5OSIsImV4cCI6MTY3MDYyNjMzMCwic3ViIjoiYVdrNWFGUzM4RnRwNzFFWXhuS3ZaMXdKRmV3ZjB2VzYtTV9zLWtCcHE1dXIiLCJ0b2tlbl90eXBlIjoibmF2aWdhdGlvbl90b2tlbiIsInJhbmRvbWl6ZXIiOiJHVVNlc00tdTRPRDlNdktodFJDU2pEcVFhUkJNeTh5dm42Q1FDUXhuLTNxMiJ9.sWo7LUEI5LeragVmeDamUR7u2myXpFJ0aqK_IIALUqI",
  "navigation_token_ttl": 463,
  "session_reference_token_ttl": 2924
}
Attribut Format Beschreibung
authentication_token String Authentifizierungstoken. Wird beim Erstellen des iFrames berücksichtigt. Nicht in einer Antwort auf eine Anfrage zum Generieren von Tokens enthalten oder wenn die Sitzung abgelaufen ist.
authentication_token_ttl Nummer Gültigkeitsdauer des Authentifizierungstokens in Sekunden. Wird beim Erstellen des iFrames berücksichtigt. Nicht in einer Antwort auf eine Anfrage zum Generieren von Tokens enthalten oder wenn die Sitzung abgelaufen ist.
api_token String API-Token. Nicht enthalten, wenn die Sitzung abgelaufen ist.
api_token_ttl Nummer Gültigkeitsdauer des API-Tokens in Sekunden. Nicht enthalten, wenn die Sitzung abgelaufen ist.
navigation_token String Navigationstoken. Nicht enthalten, wenn die Sitzung abgelaufen ist.
navigation_token_ttl Nummer Gültigkeitsdauer des Navigationstokens in Sekunden. Nicht enthalten, wenn die Sitzung abgelaufen ist.
session_references_token_ttl Nummer Gültigkeitsdauer der Sitzung in Sekunden. Nach Ablauf der Sitzung ist der Wert 0. Zur Wiederherstellung muss die Einbettungsanwendung eine neue Sitzung abrufen.

session:status

Das Ereignis wird generiert, wenn die eingebettete Looker-Anwendung Anfragen für Sitzungstokens verarbeitet.

{
  "type": "session:status",
  "session_ttl": 0,
  "expired": true,
  "interrupted": false
}
Attribut Format Beschreibung
session_ttl Nummer Gültigkeitsdauer der Sitzung in Sekunden.
expired Boolesch true bedeutet, dass die Sitzung abgelaufen ist.
interrupted Boolesch Wenn true, bedeutet das, dass auf eine Anfrage für Sitzungstokens nicht geantwortet wurde. Dies könnte darauf hindeuten, dass ein Server vorübergehend nicht verfügbar ist.
recoverable Boolesch Das Feld wird nur bei Unterbrechung gefüllt: true. Gibt an, ob die Sitzung wiederhergestellt werden kann. Der Wert false bedeutet wahrscheinlich, dass ein Problem mit der Einbettungsanwendung vorliegt.

env:client:dialog

Das Ereignis wird generiert, wenn ein Dialogfeld geöffnet wird, das teilweise nicht sichtbar ist, z. B. ein Dialogfeld zum Drilldown-Vorgang. Mit diesem Ereignis kann die Hosting-Anwendung mit der Aktion env:host:scroll durch das Dialogfeld scrollen.

{
  type: "env:client:dialog",
  dialogType: 'drilling',
  placement: 'cover',
  open: true
}
Attribut Format Beschreibung
type String env:client:dialog gibt an, dass ein Dialogfeld geöffnet oder geschlossen wurde. Derzeit wird nur das Dialogfeld „Aufschlüsselung“ unterstützt. In Zukunft sollen jedoch weitere Dialogfelder hinzugefügt werden. Es ist möglich, dass der obere Teil des Dialogfelds für die Aufschlüsselung nicht zu sehen ist, da das Dialogfeld den iFrame-Darstellungsbereich abdeckt. Bei diesem Ereignis kann die Host-Anwendung im Dialogfeld nach oben scrollen, um den sichtbaren Bereich zu sehen.
dialogType String Die Art des Dialogfelds. Derzeit wird dieses Ereignis nur durch das Öffnen oder Schließen des Dialogfeldtyps „Drilldown“ ausgelöst.
placement String Die Position des Dialogfelds. In Dialogfeldern vom Typ „Bohren“ wird immer „Titelbild“ als placement verwendet.
open Boolesch Gibt an, ob das Dialogfeld geöffnet oder gescrollt wird.

Änderungen am iFrame vornehmen

Nachdem Sie den iFrame auf das Abrufen von Daten vorbereitet haben, können Sie Änderungen am iFrame vornehmen. Gehen Sie dazu so vor:

  1. Schreiben Sie die Anfrage in JSON.
  2. Posten Sie die Anfrage im contentWindow des iFrames.

Anfrage in JSON schreiben

Sie können mehrere Änderungen am iFrame vornehmen, den Sie dann im JSON-Format einreichen. Die verfügbaren Optionen werden im Abschnitt Aktionsreferenz auf dieser Seite beschrieben. Vergessen Sie nicht, die Aktion mithilfe von JSON.stringify in das JSON-Format umzuwandeln:

var my_request = JSON.stringify(
  {
    type: "dashboard:run"
  }
);

Anfrage an die contentWindow-Eigenschaft des iFrames senden

Veröffentlichen Sie Ihre Nachricht schließlich so im contentWindow des iFrames:

var my_iframe = document.getElementById("my_iframe_id");

my_iframe.contentWindow.postMessage(my_request, 'https://instance_name.looker.com');

Tabelle mit Aktionsübersicht

In der folgenden Tabelle sind die Aktionen zusammengefasst. Wählen Sie eine Aktion aus, um die Details dazu aufzurufen.

Aktion Aktionsbeschreibung
dashboard:load Lädt ein neues Dashboard in den iFrame und ersetzt ein vorhandenes Dashboard.
dashboard:run Führt das Dashboard im iFrame aus.
dashboard:edit ADDED 22.20 Versetzt das Dashboard in den Bearbeitungsmodus.
dashboard:filters:update Aktualisiert einen vorhandenen Dashboardfilter im iFrame.
dashboard:options:set Schreibt neue Werte in die Eigenschaften des Dashboard-Layouts und des Dashboardelements.
dashboard:schedule_modal:open Öffnet den Planer, mit dem Benutzer Looker-Inhalte an verschiedene Ziele liefern können.
dashboard:stop Beendet ein Dashboard, das ausgeführt wird oder Daten neu lädt.
look:run Führt den Look im iFrame aus.
look:filters:update Aktualisiert einen vorhandenen Look-Filter im iFrame.
explore:run Führt das Explore im iFrame aus.
explore:filters:update Aktualisiert oder entfernt einen vorhandenen Explore-Filter im iFrame.
session:tokens:request Sendet Tokens als Antwort auf ein session:tokens:request-Ereignis.
env:host:scroll Sendet Informationen zur aktuellen Scrollposition des Host-iFrames an die eingebettete Looker-Anwendung.

Aktionsreferenz

Folgende Aktionen können an den eingebetteten iFrame gesendet werden:

dashboard:load

Mit dieser Aktion können Sie ein neues Dashboard in den iFrame laden, das ein vorhandenes Dashboard ersetzt. Im neuen Dashboard werden Abfragen so ausgeführt, als ob eine neue Dashboard-Seite geöffnet worden wäre.

{
  type: "dashboard:load",
  id: "101",
  pushHistory: false
}
Attribut Format Beschreibung
type String Die Verwendung des Typs dashboard:load bedeutet, dass Sie ein neues Dashboard in den iFrame laden möchten.
id String Die ID des zu ladenden Dashboards.
pushHistory Boolesch Bei true wird beim Laden des Dashboards ein neuer Browserverlaufseintrag erstellt und der Nutzer kann über die Browserschaltfläche „Zurück“ zum vorherigen Dashboard zurückkehren. Bei false wird das aktuelle Dashboard ersetzt und die Browsernavigation kann nicht verwendet werden, um dorthin zurückzukehren.

dashboard:run

Verwenden Sie diese Aktion, um das Dashboard im iFrame auszuführen. Dies ist die gleiche Aktion wie das Klicken auf die Schaltfläche Ausführen oder Daten aktualisieren auf dem Dashboard.

{
  type: "dashboard:run"
}
Attribut Format Beschreibung
type String Die Verwendung des Typs dashboard:run bedeutet, dass Sie das Dashboard ausführen möchten.

dashboard:edit

ADDED 22.20 Mit dieser Aktion können Sie ein vorhandenes Dashboard im iFrame in den Bearbeitungsmodus versetzen. Dies ist die gleiche Aktion wie bei der Auswahl von Dashboard bearbeiten im Dashboard-Menü.

{
  type: "dashboard:edit"
}
Attribut Format Beschreibung
type String Die Verwendung des Typs dashboard:edit bedeutet, dass Sie das Dashboard in den Bearbeitungsmodus versetzen möchten.

dashboard:filters:update

Mit dieser Aktion können Sie einen vorhandenen Dashboardfilter im iFrame aktualisieren. Mit dieser Methode können Sie dem Dashboard keinen neuen Filter hinzufügen.

{
  type: "dashboard:filters:update",
  filters: {
    "Sale date": "Last 28 days",
    "Sale amount": "Greater than 100"
  }
}
Attribut Format Beschreibung
type String Die Verwendung des Typs dashboard:filters:update bedeutet, dass Sie die vom Dashboard verwendeten Filter aktualisieren möchten.
filters Objekt Die neuen Filter, die Sie auf das Dashboard anwenden möchten. Dieses Objekt hat folgendes Format: {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:options:set

Diese Aktion ist verfügbar, nachdem das Ereignis dashboard:run:complete eingetreten ist.

Der Einbettungscode erstellt die Nachricht und sendet sie an den iFrame. Das Dashboard reagiert jedoch erst, wenn dashboard:run:complete eintritt. Die Aktion dashboard:options:set schreibt neue Werte in die Eigenschaften des Dashboard-Layouts und des Dashboardelements. Nur Attribute, die im Attribut options des Ereignisses dashboard:run:complete zurückgegeben wurden, können mit dashboard:options:set aktualisiert werden. Alle Properties, die zuvor nicht vom Attribut options des Ereignisses dashboard:run:complete zurückgegeben wurden, werden ignoriert.

{
  type: "dashboard:options:set",
  layouts: [
    {
      id: 1,
      dashboard_id: 1,
      type: "newspaper",
      active: true,
      column_width: null,
      width: null,
      deleted: false,
      dashboard_layout_components: [
        {
          id: 1,
          dashboard_layout_id: 1,
          dashboard_element_id: 1,
          row: 0,
          column: 0,
          width: 8,
          height: 4,
          deleted: false
        },
        {
          id: 2,
          dashboard_layout_id: 1,
          dashboard_element_id: 2,
          row: 0,
          column: 8,
          width: 8,
          height: 4,
          deleted: false
        }
      ]
    }
  ],
  elements: {
    1: {
      title: "Total Orders",
      title_hidden: false,
      vis_config: {
        type: "single_value",
        font_size: "medium",
        title: "Total Orders"
      }
    },
    2: {
      title: "Average Order Profit",
      title_hidden: false,
      vis_config: {
        type: "single_value",
        title: "Average Order Profit"
      }
    }
  }
}
Attribut Format Beschreibung
type String Die Verwendung des Typs dashboard:options:set gibt an, dass Sie neue Werte in die Eigenschaften des Dashboard-Layouts und des Dashboardelements schreiben möchten.
layouts Objekt Die Eigenschaften für das Dashboard-Layout, die vom options-Attribut im dashboard:run:complete-Ereignis zurückgegeben werden. Sie haben ein ähnliches Format:

  • id: "string",
  • dashboard_id: "string",
  • type: "newspaper",
  • active: boolean,
  • column_width: number,
  • width: number
layouts.dashboard_layout_components Objekt Ein oder mehrere Objekte für die Dashboard-Layout-Komponente, die vom options-Attribut im dashboard:run:complete-Ereignis zurückgegeben wird. Sie haben ein ähnliches Format:

  • id: "string",
  • dashboard_layout_id: "string",
  • dashboard_element_id: "string",
  • row: number,
  • column: number,
  • width: number,
  • height: number,
  • deleted: boolean,
elements Objekt Ein oder mehrere Dashboard-Element-Objekte, die vom options-Attribut im dashboard:run:complete-Ereignis zurückgegeben werden. Sie haben ein ähnliches Format:

id: {

  title: "string",

  title_hidden: boolean,

  vis_config: {

    type: "string", title: "string"

  }

}

dashboard:schedule_modal:open

Mit dieser Aktion können Sie den Planer öffnen, mit dem Nutzer Looker-Inhalte an verschiedene Ziele senden können.

{
  type: "dashboard:schedule_modal:open"
}
Attribut Format Beschreibung
type String Wenn Sie den Typ dashboard:schedule_modal:open verwenden, bedeutet dies, dass Sie das Dialogfeld Zeitplan öffnen möchten.

dashboard:stop

Verwenden Sie diese Aktion, um ein Dashboard zu beenden, das ausgeführt wird oder Daten neu lädt. Dies ist die gleiche Aktion wie das Klicken auf die Schaltfläche Abbrechen auf dem Dashboard. Ein Dashboard, das dashboard:stop nicht mehr verwendet, sendet ein dashboard:run:complete-Ereignis, bei dem status: auf "stopped" festgelegt ist.

{
  type: "dashboard:stop"
}
Attribut Format Beschreibung
type String Die Verwendung des Typs dashboard:stop bedeutet, dass Sie das laufende Dashboard beenden möchten.

look:run

Verwenden Sie diese Aktion, um die Abfrage auszuführen, auf der der Look im iFrame basiert. Diese Aktion ähnelt dem Klicken auf die Schaltfläche Ausführen im Look mit der Ausnahme, dass look:run die Datenbank immer direkt abfragt und keine Daten aus dem Looker-Cache abruft.

{
  type: "look:run"
}
Attribut Format Beschreibung
type String Die Verwendung des Typs look:run bedeutet, dass Sie den Look ausführen möchten.

look:filters:update

Mit dieser Aktion können Sie einen vorhandenen Look-Filter im iFrame aktualisieren. Mit dieser Methode können Sie dem Look keinen neuen Filter hinzufügen.

{
  type: "look:filters:update",
  filters: {
    "orders.created_at": "90 days",
    "products.department": "sweaters"
  }
}
Attribut Format Beschreibung
type String Die Verwendung des Typs look:filters:update bedeutet, dass Sie die vom Look verwendeten Filter aktualisieren möchten.
filters Objekt Die neuen Filter, die Sie auf den Look anwenden möchten. Dieses Objekt hat folgendes Format: {"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...}

explore:run

Verwenden Sie diese Aktion, um das Explore im iFrame auszuführen. Diese Aktion ähnelt dem Klicken auf die Schaltfläche Ausführen im Explore, mit der Ausnahme, dass explore:run die Datenbank immer direkt abfragt und keine Daten aus dem Looker-Cache abruft.

{
  type: "explore:run"
}
Attribut Format Beschreibung
type String Die Verwendung des Typs explore:run bedeutet, dass Sie das Explore ausführen möchten.

explore:filters:update

Mit dieser Aktion können Sie einen Explore-Filter im iFrame aktualisieren oder entfernen. Wenn Sie einen neuen Filter einfügen, der auf ein gültiges Feld verweist, wird der neue Filter zum Explore hinzugefügt.

{
  type: "explore:filters:update",
  filters: {
    "orders.created_at": "90 days",
    "orders.status": "complete"
  }
  deleteFilters:  ["products.department"]
}
Attribut Format Beschreibung
type String Die Verwendung des Typs explore:filters:update bedeutet, dass Sie die vom Explore verwendeten Filter aktualisieren möchten.
filters Objekt Die neuen Filter, die Sie auf das Explore anwenden möchten. Wenn filters einen Filter enthält, der derzeit nicht im Explore vorhanden ist, aber auf ein gültiges Feld verweist, wird dieser Filter dem Explore hinzugefügt. Dieses Objekt hat folgendes Format: {"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...}
deleteFilters Array Die vorhandenen Filter, die Sie aus dem Explore entfernen möchten. Das Array hat folgendes Format: ["view_name.field_name_1", "view_name.field_name_2", ...]

session:tokens:request

Mit dieser Aktion können Sie Tokens als Antwort auf eine session:tokens:request-Anfrage senden.

{
  type: "session:tokens:request",
}
Attribut Format Beschreibung
type String Die Verwendung des Typs session:tokens:request gibt an, dass Sie Tokens als Reaktion auf ein session:tokens:request-Ereignis senden möchten.

env:host:scroll

Mit dieser Aktion können Sie Informationen zur aktuellen Scrollposition des Host-iFrames an die eingebettete Looker-Anwendung senden.

{
  type: "env:host:scroll",
  offsetTop: 10,
  offsetLeft: 10,
  scrollX: 5,
  scrollY: 5
}
Attribut Format Beschreibung
type String Mit dem Typ env:host:scroll bedeutet, dass Sie Informationen zur aktuellen Scrollposition des Host-iFrames an die eingebettete Looker-Anwendung senden möchten.
offsetTop Nummer Der Versatz am oberen Rand des iFrames.
offsetLeft Nummer Der Offset links vom iFrame.
scrollX Nummer Die scrollX-Position des Anwendungshosts.
scrollY Nummer Die scrollY-Position des Anwendungshosts.