Die Looker API 4.0 ist in Looker 22.4 allgemein verfügbar. Die allgemein verfügbare API 4.0 (API 4.0 GA) enthält mehrere bahnbrechende und ergänzende Änderungen und fördert mehrere Endpunkte von der Betaversion zur stabilen Version. Detaillierte API 4.0-Spezifikationen finden Sie in der API-Referenz. Wir haben unsere von Looker und von der Community unterstützten SDKs aktualisiert, um Looker API 4.0 GA-Endpunkte zu unterstützen. Weitere Informationen finden Sie unter API- und SDK-Supportrichtlinien und API-Versionsverwaltung. Im Rest dieses Artikels werden die funktionsgefährdenden Änderungen, Abhilfemaßnahmen und Funktionen beschrieben, die Sie bei der Migration zur API 4.0 GA erwarten können.
An wen richtet sich dieser Artikel?
Dieses Dokument richtet sich an Nutzer, die die Looker API über von Looker unterstützte SDKs, von der Community unterstützte SDKs oder die API selbst verwenden. Lesen Sie den folgenden Abschnitt, der der von Ihnen verwendeten Looker API-Version entspricht.
Nutzer der Pre-GA API 4.0
Wenn Sie API 4.0 verwenden, lesen Sie diesen Abschnitt. Darin werden die grundlegenden Änderungen und verfügbaren Abhilfemaßnahmen bei der Migration zur API 4.0 GA beschrieben.
In API 4.0 GA werden alle Entitäts-ID-Felder vom numerischen Typ „integer
“ in „string
“ geändert. Beispiel: GET /groups/{group_id}
endpoint gibt id
als Typ string
statt als Typ int64
zurück.
In der folgenden Tabelle finden Sie Informationen zu den Auswirkungen und Abhilfemaßnahmen, die sich speziell auf Ihre API 4.0-Endpunktnutzung beziehen:
Nutzung | Mögliche Auswirkungen1 | vermeiden |
Mobile Looker-Apps | Alte Installationen der mobilen Looker-Apps funktionieren nicht mehr | Nutzer auf die neueste Version der mobilen Looker-App(s) aktualisieren |
Von Looker unterstützte 2 SDKs | ||
TypeScript SDK (4.0 API) | Keine Auswirkungen | Keine Aktion erforderlich |
Python SDK (4.0 API) | Keine Auswirkungen | Keine Aktion erforderlich |
Ruby SDK (4.0 API) | Keine Auswirkungen | Keine Aktion erforderlich |
Von der Community unterstützte2 SDKs | ||
Swift-SDK | Laufzeitausnahmen | SDK auf Version 22.0 oder höher aktualisieren; Beheben Sie ggf. auftretende Typfehler |
Kotlin SDK | Keine Auswirkungen | Keine Aktion erforderlich |
LookR SDK | Keine Auswirkungen | Keine Aktion erforderlich |
C# SDK | Keine Auswirkungen | Keine Aktion erforderlich |
Go SDK | Laufzeitausnahmen | SDK auf Version 22.0 oder höher aktualisieren; Beheben Sie ggf. auftretende Typfehler |
Andere | ||
Verwendung der API 4.0 ohne SDK (oder mit extern bereitgestellten Bibliotheken) | Mögliche Laufzeitfehler, je nach Typsensitivität der Sprache | Prüfen Sie den Code auf Abhängigkeiten vom Typ von ID-Feldern und fügen Sie Unterstützung für ID-Felder vom Typ „String“ hinzu. Lesen Sie auch diese zusätzliche Anleitung. |
1: Annahme gängiger Nutzungsmuster, die die Verwendung der ID-Felder von Looker umfassen können, aber keine ungewöhnlichen Nutzungsmuster wie das Anwenden numerischer Vorgänge auf IDs.
2: Unterstützung für Looker API und SDK Von der Community unterstützte Bibliotheken werden von Looker nicht offiziell unterstützt.
API 3.1-Nutzer
Wenn Sie API 3.1 verwenden, lesen Sie diesen Abschnitt. Darin werden die zusätzlichen Funktionen und Änderungen beschrieben, die Ihnen durch API 4.0 zur Verfügung gestellt werden. Alle von Looker und der Community unterstützten SDKs unterstützen hauptsächlich API 4.0. Weitere Informationen finden Sie unter SDK- und API-Supportrichtlinien.
Weitere GA-Funktionen der API 4.0
Im Folgenden finden Sie eine Liste der wichtigsten und nützlichsten Änderungen an der 4.0-Version der Additive API:
- Erstellen und Verwalten von Boards, Board-Elementen und Board-Bereichen Weitere Informationen zu Boards finden Sie auf der Board-Dokumentationsseite.
- Fragen Sie zusätzliche Verbindungsinformationen wie Datenbanken, Schemas, Spalten und Tabellen ab. Legen Sie zusätzliche Verbindungsfelder fest und aktualisieren Sie sie.
- Erstellung und Verwaltung von OAuth-Apps und -Nutzern Weitere Informationen zu OAuth finden Sie auf der OAuth-Dokumentationsseite.
- Suchen Sie nach Gruppen mit Hierarchie und Rollen.
- Rollen mit Nutzeranzahl suchen
- Einstellungen für Looker-Instanzen abrufen und festlegen Weitere Informationen zu den Einstellungen finden Sie auf der Dokumentationsseite zu den Einstellungen.
- Benachrichtigungen erstellen und verwalten Weitere Informationen zu Benachrichtigungen finden Sie auf der Dokumentationsseite zu Benachrichtigungen.
- SSH-Tunnel und SSH-Server erstellen, verwalten und testen Weitere Informationen zu SSH finden Sie auf der SSH-Dokumentationsseite.
- Dashboards verschieben und kopieren
- Relative URLs für neue Dashboards abrufen
- Sie können Looks verschieben und kopieren.
- Signierte Einbettung und nicht signierte Einbettungs-Secrets, URLs sowie Nutzererstellung und ‐verwaltung
- Rufen Sie ein Aktualisierungstoken ab, um das Zugriffstoken für die Anmeldung zu aktualisieren.
- Begrenzen und verschieben Sie die Ergebnisse aus dem Abrufen von allen LookML-Modellen und allen Nutzern.
- Begrenzen und verschieben Sie die Ergebnisse der Suche nach Nutzern.
- API-Spezifikation für Looker-Instanz in Swagger 2.x JSON abrufen
Änderungen bei der Einstellung der API 4.0 in der GA
API 4.0 GA ersetzt mehrere eingestellte API 3.1-Endpunkte durch verbesserte Funktionen. Die folgenden Endpunkte sind betroffen:
- Eingestellte Startseiten-Endpunkte wurden entfernt. Verwenden Sie stattdessen Board-Endpunkte. Weitere Informationen finden Sie unter Inhalte mit Boards präsentieren.
- Die eingestellten Gruppenbereich-Endpunkte wurden entfernt. Verwenden Sie Ordnerendpunkte anstelle von Gruppenbereichen. Weitere Informationen finden Sie unter Zugriff auf Inhalte organisieren und verwalten.
API 3.0-Nutzer
Die API 3.0 wird eingestellt. Wir empfehlen Ihnen, zu API 4.0 zu migrieren.
- Nur API 4.0 unterstützt alle von Looker und von der Community unterstützten SDKs, um Ihnen die Entwicklung zu erleichtern. Weitere Informationen finden Sie in unserem SDK-Repository.
- API 4.0 bietet mehrere neue Funktionen und Verbesserungen, die im Abschnitt Zusätzliche GA-Funktionen von API 4.0 auf dieser Seite aufgeführt sind.
Zusammenfassung
Freuen Sie sich auf neue Funktionen und additive Änderungen, die zu API 4.0 hinzugefügt werden. Die neuesten Änderungen finden Sie jederzeit in unserer API-Referenz. Weitere Informationen finden Sie unter API- und SDK-Supportrichtlinien und API-Versionsverwaltung. Uns ist bewusst, dass funktionsgefährdende Änderungen nicht ideal sind. Sofern kein schwerwiegendes Problem auftritt, nehmen wir keine funktionsgefährdenden Änderungen an der allgemein verfügbaren API 4.0 vor. Wir hoffen, dass Sie mit der allgemein verfügbaren Looker API 4.0 noch produktiver und einfacher auf der Looker-Plattform entwickeln können.