Google Apps 脚本快速入门

快速入门介绍了如何设置和运行调用 Google Workspace API 的应用。

Google Workspace 快速入门使用 API 客户端库来处理身份验证和授权流程的一些细节。我们建议您将客户端库用于自己的应用。本快速入门使用适合测试环境的简化身份验证方法。对于生产环境，我们建议您先了解身份验证和授权，然后再选择适合您的应用的访问凭据。

创建一个用于向 Google Chat API 发出请求的 Google Apps 脚本。

目标

  • 配置环境。
  • 创建并配置脚本。
  • 运行脚本。

前提条件

配置 Cloud 项目

如果您使用新的 Google Cloud 项目来完成此快速入门，则需要对其进行配置并将自己添加为测试用户。如果您已经为自己的 Cloud 项目完成这些步骤，请跳到下一部分。

在 Google Cloud 控制台中打开您的 Cloud 项目

如果尚未打开，请打开您打算用于此示例的 Cloud 项目：

  1. 在 Google Cloud 控制台中，前往选择项目页面。

    选择 Cloud 项目

  2. 选择您要使用的 Google Cloud 项目。或者，点击创建项目，然后按照屏幕上的说明操作。如果您创建的是 Google Cloud 项目，则可能需要为项目启用结算功能。

启用 Chat API

在使用 Google API 之前，您需要在 Google Cloud 项目中启用它们。您可以在单个 Google Cloud 项目中启用一个或多个 API。

  • 在 Google Cloud 控制台中，启用 Google Chat API。

    启用 API

  1. 在 Google Cloud 控制台中，依次点击“菜单”图标 > API 和服务 > OAuth 同意屏幕。

    转到 OAuth 同意屏幕

  2. 在用户类型字段中，选择内部，然后点击创建。
  3. 填写应用注册表单，然后点击保存并继续。

  4. 目前，您可以跳过添加镜重，直接点击保存并继续。 今后，如果您创建的应用要在 Google Workspace 组织之外使用，则必须将用户类型更改为外部，然后添加应用所需的授权范围。

  5. 查看应用注册摘要。如需进行更改，请点击修改。如果应用注册未出现任何问题，请点击返回信息中心。

配置 Google Chat 应用

如需调用 Google Chat API，您必须配置 Google Chat 应用。对于任何写入请求，Google Chat 都会使用以下信息在界面中归因 Google Chat 应用。

  1. 在 Google Cloud 控制台中，前往 Chat API 配置页面：

    前往“Chat API 配置”页面

  2. 在应用信息下，输入以下信息：

    1. 在应用名称字段中，输入 Chat API quickstart app。
    2. 在头像网址字段中，输入 https://developers.google.com/chat/images/quickstart-app-avatar.png。
    3. 在说明字段中，输入 Quickstart for calling the Chat API。

  3. 在互动功能下，将启用互动功能切换开关切换到关闭位置，以停用 Chat 应用的互动功能。

  4. 点击保存。

创建脚本

  1. 前往 script.google.com/create 创建新脚本。
  2. 将脚本编辑器中的内容替换为以下代码：

chat/quickstart/Code.gs
/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken
    });
    // Handle response pages
    if (responsePage.spaces) {
      responsePage.spaces.forEach((space) => console.log(space));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

  1. 点击“保存”图标 。
  2. 点击未命名项目，输入 Quickstart，然后点击重命名。

配置脚本

复制 Cloud 项目编号

  1. 在 Google Cloud 控制台中，依次选择“菜单”图标 > IAM 和管理 > 设置。

    前往“IAM 和管理”设置

  2. 在项目编号字段中，复制相应值。
  1. 打开 Apps 脚本项目。
  2. 点击 Project Settings 图标 。
  3. 在 Google Cloud Platform (GCP) 项目下，点击更改项目。
  4. 在 GCP 项目编号中，粘贴 Google Cloud 项目编号。
  5. 点击设置项目。

启用 Google Chat API

  1. 打开 Apps 脚本项目。
  1. 点击项目设置 。
  2. 在常规设置下，启用在编辑器中显示“appsscript.json”清单文件。
  3. 点击 Editor ，选择文件 appscript.json，然后将内容替换为以下代码：

chat/quickstart/appsscript.json
{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.spaces.readonly"
  ],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [{
      "userSymbol": "Chat",
      "version": "v1",
      "serviceId": "chat"
    }]
  }
}

运行示例

在 Apps 脚本编辑器中，点击运行。

首次运行该示例时，系统会提示您授予访问权限：

  1. 点击查看权限。
  2. 选择账号。
  3. 点击允许。

脚本的执行日志会显示在窗口底部。

后续步骤