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

构建一个可以直接接收您发送的消息并通过回显您的消息进行回复的 Google Chat 扩展应用。

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

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

在上图中，用户与 Apps 脚本聊天应用互动时，信息流如下所示：

  1. 用户通过私信或 Chat 聊天室向 Chat 应用发送消息。
  2. 在 Google Cloud 中实现的 Apps 脚本中的 Chat 应用逻辑会接收并处理消息。
  3. 聊天应用逻辑可以选择性地与 Google Workspace 服务（例如日历或 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 项目中将其开启。 您可以在单个 Google Cloud 项目中启用一个或多个 API。

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

    启用 API

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

  1. 在 Google Cloud 控制台中，依次前往菜单 > Google Auth platform > 品牌推广。

    前往“品牌推广”

  2. 如果您已配置 Google Auth platform，则可以在品牌推广、受众群体和数据访问中配置以下 OAuth 权限请求页面设置。如果您看到一条消息，指出Google Auth platform 尚未配置，请点击开始：
    1. 在应用信息下，在应用名称中输入应用的名称。
    2. 在用户支持电子邮件中，选择一个支持电子邮件地址，以便用户在对自己的同意情况有疑问时与您联系。
    3. 点击下一步。
    4. 在受众群体下，选择内部。
    5. 点击下一步。
    6. 在联系信息下，输入一个电子邮件地址，以便您接收有关项目变更的通知。
    7. 点击下一步。
    8. 在完成部分，查看 Google API 服务用户数据政策，如果您同意该政策，请选择我同意《Google API 服务：用户数据政策》。
    9. 点击继续。
    10. 点击创建。
  3. 目前，您可以跳过添加范围的步骤。 未来，如果您创建的应用供 Google Workspace 组织以外的用户使用，则必须将用户类型更改为外部。然后，添加应用所需的授权范围。如需了解详情，请参阅完整的配置 OAuth 同意指南。

设置脚本

如需设置脚本，您可以使用模板，然后在 Apps 脚本中设置 Cloud 项目。

根据模板创建脚本

  1. 前往 Apps 脚本使用入门页面。
  2. 点击页面顶部的聊天应用模板。
  3. 点击未命名项目，输入 Quickstart app，然后点击重命名。

复制 Cloud 项目编号

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

    前往“IAM 和管理”设置

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

设置 Apps 脚本项目的 Cloud 项目

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

现在，您已拥有可正常运行的应用代码，可以尝试使用（如以下步骤中所述），然后根据自己的需求进行自定义。

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

创建测试部署

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

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

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

发布 Chat 应用

通过控制台发布 Chat 应用。

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

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

    1. 取消选中将此 Chat 扩展应用作为 Google Workspace 插件构建。系统会打开一个对话框，要求您进行确认。在该对话框中，点击停用。
    2. 在应用名称字段中，输入 Quickstart app。
    3. 在头像网址字段中，输入 https://developers.google.com/chat/images/quickstart-app-avatar.png。
    4. 在说明字段中，输入 Quickstart app。
    5. 在功能下，选择加入聊天室和群组对话。
    6. 在“连接设置”下，选择 Apps 脚本。
    7. 在部署 ID 字段中，粘贴您之前复制的 Head 部署 ID。
    8. 在“查看权限”下方，选择您网域中的特定人员和群组，然后输入您的电子邮件地址。

  4. 点击保存。

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

测试 Chat 应用

如需测试 Chat 应用，请打开与该 Chat 应用的私信对话，然后发送消息：

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

    前往 Google Chat

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

  4. 从结果中选择您的 Chat 应用。系统会打开私信对话。

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

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

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

问题排查

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

虽然聊天界面中可能不会显示错误消息，但当您为聊天应用启用错误日志记录功能后，系统会提供描述性错误消息和日志数据，帮助您修复错误。如需有关查看、调试和修复错误的帮助，请参阅排查和修复 Google Chat 错误。

清理

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

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

    前往资源管理器

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

后续步骤

  • 创建互动式卡片 - 卡片消息支持已定义的布局、按钮等互动式界面元素以及图片等富媒体。使用卡片消息来呈现详细信息、从用户那里收集信息，并引导用户采取下一步行动。
  • 响应命令 - 命令可帮助用户发现和使用 Chat 应用的关键功能。
  • 启动对话框 - 对话框是基于卡片的窗口化界面，应用可以打开这些界面来与用户互动。多个卡片可以按顺序串联在一起，这有助于用户完成多步流程，例如填写表单数据。
  • Codelab：准备好构建更高级的聊天应用了吗？请参阅 Codelab 构建内置 Gemini 的 Google Chat 应用中的反馈 Chat 应用。