Einbettungs-URL erstellen

Version 4.0.23.6 (neueste Version)

Einbettungs-URL erstellen

Erstellt eine eingebettete URL, die als Looker-Nutzer ausgeführt wird, der diesen API-Aufruf durchführt. („Als mich einbetten“) Diese Einbettungs-URL kann dann verwendet werden, um eine Einbettung von Looker in einer PBL-Webanwendung (Powered by Looker) zu instanziieren.

Dies ist ähnlich wie beim privaten Einbetten (https://cloud.google.com/looker/docs/r/admin/Embed/private-Embed). Anstatt sich zur Authentifizierung in der Web-UI anzumelden, hat sich der Nutzer bereits für die API authentifiziert, um diesen Aufruf ausführen zu können. Im Gegensatz zum privaten Einbetten, bei dem der Nutzer Zugriff auf einen anderen Teil der Looker-UI hat, hat die eingebettete Websitzung, die durch das Anfordern der EmbedUrlResponse.url in einem Browser erstellt wird, nur Zugriff auf die Inhalte, die im Kontext von /embed sichtbar sind.

Eine eingebettete URL kann nur einmal verwendet werden und muss innerhalb von fünf Minuten nach ihrer Erstellung verwendet werden. Nachdem sie zum Anfordern einer Seite vom Looker-Server verwendet wurde, ist die URL ungültig. Zukünftige Anfragen mit derselben URL schlagen fehl. Dadurch soll ein wiederholter Angriff verhindert werden.

Das Attribut target_url muss eine vollständige URL einer eingebetteten Looker-Benutzeroberfläche sein – Schema, Hostname, Pfad, der mit „/Embed“ und Abfrageparametern beginnt. Um ein Dashboard mit der ID 56 und dem Filter Date=1 years zu laden, würde die Looker-Einbettungs-URL so aussehen: https://myname.looker.com/embed/dashboards/56?Date=1%20years. Um diese target_url zu erhalten, rufen Sie in Ihrem Webbrowser die gewünschte Looker-Seite auf. Kopieren Sie dann die in der Adressleiste des Browsers angezeigte URL, fügen Sie nach dem Host/Port die URL „/Embed“ ein und fügen Sie sie in dieser API-Anfrage als Wert in Anführungszeichen ein.target_url

Sicherheitshinweis

Schützen Sie diese eingebettete URL wie einen Zugriffstoken oder ein Passwort. Schreiben Sie sie nicht auf ein Laufwerk, geben Sie sie nicht an Dritte weiter und leiten Sie sie nur über eine sichere HTTPS-verschlüsselte Übertragung weiter.

Anfrage

POST /Embed/token_url/me
Datentyp
Beschreibung
Anfrage
HTTPRequest
body
HTTP-Text
HTTPBody-Definition maximieren...
body
Parameter einbetten
EmbedParams-Definition maximieren...
target_url
String
Die vollständige URL der Looker-UI-Seite, die im eingebetteten Kontext angezeigt wird. Um das Dashboard mit der ID 34 anzuzeigen, würde „target_url“ in etwa so aussehen: „https://mycompany.looker.com:9999/dashboards/34“. „target_uri“ MUSS ein Schema (HTTPS), einen Domainnamen und einen URL-Pfad enthalten. Der Port muss enthalten sein, wenn der Looker-Server über Browserclients erreicht werden muss. Wenn sich die Looker-Instanz hinter einem Load-Balancer oder einem anderen Proxy befindet, muss „target_uri“ der öffentlich zugängliche Domainname und der Port sein, die zum Erreichen der Looker-Instanz erforderlich sind, nicht der tatsächliche interne Netzwerkmaschinenname der Looker-Instanz.
Sitzungslänge
integer
Anzahl der Sekunden, die die SSO-Einbettungssitzung gültig ist, nachdem sie gestartet wurde. Die Standardeinstellung ist 300 Sekunden. Die maximal zulässige Länge der Sitzung beträgt 259.2000 Sekunden (30 Tage).
erzwungene_Abmeldung
boolean
Wenn „true“ festgelegt ist, werden alle verbleibenden Looker-Anmeldestatus (z. B. in Browser-Cookies) dauerhaft gelöscht, bevor ein neuer Anmeldestatus mit den angegebenen eingebetteten Nutzerinformationen erstellt wird. Der Standardwert ist „true“.

Antwort

200: URL einbetten

Datentyp
Beschreibung
(Objekt)
URL
String
Die Einbettungs-URL. Wenn Sie diesen String ändern, kann die URL nicht mehr verwendet werden.

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