Looker Studio API

Looker Studio API を使用すると、Looker Studio のアセットを検索および管理できます。

この API の主なユースケースは、Google Workspace または Cloud Identity を利用している組織が、Looker Studio アセットの管理と移行を自動化できるようにすることです。

要件の概要

Looker Studio API を使用するには、次の手順が必要です。

  1. API を使用するようにアプリを設定する
  2. Google 管理コンソールでアプリを承認する
  3. OAuth 2.0 アクセス トークンを取得して API を呼び出す

上記の手順は、すべて同じ組織が行う場合も、そうでない場合もあります。一般的なシナリオは次のとおりです。

  • 自社向けに開発された社内アプリ: アプリの設定も承認も、その会社（組織）が行います。
  • 外部のユーザー / 顧客向けに開発されたサードパーティ アプリ（開発者とユーザーの所属組織が異なる）: アプリの設定は開発元が行いますが、そのアプリをサードパーティのアプリとして承認するのはユーザーの所属組織です。

1. API を使用するようにアプリを設定する

アプリを設定するには以下を行います。

API を有効化する

プロジェクトで API を有効にするには:

  1. Google API Console で Looker Studio API を開きます。
  2. プロンプトが表示されたら、プロジェクトのいずれかを選択するか、新しいプロジェクトを作成します。
  3. [有効にする] をクリックします。
  4. プロンプトが表示されたら、API の利用規約を確認し、同意します。

OAuth クライアントを作成する

以下の OAuth クライアント作成手順は一般的なガイドラインです。実際の操作はアプリの要件に応じて調整してください。

  1. OAuth 同意画面の設定を開きます。
    1. [内部] を選択し、[作成] をクリックします。
    2. 必要な項目を入力し、[保存] をクリックします。
  2. [認証情報] 画面を開きます。
    1. [認証情報を作成] をクリックします。
    2. [OAuth クライアント ID] を選択します。
    3. 適切な Application Type を選択します（ウェブ アプリケーションが最も一般的です）。
    4. 必要な項目を入力し、[作成] をクリックします。
  3. クライアント ID はアプリの承認に使用するためメモしておきます。

2. アプリを組織で使用できるよう承認する

Looker Studio API を使用しているアプリが Google Workspace ユーザーを認証・承認できるのは、そのユーザーの組織がドメイン全体の委任による API アクセスの制御を使って該当アプリを承認済みの場合のみです。

アプリの OAuth クライアント ID とアプリが必要とするスコープで、ドメイン全体の委任の設定を行います。

  1. Google 管理コンソールにログインしてドメイン全体の委任を開きます。
  2. [API clients] で [新しく追加] をクリックします。
  3. 承認するアプリ（Looker Studio API を使用するアプリ）の Client ID を入力します。
  4. アプリが必要とする OAuth スコープをすべて入力します。Looker Studio API をアセットの管理に使用する場合、一般的にリクエストされるのは次のスコープです。
    • https://www.googleapis.com/auth/datastudio
    • https://www.googleapis.com/auth/userinfo.profile
  5. [承認] をクリックします。

アプリを承認すると、組織に所属する Google Workspace ユーザーはすべて、Looker Studio API を使ったアプリの利用を自動的に承認されます。

3. OAuth 2.0 アクセス トークンの取得と API の呼び出し

アプリの開発と承認が済むと、Google Workspace ユーザー用に API を呼び出すために必要なアクセス権が得られます。OAuth を使った Google の API の扱いについて詳しくは、Using OAuth 2.0 to Access Google APIs をご覧ください。利用可能な操作は、API リファレンスでご確認いただけます。

トラブルシューティング

OAuth ダイアログが表示されない

組織がアプリを承認済みの場合、その組織のユーザーがアプリを承認する際には OAuth ダイアログが表示されません。唯一例外となるのは、Google Workspace の管理者が設定していなかった Google API スコープの承認をアプリが追加でリクエストしているケースで、この場合はユーザーに OAuth ダイアログが表示されます。

エラー 400: invalid_scope

ユーザーがアプリの承認を試みた際に Error 400: invalid_scope メッセージが表示される場合、所属組織によるアプリの承認が済んでいないか、正しく行われていません。この問題を解決するには、アプリを承認するよう所属組織に要請する必要があります。

無効なスコープがリクエストされたことを示す OAuth 400 エラー メッセージ