Looker Studio API

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

Der primäre Anwendungsfall für die API besteht darin, Google Workspace- oder Cloud Identity-Organisationen zu erlauben, die Verwaltung und Migration von Looker Studio-Assets zu automatisieren.

Anforderungen – Übersicht

Folgende Schritte sind zur Verwendung der Looker Studio API erforderlich:

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

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

  • Interne Apps, die für eine Organisation entwickelt wurden. Die Organisation konfiguriert und autorisiert die App für alle Nutzer in ihrer Organisation.
  • Drittanbieter-Apps, die für externe Nutzer/Kunden entwickelt wurden, also für Entwickler und Nutzer, die verschiedenen Organisationen gehören Der Entwickler konfiguriert die App, aber die Organisation des Nutzers autorisiert die Drittanbieter-App.

1) App für die Verwendung der API konfigurieren

So konfigurieren Sie Ihre App:

API aktivieren

So aktivieren Sie eine API für Ihr Projekt:

  1. Öffnen Sie die Looker Studio API in der Google API Console.
  2. Wenn Sie dazu aufgefordert werden, wählen Sie ein Projekt aus oder erstellen Sie ein neues.
  3. Klicken Sie auf Aktivieren.
  4. Wenn Sie dazu aufgefordert werden, lesen und akzeptieren Sie die Nutzungsbedingungen der API.

OAuth-Client erstellen

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

  1. Gehen Sie zu OAuth-Zustimmungsbildschirm konfigurieren.
    1. Wählen Sie Intern aus und klicken Sie auf Erstellen.
    2. Füllen Sie die Pflichtfelder aus und klicken Sie auf Speichern.
  2. Gehen Sie zu Anmeldedaten.
    1. Klicken Sie auf ANMELDEDATEN ERSTELLEN.
    2. Wählen Sie OAuth Client-ID.
    3. Wähle die geeignete Application Type aus. (Webanwendung ist 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

Mit der Looker Studio API können nur Google Workspace-Nutzer authentifiziert und autorisiert werden, auf deren Basis die Organisation des Nutzers die App mit der domainweiten Delegierung zum Steuern des API-Zugriffs autorisiert hat.

Konfigurieren Sie die domainweite Delegierung mit der OAuth-Client-ID der Anwendung und den für die Anwendung erforderlichen Bereichen.

  1. Melden Sie sich in der Admin-Konsole an und rufen Sie die domainweite Delegierung auf.
  2. Klicken Sie in API clients auf Neu hinzufügen.
  3. Geben Sie den Client ID der Anwendung ein, die autorisiert werden soll (d.h. die Anwendung, die die Looker Studio API verwendet).
  4. Geben Sie alle OAuth-Bereiche ein, die für die App erforderlich sind. Wenn Sie Assets mit der Looker Studio API verwalten, werden normalerweise die folgenden Bereiche angefordert:
    • https://www.googleapis.com/auth/datastudio
    • https://www.googleapis.com/auth/userinfo.profile
  5. Klicken Sie auf Authorize (Autorisieren).

Nach der Autorisierung der Anwendung wird jeder Workspace-Nutzer der Organisation automatisch autorisiert, die App mit der Looker Studio API zu verwenden.

3. OAuth 2.0-Zugriffstokens abrufen und API aufrufen

Sobald Sie die App entwickelt und autorisiert haben, erhalten Sie die erforderlichen Zugriffsrechte, um die API für Workspace-Nutzer aufzurufen. Weitere Informationen zur Verwendung von Google APIs mit OAuth finden Sie unter OAuth 2.0 für den Zugriff auf Google APIs verwenden. Verfügbare Vorgänge finden Sie in der API-Referenz.

Fehlerbehebung

OAuth-Dialogfeld fehlt

Wenn die Organisation eines Nutzers die App autorisiert hat, wird Nutzern bei der Autorisierung der App das OAuth-Dialogfeld nicht angezeigt. Dies ist die einzige Ausnahme, wenn die App eine Autorisierung für zusätzliche Google API-Bereiche anfordert, die vom Workspace-Administrator nicht konfiguriert wurden. In diesem Fall wird den 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 falsch autorisiert. Zur Behebung des Problems muss der Nutzer die Genehmigung durch die Organisation anfordern.

Eine OAuth 400-Fehlermeldung, die angibt, dass ein ungültiger Bereich angefordert wurde