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