Google Chat API 概览

本部分介绍 Google Chat 应用如何 Chat API 让 Chat 应用可以执行诸多操作,例如 创建聊天室,向其中添加人员,并在没有提示的情况下发布消息 Chat 应用互动事件

身份验证

异步调用 Chat API 需要进行身份验证。每个 Chat API 方法需要 用户身份验证 (执行操作或访问 代表用户的数据)或 应用身份验证 (以 Chat 应用的形式执行操作或访问数据)。部分 方法同时支持用户身份验证和应用身份验证。

如需详细了解 Chat 中的身份验证,请参阅 身份验证概览

API 资源和方法

REST 资源和方法可授予对 Chat 的异步访问权限 聊天室、聊天室成员、消息、消息回应和消息附件。

聊天室

聊天室是用户和应用相互交流和共享文件的地方。那里 是多种类型的聊天室私信 (DM) 是一对一对话 两位用户或一位用户与 Chat 应用之间来回切换。分组 聊天是指三位或更多用户之间的对话, 聊天应用。已命名的聊天室是用户长期在其中发送内容的位置, 共享文件和协作。

通过 spaces 资源 表示空间。

聊天室支持以下方法:

成员

成员是指已经加入或加入的用户和 Chat 扩展应用 受邀加入聊天室。

通过 spaces.members 资源 代表一个成员。

成员支持以下方法:

信息

消息包括 文本卡片 在聊天室中发布的通信内容。信息中可以附加文件。 用户可以通过在消息中附加表情符号来回应消息。

通过 spaces.messages 资源 表示一条消息。

“信息”应用支持以下方法:

回应

回应表示用户用于回应信息的表情符号,例如 👍?、🚲? 和 🌞?。

通过 spaces.messages.reactions 资源 表示一种反应。

回应支持以下方法:

媒体和附件

“媒体”代表上传到 Google Chat 的文件,例如图片、视频和 文档。

通过 media 资源 表示附加到消息的媒体。

附件是指邮件中附加的媒体(文件)实例。

通过 spaces.messages.attachments 资源 表示一个附件。附件包含媒体内容和相关联的 附加在邮件中的元数据。

媒体和附件支持以下方法:

聊天室事件

聊天室事件表示对聊天室或其 子资源,包括其成员、消息和回应。

spaces.spaceEvent 资源 表示太空事件。

聊天室事件支持以下方法:

用户读取状态

用户读取状态是单例资源,表示有关 指定用户上次阅读的 Google Chat 聊天室消息或消息 线程。

users.spaces 资源 表示用户在空间中的读取状态。

users.spaces.threads 资源 表示用户在消息线程中的读取状态。

用户读取状态支持以下方法: