Data Studio API

Mit der Data Studio API können Sie nach Data Studio-Assets suchen und diese verwalten.

Der primäre Anwendungsfall für die API besteht darin, Google Workspace- oder Cloud Identity-Organisationen die Automatisierung der Verwaltung und Migration von Data Studio-Assets zu ermöglichen.

Wichtig :Die API ist nur für Nutzer verfügbar, die einer Organisation mit Google Workspace oder Cloud Identity angehören.

Übersicht über die Anforderungen

Für die Verwendung der Data Studio API sind folgende Schritte erforderlich:

1. App für die Verwendung der API konfigurieren
2. App über die Admin-Konsole autorisieren
3. OAuth 2.0-Zugriffstokens abrufen und die API aufrufen

Die oben genannten Schritte können je nach den folgenden gängigen Szenarien von derselben oder von verschiedenen Organisationen ausgeführt werden:

• Interne Apps, die für eine Organisation entwickelt wurden. Die Organisation konfiguriert und autorisiert die App für alle Nutzer in der Organisation.
• Drittanbieter-Apps, die für externe Nutzer/Kunden entwickelt wurden (d.h. Entwickler und Nutzer gehören verschiedenen Organisationen an). Der Entwickler konfiguriert die App, die Organisation des Nutzers autorisiert die Drittanbieter-App.

1. App für die Verwendung der API konfigurieren

Führen Sie die folgenden Schritte aus, um Ihre App zu konfigurieren:

• API aktivieren
• OAuth-Client erstellen

API aktivieren

So aktivieren Sie eine API für Ihr Projekt:

1. Öffnen Sie die [Data Studio API] in der Google API Console.
2. Wählen Sie ein Projekt aus oder erstellen Sie ein neues, wenn Sie dazu aufgefordert werden.
3. Klicken Sie auf Aktivieren.
4. Lesen und akzeptieren Sie die Nutzungsbedingungen der API, wenn Sie dazu aufgefordert werden.

OAuth-Client erstellen

Die folgenden Schritte zum Erstellen eines OAuth-Clients sind allgemeine Richtlinien und sollten an die Anforderungen Ihrer App angepasst werden.

Wichtig :Fügen Sie Ihrem OAuth-Client keine Data Studio-Gültigkeitsbereiche hinzu. Die Bereiche werden vom Workspace-Administrator hinzugefügt, wenn er die App autorisiert.

1. Rufen Sie OAuth-Zustimmungsbildschirm konfigurieren auf.
   1. Wählen Sie Intern aus und klicken Sie auf Erstellen.
   2. Füllen Sie die Pflichtfelder aus und klicken Sie auf Speichern.
2. Rufen Sie Anmeldedaten auf.
   1. Klicken Sie auf ANMELDEDATEN ERSTELLEN.
   2. Wählen Sie OAuth Client-ID.
   3. Wählen Sie die entsprechende Application Type aus. (Webanwendungen sind am häufigsten).
   4. Füllen Sie die Pflichtfelder aus und klicken Sie auf Erstellen.
3. Notieren Sie sich die Client-ID, da sie zum Autorisieren der App verwendet wird.

2. App für eine Organisation autorisieren

Apps, die die Data Studio API verwenden, können Google Workspace-Nutzer nur authentifizieren und autorisieren, wenn die Organisation des Nutzers die App mithilfe der domainweiten Delegation zur Steuerung des API-Zugriffs autorisiert hat.

Konfigurieren Sie die domainweite Delegation mit der OAuth-Client-ID der App und den von der App benötigten Bereichen.

Wichtig :Die folgenden Schritte müssen von einem Workspace-Administrator ausgeführt werden. Der Administrator benötigt die OAuth-Client-ID der App und eine Liste der von der App benötigten OAuth-Bereiche.

1. Melden Sie sich in der Google Admin-Konsole an und rufen Sie die domainweite Delegation auf.
2. Klicken Sie unter API clients auf Neu hinzufügen.
3. Geben Sie die Client ID der App ein, die autorisiert werden soll (d.h. der App, die die Data Studio API verwendet).
4. Geben Sie alle von der App benötigten OAuth-Bereiche ein. Die folgenden Bereiche werden häufig angefordert, wenn die Data Studio API zum Verwalten von Assets verwendet wird:
   • https://www.googleapis.com/auth/datastudio
   • https://www.googleapis.com/auth/userinfo.profile
5. Klicken Sie auf Autorisieren.

Hinweis :Wenn Ihre App keine Data Studio-Assets verwalten muss, sollten Sie anstelle von https://www.googleapis.com/auth/datastudio den restriktiveren Bereich https://www.googleapis.com/auth/datastudio.readonly verwenden.

Nachdem die App autorisiert wurde, wird jeder Workspace-Nutzer, der der Organisation angehört, automatisch für die Verwendung der App mit der Data Studio API autorisiert.

3. OAuth 2.0-Zugriffstokens abrufen und die API aufrufen

Nachdem Sie die App entwickelt und autorisiert haben, haben Sie den erforderlichen Zugriff, um die API für Workspace-Nutzer aufzurufen. Weitere Informationen zur Verwendung von OAuth mit Google APIs finden Sie unter Mit OAuth 2.0 auf Google APIs zugreifen. Informationen zu den verfügbaren Vorgängen finden Sie in der API-Referenz.

Fehlerbehebung

Fehlendes OAuth-Dialogfeld

Wenn die Organisation eines Nutzers die App autorisiert hat, wird Nutzern dieser Organisation bei der Autorisierung der App kein OAuth-Dialogfeld angezeigt. Die einzige Ausnahme ist, wenn die App die Autorisierung für zusätzliche Google API-Bereiche anfordert, die der Workspace-Administrator nicht konfiguriert hat. In diesem Fall wird Nutzern das OAuth-Dialogfeld angezeigt.

Fehler 400: invalid_scope

Wenn ein Nutzer beim Versuch, die App zu autorisieren, die Meldung Error 400: invalid_scope erhält, hat die Organisation des Nutzers die App nicht oder nicht richtig autorisiert. Um das Problem zu beheben, muss der Nutzer seine Organisation bitten, die App zu autorisieren.