初始設定

開發人員設定

啟用 Cloud 專案的 API 套件

  • 前往 Cloud 控制台：https://console.cloud.google.com/。
  • 選取現有的雲端專案或建立新專案。
  • 前往 APIs & Services > Enable APIs and Services。
  • 搜尋「Chrome」。
  • 選取「Chrome Management API」。
  • 熟悉《服務條款》。
  • 按一下「Enable」。

建立憑證

替代方法 1：OAuth 2.0 用戶端 ID

  • 您必須先使用應用程式相關資訊設定 OAuth 同意畫面，才能建立「OAuth 2.0 用戶端 ID」。前往 Cloud 控制台中的 APIs & Services > OAuth consent screen。

  • 請在同意畫面設定頁面中輸入範圍：

    • 針對 Reports API 新增：https://www.googleapis.com/auth/chrome.management.reports.readonly
    • 針對 App Details API 新增：https://www.googleapis.com/auth/chrome.management.appdetails.readonly
    • 針對 Telemetry API 新增：https://www.googleapis.com/auth/chrome.management.telemetry.readonly

    請注意，新增的範圍是敏感資訊，因此您可能需要將應用程式送交驗證。否則，如果您的應用程式不是內部應用程式，使用者可能會看到安全性警告畫面。

  • 前往 APIs & Services > Credentials > Create Credentials > OAuth client ID 並按照步驟建立憑證。

  • 或者，您也可以在 OAuth Playground 中測試應用程式 (請參閱操作說明)。

替代方法 2：服務帳戶

  • 前往 APIs & Services > Credentials > Create Credentials > Service account。
  • 輸入服務帳戶名稱，然後按一下「Create」。
  • 為服務帳戶建立金鑰。按一下 Add Key 並建立「json」金鑰。請將檔案記錄在安全的位置。
  • 使用具備適當的客戶管理員權限的服務帳戶：
    • 「客戶」可以設定全網域委派功能，然後服務帳戶就能模擬擁有適當權限的使用者/管理員 (請參閱做法)
    • 或客戶可將具備適當權限的管理員角色直接授予服務帳戶 (請參閱操作說明)。

為客戶進行設定

客戶管理員會根據開發人員建立的應用程式類型，使用不同的設定選項。

「OAuth 2.0 用戶端」應用程式

無需進行特殊設定。

應用程式使用者需要適當的管理員權限 (請參閱操作說明)。

應用程式使用者必須同意應用程式 OAuth 彈出式同意畫面。您也可以允許這個應用程式使用全網域委派功能 (請參閱做法)，這樣會略過使用者的 OAuth 彈出式同意畫面。

視需要確認應用程式是否未遭到封鎖或明確信任應用程式 (請參閱方法)。

「服務帳戶」應用程式

服務帳戶必須取得適當的管理員權限。您可以選擇下列其中一種操作方式：

  • 允許全網域委派功能，讓服務帳戶可模擬擁有適當權限的管理員 (請參閱方法)。
  • 直接授予服務帳戶的管理員角色 (請參閱操作說明)。

使用說明指南

如何封鎖或信任應用程式

  • 以客戶管理員身分前往管理控制台 (https://admin.google.com/)。
  • 前往 Security > Access and data control > API controls。
  • 在 App access control 部分中，按一下 Manage third party app access。
  • 如果在「已連結的應用程式」清單中找不到該應用程式，可以設定新的應用程式。
  • 您現在可以封鎖應用程式，或明確信任應用程式。

如何啟用全網域委派功能

  • 以客戶管理員身分前往管理控制台 (https://admin.google.com/)。
  • 前往 Security > Access and data control > API controls > Domain-wide delegation。
  • 按一下「Add new」。
  • 輸入用戶端 ID (「服務帳戶專屬 ID」或「應用程式用戶端 ID」)。
  • 輸入所有必要的 OAuth 範圍。視應用程式而定，您可能還需要輸入 Chrome Management API 的範圍 (例如透過 Directory API 管理裝置、使用者、瀏覽器、機構單位、群組等)。
  • 按一下「Authorize」。

如何管理管理員權限

而對於 Chrome Management API 的不同部分，就需要不同的管理員權限。請參閱 Reports API、App Details API 或 Telemetry API 所需的管理員權限。

如何授予權限：

  • 以客戶管理員身分前往管理控制台 (https://admin.google.com/)。
  • 前往「Admin roles」頁面。
  • 找出現有的角色，或是建立具備必要權限的新角色。
  • 請將這個角色指派給使用者電子郵件地址或服務帳戶電子郵件地址。

如何在 OAuth Playground 中測試應用程式

  • 在 Cloud 控制台中，為應用程式建立 OAuth 用戶端 ID (請參閱上述「OAuth 2.0 用戶端 ID」一節) 時，選取「網頁應用程式」。
  • 輸入「名稱」。
  • 如要測試應用程式，請在「已授權的重新導向 URI」欄位中新增 https://developers.google.com/oauthplayground。測試完畢後，您可以將重新導向 URI 從應用程式中移除。
  • 按一下「Create」，然後複製「用戶端 ID」和「用戶端密鑰」。
  • 前往 OAuth Playground
  • 按一下右上角的齒輪圖示 (「OAuth 2.0 設定」)，選取 Use your own OAuth credentials，然後輸入「OAuth 用戶端 ID」和「OAuth 用戶端密鑰」。

  • 請在 OAuth Playground 中按照以下步驟操作

    • 選取及授權 API。

      在範圍輸入欄位中新增 https://www.googleapis.com/auth/chrome.management.reports.readonly (或其他 API 範圍)，然後按一下「Authorize API」。 使用客戶管理員帳戶進行授權。同意條款。

    • 交換權杖的授權碼。

      按一下 Exchange authorization code for tokens，視需要按一下 Auto-refresh the token before it expires。

    • 設定傳送至 API 的要求。

      在「要求 URI」文字方塊中輸入 API 網址。根據 API 規格修改「HTTP 方法」和「輸入要求主體」等。 舉例來說，使用下列網址計算貴機構中安裝的應用程式：https://chromemanagement.googleapis.com/v1alpha1/customers/my_customer/reports:countInstalledApps