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

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

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

使用 Apps 脚本实现的 Chat 应用的架构。

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

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

目标

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

前提条件

设置您的环境

在 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 2.0 的应用都需要配置同意屏幕。配置应用的 OAuth 同意屏幕可定义要向用户显示的内容和应用审核者,并注册您的应用以便日后发布。

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

    转到 OAuth 同意屏幕

  2. 对于用户类型,选择内部,然后点击创建
  3. 填写应用注册表单,然后点击保存并继续
  4. 现在,您可以跳过添加范围的步骤,然后点击保存并继续。 将来,当您创建要在 Google Workspace 组织外部使用的应用时,必须将用户类型更改为外部,然后添加应用所需的授权范围。

  5. 查看您的应用注册摘要。如要进行更改,请点击修改。如果应用注册看起来没有问题,请点击返回信息中心

设置脚本

如需设置脚本,请使用模板,然后在 Apps 脚本中设置 Cloud 项目。

通过模板创建脚本

  1. 前往 Apps 脚本的使用入门页面
  2. 点击 Chat 应用模板。您可能需要向下滚动才能看到此模板
  3. 点击未命名项目,输入 Quickstart app,然后点击重命名

复制 Cloud 项目编号

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

    转到“IAM 和管理”设置

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

设置 Apps 脚本项目的 Cloud 项目

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

现在,您已经有了可以运行的应用代码,您可以尝试(如下所述)并自定义这些代码,以满足自己的需求。

确保在打开 Apps 脚本模板时登录正确的 Google 帐号。当前帐号有时可能会在您不知情的情况下切换到默认帐号。

创建测试部署

您需要此 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 字段中,粘贴您之前复制的 Head 部署 ID。
    7. 在“公开范围”下,选择您网域中的特定人员和群组,然后输入您的电子邮件地址。
  4. 点击保存

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

测试 Chat 应用

如需测试您的 Chat 应用,请使用 Chat 应用打开私信聊天室,然后发送消息:

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

    前往 Google Chat

  2. 点击 发起新对话
  3. 添加一人或多人字段中,输入您的 Chat 应用的名称。
  4. 从结果中选择您的 Chat 应用。系统会打开一条私信。

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

    Chat 应用会回复你的消息 感谢你添加该应用

如需添加可信测试员并详细了解如何测试互动功能,请参阅测试 Google Chat 应用的互动功能

排查问题

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

虽然 Chat 界面中可能未显示错误消息,但当为 Chat 应用启用错误日志记录时,系统会提供描述性错误消息和日志数据来帮助您修复错误。如需查看、调试和修正错误方面的帮助,请参阅排查和修正 Google Chat 错误

清理

为避免因本教程中使用的资源导致您的 Google Cloud 帐号产生费用,我们建议您删除 Cloud 项目。

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

    前往 Resource Manager

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

后续步骤

  • 创建互动式卡片 - 卡片消息支持定义的布局、互动式界面元素(如按钮)和富媒体(如图片)。使用卡片消息提供详细信息,从用户处收集信息并引导用户执行下一步。
  • 支持斜杠命令 - 使用斜杠命令,您可以注册和通告用户可通过输入以正斜杠 (/) 开头的命令(如 /help)为应用发出的特定命令。
  • 启动对话框 - 对话框是基于卡片的窗口式界面,应用可以打开以与用户互动。多张卡片可以按顺序串联在一起,这有助于用户完成多步骤流程,例如填写表单数据。
  • Codelab:准备好构建更高级的 Chat 应用了吗?请参阅使用 Gemini 构建 Google Chat 应用 Codelab 中的反馈 Chat 应用。