Google Apps 脚本聊天应用快速入门

创建一个可以直接发送消息的 Google Chat 应用 通过回显消息进行回复。

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

在上图中，用户与 Apps 脚本互动 Chat 应用具有以下信息流：

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

目标

• 设置环境。
• 设置脚本。
• 发布 Chat 应用。
• 测试 Chat 应用。

前提条件

• Google Workspace 有权访问 Chat 的账号。
• 具有一个 Google Cloud 项目。

设置环境

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

如果尚未打开，请打开您要使用的 Cloud 项目 示例：

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

   选择 Cloud 项目

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

启用 Chat API

在使用 Google API 之前，您需要先在 Google Cloud 项目中启用这些 API。 您可以在单个 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. 查看您的应用注册摘要。如要进行更改，请点击修改。如果应用 点击 Back to Dashboard（返回信息中心）。

设置脚本

要设置脚本，请使用模板 Apps 脚本中的 Cloud 项目。

通过模板创建脚本

1. 前往 Apps 脚本的使用入门页面。
2. 点击 Chat 应用模板。您可能需要向下滚动 可以查看此模板
3. 点击 Untitled project，输入 Quickstart app，然后 点击重命名。

复制 Cloud 项目编号

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

   前往“IAM”和管理员设置

2. 复制项目编号字段中的值。

设置 Apps 脚本项目的 Cloud 项目

1. 在 Chat 应用的 Apps 脚本项目中， 点击 Project Settings 图标 。
2. 在 Google Cloud Platform (GCP) 项目下，点击更改项目。
3. 在 GCP 项目编号中，粘贴 Google Cloud 项目编号。
4. 点击设置项目。

现在，您已经有了可以试用的有效应用代码（如 然后按照您的要求进行自定义。

请确保您在打开 Apps 脚本模板。当前账号有时可以切换到 默认您的账号。

创建测试部署

您需要此 Apps 脚本项目的部署 ID，以便 则可在下一步中使用

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

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

发布 Chat 应用

在 Google Cloud 控制台中发布 Chat 应用。

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

3. 点击配置并设置 Chat 应用：

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

4. 点击保存。

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

测试 Chat 应用

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

1. 使用您用于登录的 Google Workspace 账号打开 Google Chat 在您添加为可信测试员时提供的凭据。

   前往 Google Chat

2. 点击 发起新对话。
3. 在添加一人或多人字段中，输入 Chat 应用。

4. 从结果中选择您的 Chat 应用。直接客户 消息会打开。

   注意：如果您没有在 请确保您已将自己的 Google Workspace 账号添加到 Chat API 配置的公开范围设置 页面。

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

   Chat 应用感谢您添加该应用，并且会有回声 信息。

如需添加可信测试员，并详细了解如何测试互动功能，请参阅 测试适用于以下应用的互动功能： Google Chat 应用。

问题排查

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

虽然 Chat 界面中可能不会显示错误消息， 提供描述性错误消息和日志数据，以帮助您修正错误 启用 Chat 应用的错误日志记录时。如需观看方面的帮助， 请参阅 排查并修正 Google Chat 错误。

清理

为避免系统因 我们建议您删除 Cloud 项目中。

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

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

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

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

   前往 Resource Manager

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

后续步骤

• 创建互动卡片 - 卡片 消息支持定义的布局、交互式界面元素（如按钮），以及 图片等富媒体使用卡片消息提供详细信息 向用户收集信息，并引导用户采取下一步行动。
• 支持斜杠命令：使用斜杠命令 您可以注册并公布用户可向您的应用发出的特定命令 输入以正斜杠 (/) 开头的命令（例如 /help）。
• 启动对话框 - 对话框会以卡片形式显示 您的应用可打开以与用户交互的界面。多张卡片 可按顺序串联在一起，这有助于用户完成多步操作 比如填写表单数据
• Codelab：已准备好构建更高级的 聊天应用？查看反馈 此 Codelab 中的 Chat 应用 使用 Gemini 构建 Google Chat 应用。