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 控制台中開啟 Looker Studio API
  2. 按照系統說明選取專案,或建立新專案。
  3. 按一下「啟用」
  4. 如果系統顯示提示,請詳閱並接受 API 的《服務條款》。

建立 OAuth 用戶端

建立 OAuth 用戶端的步驟為通用指南,請進行調整以符合應用程式需求。

  1. 前往「設定 OAuth 同意畫面」
    1. 選擇「Internal」(內部),然後按一下「Create」(建立)
    2. 填妥必填欄位,然後按一下「儲存」
  2. 前往「憑證」
    1. 按一下「建立憑證」
    2. 選取「OAuth 用戶端 ID」
    3. 選擇適當的 Application Type。(最常用網頁應用程式)。
    4. 填妥必填欄位。
  3. 請記下「Client ID」(用戶端 ID),因為這個 ID 是用來授權應用程式。

2. 為應用程式授權應用程式

應用程式採用 Looker Studio API 時,只有在使用者所屬機構透過全網域委派功能控管 API 存取權時,才能授權並授權 Google Workspace 使用者存取該應用程式。

使用應用程式的 OAuth 用戶端 ID 和應用程式所需的範圍來設定全網域委派

  1. 登入 Google 管理控制台,然後前往全網域委派
  2. API clients 中,按一下「Add new」(新增)
  3. 輸入要授權的應用程式 Client ID (例如使用 Looker Studio API 的應用程式)。
  4. 輸入應用程式所需的「所有」OAuth 範圍。使用 Looker Studio API 管理素材資源時,經常要求下列範圍:
    • https://www.googleapis.com/auth/datastudio
    • https://www.googleapis.com/auth/userinfo.profile
  5. 按一下「授權」。

授權應用程式後,凡是屬於該機構的 Workspace 使用者都會自動獲得授權,以便搭配 Looker Studio API 使用應用程式。

3. 取得 OAuth 2.0 存取權杖及呼叫 API

開發並授權應用程式之後,您將擁有呼叫 Workspace for Workspace 使用者的必要權限。如要進一步瞭解如何透過 OAuth 使用 Google API,請參閱使用 OAuth 2.0 存取 Google API。如需可用操作,請參閱 API 參考資料

疑難排解

缺少 OAuth 對話方塊

如果使用者的機構已授權應用程式,授權該應用程式時就不會顯示 OAuth 對話方塊。但如果應用程式要求授權的 Workspace API 範圍尚未設定其他 Google API 範圍,則只能向使用者顯示 OAuth 對話方塊;在這種情況下,系統會向使用者顯示 OAuth 對話方塊。

400 錯誤:invalid_scope

如果使用者嘗試授權應用程式時會收到 Error 400: invalid_scope 訊息,表示使用者所屬的機構未正確授權應用程式。如要解決問題,使用者必須要求機構授權給應用程式。

收到要求的無效範圍的 OAuth 400 錯誤訊息