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

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

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

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

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

  1. 用户通过私信或 Chat 聊天室向 Chat 应用发送消息。
  2. 在位于 Google Cloud 中的 Apps 脚本中实现的 Chat 应用逻辑会接收和处理消息。
  3. (可选)Chat 应用逻辑可以与 Google Workspace 服务(例如日历或表格)或其他 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 项目中启用它们。您可以在单个 Google Cloud 项目中启用一个或多个 API。
  • 在 Google Cloud 控制台中,启用 Google Chat API。

    启用 API

所有使用 OAuth 2.0 的应用都需要配置同意屏幕。通过配置应用的 OAuth 同意屏幕,可以定义向用户显示的内容和应用审核者,并注册您的应用,以便日后发布。

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

    转到 OAuth 同意屏幕

  2. 为您的应用选择用户类型,然后点击创建
  3. 填写应用注册表单,然后点击保存并继续
  4. 目前,您可以跳过添加范围的步骤,点击 Save and Continue(保存并继续)。 将来,当您创建要在 Google Workspace 组织外部使用的应用时,您必须添加并验证该应用所需的授权范围。

  5. 如果您选择了外部作为用户类型,请添加测试用户:
    1. 测试用户下,点击添加用户
    2. 输入您的电子邮件地址和任何其他获得授权的测试用户,然后点击保存并继续
  6. 查看您的应用注册摘要。如要进行更改,请点击修改。如果应用注册看起来正常,请点击 Back to Dashboard

设置脚本

如需设置脚本,请使用模板,然后在 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,以便在下一步中使用。

如需获取 Head 部署 ID,请执行以下操作:

  1. 在 Chat 应用 Apps 脚本项目中,依次点击部署 > 测试部署
  2. 复制 Head 部署 ID 以供后续步骤使用,然后点击 Done(完成)。

发布 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 脚本项目,然后将部署 ID 粘贴到字段中。
    6. 在“公开范围”下,选择您网域中的特定人员和群组,然后输入您的电子邮件地址。
  4. 点击保存,然后刷新页面。

  5. 在配置页面上的应用状态下,将状态设置为已发布 - 可供用户使用

  6. 点击保存

Chat 应用已可以回复消息。

测试 Chat 应用

  1. 打开 Chat
  2. 依次点击开始聊天 > 查找应用,向应用发送新的私信。
  3. 在“查找应用”页面上,搜索 Quickstart App
  4. 点击 quickstart App 旁边的 Chat
  5. 在与该应用建立的新私信对话中,输入 Hello,然后按 enter

此聊天应用感谢你添加并回复了你的消息。

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

后续步骤

  • 创建互动卡片 - 卡片消息支持定义的布局、按钮等互动式界面元素以及图片等富媒体。使用卡片消息来呈现详细信息,从用户那里收集信息,并引导用户采取下一步行动。
  • 支持斜杠命令 - 借助斜杠命令,您可以注册并通告用户可通过输入以正斜杠 (/) 开头的命令(如 /help)向您的应用发出的特定命令。
  • 启动对话框 - 对话框是基于卡片的窗口化界面,应用可打开此类界面以与用户互动。多张卡片可按顺序串联在一起,这有助于用户完成多步流程,例如填写表单数据。