初始设置

开发者设置

为云项目启用 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 部分）时，选择“Web 应用”应用类型。
  • 输入“名称”。
  • 如需测试您的应用，请将 https://developers.google.com/oauthplayground 添加到“已获授权的重定向 URI”字段中。完成测试后，您可以从应用中移除重定向 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 范围），然后点击“授权 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