本页面介绍了如何创建 HTTP Chat 应用。您可以通过多种方式实现此架构。在 Google Cloud 上,您可以使用 Cloud Functions、Cloud Run 和 App Engine。在本快速入门中,您将编写和部署一个 Cloud Functions 函数,供 Chat 应用用来响应用户的消息。
在此架构中,您可以使用 HTTP 将 Chat 配置为与 Google Cloud 或本地服务器集成,如下图所示:
在上图中,用户与 HTTP Chat 应用互动的信息流如下:
- 用户在 Chat 中通过私信或 Chat 聊天室向 Chat 应用发送消息。
- HTTP 请求会发送到 Web 服务器,该服务器是包含 Chat 应用逻辑的云端或本地系统。
- 或者,Chat 应用逻辑可以与 Google Workspace 服务(例如 Google 日历和表格)、其他 Google 服务(例如 Google 地图、YouTube 和 Vertex AI)或其他网络服务(例如项目管理系统或票务工具)集成。
- Web 服务器会将 HTTP 响应发送回 Chat 中的 Chat 应用服务。
- 系统将响应传送给用户。
- (可选)Chat 应用可以调用 Chat API 来异步发布消息或执行其他操作。
此架构可让您灵活地使用系统中已有的现有库和组件,因为这些 Chat 应用可以使用不同的编程语言进行设计。
目标
- 设置环境。
- 创建和部署 Cloud Functions 函数。
- 将应用发布到 Chat。
- 测试应用。
前提条件
- 在 Google Workspace 组织中拥有 Google Chat 访问权限的 Google Workspace 帐号,允许未经身份验证的 Google Cloud Functions 函数调用。
- Google Cloud 项目。
- 确保为 Cloud 项目启用结算功能。了解如何验证项目的结算状态。
设置环境
在使用 Google API 之前,您需要在 Google Cloud 项目中启用它们。您可以在单个 Google Cloud 项目中启用一个或多个 API。在 Google Cloud 控制台中,启用 Google Chat API、Cloud Build API、Cloud Functions API、Cloud Pub/Sub API、Cloud Logging API、Artifact Registry API 和 Cloud Run API。
创建和部署 Cloud Functions 函数
创建和部署一个 Cloud Functions 函数,用于生成包含发送者显示名称和头像图片的聊天卡片。当 Chat 应用收到消息时,它会运行该函数并使用卡片进行响应。
如需为 Chat 应用创建和部署函数,请完成以下步骤:
Node.js
在 Google Cloud 控制台中,转到 Cloud Functions 页面:
确保已选择 Chat 应用所属的项目。
点击
创建函数。在“创建函数”页面上,设置函数:
- 在环境中,选择第 2 代。
- 在函数名称中,输入
QuickStartChatApp
。 - 在区域中,选择一个区域。
- 在“Authentication”下,选择允许未通过身份验证的调用。
- 点击下一步。
在运行时中,选择 Node.js 20。
在源代码中,选择 Inline Editor。
在入口点中,删除默认文本并输入
helloChat
。将
index.js
的内容替换为以下代码:点击部署。
Python
在 Google Cloud 控制台中,转到 Cloud Functions 页面:
确保已选择 Chat 应用所属的项目。
点击
创建函数。在“创建函数”页面上,设置函数:
- 在函数名称中,输入
QuickStartChatApp
。 - 在触发器类型中,选择 HTTP。
- 在“Authentication”下,选择允许未通过身份验证的调用。
- 点击保存。
- 点击下一步。
- 在函数名称中,输入
在运行时中,选择 Python 3.10。
在源代码中,选择 Inline Editor。
在入口点中,删除默认文本并输入
hello_chat
。将
main.py
的内容替换为以下代码:点击部署。
Java
在 Google Cloud 控制台中,转到 Cloud Functions 页面:
确保已选择 Chat 应用所属的项目。
点击
创建函数。在“创建函数”页面上,设置函数:
- 在函数名称中,输入
QuickStartChatApp
。 - 在触发器类型中,选择 HTTP。
- 在“Authentication”下,选择允许未通过身份验证的调用。
- 点击保存。
- 点击下一步。
- 在函数名称中,输入
在运行时中,选择 Java 11。
在源代码中,选择 Inline Editor。
在入口点中,删除默认文本并输入
HelloChat
。将
src/main/java/com/example/Example.java
改名为src/main/java/HelloChat.java
。将
HelloChat.java
的内容替换为以下代码:将
pom.xml
的内容替换为以下代码:点击部署。
Cloud Functions 详情页面随即会打开,您的函数会显示两个进度指示器:一个用于构建,另一个用于服务。当两个进度指示器都消失并替换为对勾标记时,您的函数已部署并准备就绪。
将应用发布到 Google Chat
部署 Cloud Functions 函数后,请按照以下步骤将其转换为 Google Chat 应用:
在 Google Cloud 控制台中,依次点击“菜单”图标 > Cloud Functions。
请务必选择启用了 Cloud Functions 的项目。
在函数列表中,点击 QuickStartChatApp。
点击触发器标签页。
在 HTTPS 下,复制网址。
搜索“Google Chat API”,点击 Google Chat API,然后点击管理。
点击配置并设置 Google Chat 应用:
- 在应用名称中,输入
Quickstart App
。 - 在头像网址中,输入
https://developers.google.com/chat/images/quickstart-app-avatar.png
。 - 在说明中,输入
Quickstart app
。 - 在功能下,选择接收 1 对 1 消息和加入聊天室和群组对话。
- 在连接设置下,选择应用网址,然后将 Cloud Functions 函数触发器的网址粘贴到框中。
- 在公开范围下,选择将此 Google Chat 应用提供给您网域中的特定人员和群组,然后输入您的电子邮件地址。
- 在日志下,选择将错误记录到 Logging。
- 在应用名称中,输入
点击保存。
Chat 应用已准备好在 Chat 中接收和回复消息。
测试 Chat 应用
如需测试您的 Chat 应用,请使用 Chat 应用打开私信聊天室并发送消息:
使用您将自己添加为可信测试员时提供的 Google Workspace 账号打开 Google Chat。
- 点击 发起新聊天。
- 在添加 1 位或更多人字段中,输入您的 Chat 应用的名称。
从结果中选择您的 Chat 应用。系统会打开一条私信。
- 在与应用的新私信对话中,输入
Hello
,然后按enter
。
Chat 应用的响应包含一条卡片消息,其中会显示发送者的姓名和头像图片,如下图所示:
如需添加可信测试员并详细了解如何测试交互功能,请参阅测试 Google Chat 应用的交互功能。
排查问题
当 Google Chat 应用或卡片返回错误时,Chat 界面会显示“出了点问题”的消息。或“无法处理您的请求”。有时,Chat 界面不会显示任何错误消息,但 Chat 应用或卡片会产生意外结果;例如,卡片消息可能不会显示。
虽然 Chat 界面中可能不会显示错误消息,但当为 Chat 应用启用错误日志记录功能时,描述性错误消息和日志数据可帮助您修复错误。如需查看、调试和修复错误方面的帮助,请参阅排查和修正 Google Chat 错误。
清理
为避免因本教程中使用的资源导致您的 Google Cloud 帐号产生费用,我们建议您删除该 Cloud 项目。
- 在 Google Cloud 控制台中,前往管理资源页面。依次点击菜单图标 > IAM 和管理 > 管理资源。
- 在项目列表中,选择要删除的项目,然后点击删除 。
- 在对话框中输入项目 ID,然后点击关停以删除项目。
相关主题
如需向 Chat 应用添加更多功能,请参阅以下内容: