使用 Google Apps 脚本构建 Google Chat 应用

本页介绍了如何使用 Google Apps 脚本构建可在 Google Chat 中使用的 Google Workspace 插件。在 Google Chat 中，插件会以 Google Chat 应用的形式向用户显示。如需了解详情，请参阅扩展 Google Chat 概览。

借助 Chat 应用，您可以直接发送消息，并且应用会通过回显您的消息进行回复。

下图展示了架构和消息传递模式：

在上图中，与 Apps Script Chat 应用互动的用户的信息流如下所示：

1. 用户通过私信或 Chat 聊天室向 Chat 应用发送消息。
2. 在 Google Cloud 中托管的 Apps 脚本中实现的 Chat 应用逻辑会接收并处理消息。
3. Chat 应用逻辑可以选择与 Google Workspace 服务（例如 Google 日历或 Google 表格）或其他 Google 服务（例如 Google 地图或 YouTube）集成。
4. Chat 应用逻辑会将响应发送回 Chat 中的 Chat 应用服务。
5. 系统将响应传递给用户。

目标

• 设置环境。
• 设置脚本。
• 为 Chat 应用配置 Google Workspace 插件。
• 测试 Chat 应用。

前提条件

• 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。
• Google Cloud 项目。如需创建项目，请参阅创建 Google 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

配置 OAuth 权限请求页面

所有使用 OAuth 2.0 的应用都需要配置意见征求页面。配置应用的 OAuth 权限请求页面可定义向用户和应用审核者显示的内容，并注册应用以便以后发布。

1. 在 Google Cloud 控制台中，依次点击“菜单”图标 > API 和服务 > OAuth 权限请求页面。

   转到 OAuth 同意屏幕

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

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

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

设置脚本

如需设置脚本，您需要复制快速入门项目，然后在 Apps 脚本中设置 Cloud 项目。

复制快速入门项目

1. 点击以下按钮以打开 Google Chat 中的插件 Apps 脚本项目。
   打开项目
2. 点击 概览。
3. 在概览页面上，点击 复制。

4. 为您的 Apps 脚本项目副本命名：

   1. 点击插件聊天应用的副本。

   2. 在项目名称中，输入 Add-on Chat app

   3. 点击重命名。

复制 Cloud 项目编号

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

   前往“IAM 和管理”设置

2. 在项目编号字段中，复制相应值。

设置 Apps 脚本项目的 Cloud 项目

1. 在 Chat 应用的 Apps 脚本项目中，点击项目设置 。
2. 在 Google Cloud Platform (GCP) Project（Google Cloud Platform [GCP] 项目）下，点击 Change project（更改项目）。
3. 在 GCP project number（GCP 项目编号）中，粘贴 Google Cloud 项目编号。
4. 点击设置项目。

现在，您已经拥有可正常运行的应用代码，可以试用（如以下步骤所述），然后进行自定义以满足您的要求。

打开 Google Apps 脚本项目时，请确保您登录的是正确的 Google 账号。当前账号有时可能会在您不知情的情况下切换到您的默认账号。

创建测试部署

您需要此 Apps Script 项目的部署 ID，以便在下一步中使用它。

如需获取主部署 ID，请执行以下操作：

1. 在 Chat 应用 Apps 脚本项目中，依次点击部署 > 测试部署。
2. 复制主部署 ID，以便在后续步骤中使用，然后点击完成。

配置插件

使用您的 Apps 脚本部署，按照以下步骤创建插件并部署 Google Chat 应用：

1. 在控制台中，搜索 Google Chat API，然后点击 Google Chat API。
2. 点击管理。

3. 点击配置，然后设置 Chat 应用：

   1. 在应用名称字段中，输入 Add-on Chat app。
   2. 在头像网址字段中，输入 https://developers.google.com/chat/images/quickstart-app-avatar.png。
   3. 在说明字段中，输入 Add-on Chat app。
   4. 在功能下，选择接收一对一消息和加入聊天室和群组对话。
   5. 在“连接设置”下，选择 Apps 脚本项目。
   6. 在 Deployment ID（部署 ID）字段中，粘贴您之前复制的主部署 ID。
   7. 在“公开范围”下，选择您网域中的特定人员和群组，然后输入您的电子邮件地址。

4. 点击保存。

Chat 应用已准备好回复消息。

测试 Chat 应用

如需测试 Chat 应用，请使用 Chat 应用打开私信聊天室并发送消息：

1. 使用您在将自己添加为受信任的测试人员时提供的 Google Workspace 账号打开 Google Chat。

   前往 Google Chat

2. 点击 发起新聊天。
3. 在添加 1 人或更多人字段中，输入 Chat 应用的名称。

4. 从搜索结果中选择 Chat 应用。系统随即会打开一条私信。

   注意：如果您在结果列表中没有看到您的 Chat 应用，请确保您已在 Google Cloud 控制台的 Chat API 配置页面的公开范围设置中添加了您的 Google Workspace 账号。

5. 在与应用的新私信对话中，输入 Hello 并按 enter。

   Chat 应用感谢您添加它，并会重复您的消息。

如需添加可信测试人员并详细了解如何测试 Interactive 功能，请参阅测试 Google Chat 应用的 Interactive 功能。

问题排查

当 Google Chat 应用或卡片返回错误时，Chat 界面会显示“出了点问题”消息。或“无法处理您的请求”。有时，Chat 界面不会显示任何错误消息，但 Chat 应用或卡片会产生意外结果；例如，卡片消息可能不会显示。

虽然 Chat 界面中可能不会显示错误消息，但当 Chat 应用的错误日志记录功能处于开启状态时，描述性错误消息和日志数据可帮助您修正错误。如需有关查看、调试和修复错误的帮助，请参阅排查和修复 Google Chat 错误。

清理

为避免系统因本教程中使用的资源向您的 Google Cloud 账号收取费用，我们建议您删除该 Cloud 项目。

注意：删除项目会产生以下影响：

• 项目中的所有内容都会被删除。如果您在本教程使用现有项目，则删除该项目后，还将删除您已在该项目中完成的其他所有工作。
• 自定义项目 ID 会丢失。创建此项目时，您可能创建了要在将来使用的自定义项目 ID。如需保留使用该项目 ID 的网址（例如 appspot.com 上的网址），请删除项目内的所选资源，而不是整个项目。

如果您打算浏览多个教程和快速入门，重复使用项目可以帮助您避免超出项目配额上限。

1. 在 Google Cloud 控制台中，前往管理资源页面。依次点击菜单 > IAM 和管理 > 管理资源。

   前往资源管理器

2. 在项目列表中，选择要删除的项目，然后点击删除 。
3. 在对话框中输入项目 ID，然后点击关闭以删除项目。