本页面简要介绍了 Google Chat API 和 Google Chat 应用。
Google Chat API 概览
Chat API 由 gRPC 服务或 REST 资源和方法 组成,用于授予对 Chat 的访问权限,包括聊天室、聊天室成员、 消息、消息回应、消息附件、聊天室事件和用户已读 状态。
概念
以下部分定义了 Chat API 的服务、资源和方法:
- 聊天室
聊天室 是用户和应用可以对话和共享文件的场所。聊天室有多种类型。私信 (DM) 是两位用户之间或用户与 Chat 应用之间的 1 对 1 对话。群聊是三位或更多用户与 Chat 应用之间的对话。命名聊天室是用户发送消息、共享文件和协作的永久场所。
资源引用:
如需查看使用示例,请参阅:
- 成员
成员 是指已加入或受邀加入聊天室的用户和 Chat 应用。
资源引用:
如需查看使用示例,请参阅:
- 消息
消息 __包括 在聊天室中发布的文本 和 卡片通信内容。消息可以附带文件。 用户可以通过在消息中添加表情符号来回应消息。
资源引用:
如需查看使用示例,请参阅:
- 回应
回应 表示用户用于回应消息的表情符号,例如 👍、🚲 和 🌞。
资源引用:
如需查看使用示例,请参阅:
- 自定义表情符号
自定义表情符号 表示在 Google Chat 中创建并与组织内共享的自定义表情符号。自定义表情符号可以包含在消息内容中,也可以用于回应消息。
资源引用:
如需查看使用示例,请参阅:
- 版块
版块 是用户对其对话进行分组并自定义 Google Chat 导航面板中显示的聊天室列表的方式。有预定义的系统版块和用户定义的自定义版块。
资源引用:
如需查看使用示例,请参阅:
- 媒体和附件
媒体 表示上传到 Google Chat 的文件,例如图片、视频和文档。
媒体资源引用(在 RPC 中不可用):
附件 是附在消息上的媒体(文件)实例。
资源引用:
如需查看使用示例,请参阅:
- 聊天室事件
聊天室事件 表示对聊天室或其子资源(包括成员、消息和回应)所做的更改。
资源引用:
如需查看使用示例,请参阅:
- 用户已读状态
用户已读状态 是单例资源,表示有关指定用户在 Google Chat 聊天室或消息话题中最后阅读的消息的详细信息。
聊天室已读状态资源引用:
话题已读状态资源引用:
如需查看使用示例,请参阅:
- 用户聊天室通知设置
用户聊天室通知设置 是单例资源,表示 Google Chat 聊天室中的指定用户通知设置。
资源引用:
身份验证
调用 Chat API 需要进行身份验证。每种 Chat API 方法都需要进行 用户身份验证 (代表用户执行操作或访问 数据)或 应用身份验证 (以 Chat 应用的身份执行操作或访问数据)。某些方法同时支持用户身份验证和应用身份验证。
如需详细了解 Chat 中的身份验证,请参阅 身份验证概览。
客户端库
对于大多数开发者来说,调用 Google Chat API 的推荐方式是使用我们正式支持的 Cloud 客户端库 ,该库支持您偏好的语言,例如 Python、Java 或 Node.js。
如果您使用 Google Apps 脚本进行编码,请使用 高级聊天服务 ,而不是安装客户端库。
构建 Chat 应用
借助 Chat API,您可以构建 Google Chat 应用,将您的服务和资源直接引入 Google Chat。您可以构建 Chat 应用来执行以下任一操作:
- 根据用户输入的结构化或自由文本查询检索信息。
- 使用用户提供的信息生成突发事件报告或其他工件。
- 增强团队协作,例如提供“团队记忆”或安排资源。
您可以使用多种不同的架构样式来设计 Chat 应用,包括:
- 互动式应用:回应用户互动(例如 @提及或斜杠 命令),并通过卡片和对话框呈现信息或引导用户完成工作流。
- 命令行应用或网络钩子:将主动消息(例如闹钟 或通知)从其他系统发送到聊天室。用户无法直接与此类应用互动。
- 事件驱动型应用:订阅并回应 Chat 聊天室中的活动,例如有新成员加入。为了响应事件,应用可以发送消息或执行其他操作。
如需详细了解如何设计 Chat 应用,请参阅 选择 Google Chat 应用架构。
相关主题
|
想了解 Google Chat API 的实际应用情况?
Google Workspace Developers 频道提供了有关提示、
技巧和最新功能的视频。
|