本部分介绍了 Google Chat 应用如何调用 Chat API,Chat API 可让 Chat 应用执行创建聊天室、向聊天室中添加用户和发布消息等操作。
身份验证
调用 Chat API 需要进行身份验证。每个 Chat API 方法都需要进行用户身份验证(以代表用户执行操作或访问数据)或应用身份验证(以 Chat 应用身份执行操作或访问数据)。某些方法同时支持用户身份验证和应用身份验证。
如需详细了解 Chat 中的身份验证,请参阅身份验证概览。
客户端库
对于大多数开发者,建议使用我们官方支持的 Cloud 客户端库(适用于您的首选语言,例如 Python、Java 或 Node.js)调用 Google Chat API。
如果您使用 Google Apps 脚本进行编码,请使用高级 Chat 服务,而不是安装客户端库。
Google Chat API 概念
gRPC 服务或 REST 资源和方法可授予对 Chat 聊天室、聊天室成员、消息、消息回应、消息附件、聊天室事件和用户阅读状态的访问权限。
- 聊天室
聊天室是用户和应用可以进行对话和共享文件的场所。聊天室有多种类型。私信 (DM) 是指两名用户或一名用户与 Chat 应用之间的一对一对话。群聊是指三名或更多用户与 Chat 应用之间的对话。命名聊天室是用户发送消息、共享文件和协作的永久性场所。
资源参考文档:
如需查看使用示例,请参阅:
- 成员
成员是指已加入或受邀加入聊天室的用户和 Chat 应用。
资源参考文档:
如需查看使用示例,请参阅:
- 信息
资源参考文档:
如需查看使用示例,请参阅:
- 回应
回应是指用户用来回应消息的表情符号,例如 👍?、🚲? 和 🌞?。
资源参考文档:
如需查看使用示例,请参阅:
- 自定义表情符号(开发者预览版)
自定义表情符号是指在 Google Chat 中创建并在组织内共享的自定义表情符号。自定义表情符号可添加到消息内容中,也可用于回应消息。
资源参考文档:
- 媒体和附件
媒体表示上传到 Google Chat 的文件,例如图片、视频和文档。
媒体资源引用(在 RPC 中不可用):
附件是指附加到邮件的媒体(文件)实例。
资源参考文档:
如需查看使用示例,请参阅:
- 聊天室事件
聊天室事件代表聊天室或其子资源(包括成员、消息和回应)发生的更改。
资源参考文档:
如需查看使用示例,请参阅:
- 用户阅读状态
用户阅读状态是单例资源,用于表示指定用户在 Google Chat 聊天室或消息会话中上次阅读的消息的详细信息。
聊天室读取状态资源引用:
线程读取状态资源引用:
如需查看使用示例,请参阅:
- 用户空间通知设置(开发者预览版)
用户聊天室通知设置是单例资源,表示 Google Chat 聊天室中的指定用户通知设置。
资源参考文档:
相关主题
- 探索 Google Chat 应用示例,开始使用 Chat API。
除了调用 Chat API 之外,Chat 应用还可以:
- 实时接收和响应 Chat 应用互动事件,例如向 Google Chat 应用发送的消息。
- 订阅 Google Chat 事件,以便在 Chat 中发生特定活动或更改(例如有新消息和成员更改)时执行操作或做出响应。