REST Resource: spaces

资源:聊天室

Google Chat 中的聊天室。聊天室是两位或多位用户之间的对话,或是用户与 Chat 应用之间的一对一消息。

JSON 表示法
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string
}
字段
name

string

聊天室的资源名称。

格式:spaces/{space}

type
(deprecated)

enum (Type)

仅供输出。已废弃:请改用 spaceType。聊天室的类型。

spaceType

enum (SpaceType)

聊天室的类型。创建聊天室或更新聊天室的聊天室类型时必须填写此字段。仅供其他用途的输出。

singleUserBotDm

boolean

可选。聊天室是否为 Chat 应用与单人之间的私信。

threaded
(deprecated)

boolean

仅供输出。已废弃:请改用 spaceThreadingState。消息是否在此聊天室中以会话串形式显示。

displayName

string

聊天室的显示名称。创建聊天室时必填。如果您在创建聊天室或更新displayName时收到错误消息“ALREADY_EXISTS”,请尝试改用其他displayName。Google Workspace 组织中的现有聊天室可能已经在使用此显示名称。

对于私信,此字段可能为空。

最多包含 128 个字符。

externalUserAllowed

boolean

不可变。此聊天室是否允许任何 Google Chat 用户成为成员。在 Google Workspace 组织中创建聊天室时输入。在以下情况下创建空格时,请省略此字段:

  • 经过身份验证的用户使用消费者帐号(非受管用户帐号)。默认情况下,由消费者帐号创建的聊天室允许任何 Google Chat 用户加入。

  • 该聊天室用于将数据导入 Google Chat,因为导入模式聊天室只能允许来自同一 Google Workspace 组织的成员。不过,作为 Google Workspace 开发者预览版计划的一部分,“导入模式聊天室”可以允许任何 Google Chat 用户,因此可以为导入模式聊天室设置此字段。

对于现有聊天室,系统将仅输出此字段。

spaceThreadingState

enum (SpaceThreadingState)

仅供输出。Chat 聊天室中的话题状态。

spaceDetails

object (SpaceDetails)

聊天室的详细信息,包括说明和规则。

spaceHistoryState

enum (HistoryState)

此聊天室中消息和话题的消息记录状态。

importMode

boolean

可选。此聊天室是否在将数据迁移到 Google Workspace 的过程中在Import Mode中创建。聊天室导入期间,在导入完成前,用户看不到聊天室。

createTime

string (Timestamp format)

可选。不可变。对于在 Chat 中创建的聊天室,显示该聊天室的创建时间。此字段仅输出,但在“导入模式聊天室”中使用时除外。

对于导入模式聊天室,请将此字段设为来源中聊天室创建的历史时间戳,以保留原始创建时间。

仅当 spaceTypeGROUP_CHATSPACE 时,才会在输出中填充。

adminInstalled

boolean

仅供输出。Chat 应用是否由 Google Workspace 管理员安装。管理员可以为自己的网域、组织部门或用户群组安装 Chat 应用。

管理员只能安装 Chat 应用,以便用户与其应用之间的私信对话。如要支持管理员安装,您的应用必须提供私信功能。

accessSettings

object (AccessSettings)

可选。指定聊天室的访问权限设置。仅当 spaceTypeSPACE 时填充。

spaceUri

string

仅供输出。聊天室的 URI。

类型

已废弃:请改用 SpaceType

枚举
TYPE_UNSPECIFIED
ROOM 两个或多个人之间的对话。
DM 用户与 Chat 应用之间的一对一私信,所有消息都是平面消息。请注意,这不包括两人之间的私信。

SpaceType

聊天室的类型。创建或更新聊天室时必填。仅供其他用途的输出。

枚举
SPACE_TYPE_UNSPECIFIED 预留。
SPACE 可供用户发送消息、共享文件和进行协作的地方。SPACE 可以包含 Chat 应用。
GROUP_CHAT 3 人或更多人之间的群组对话。GROUP_CHAT 可以包含 Chat 应用。
DIRECT_MESSAGE 两个人或一个人与一个 Chat 应用之间的一对一消息。

SpaceThreadingState

指定 Chat 聊天室中话题状态的类型。

枚举
SPACE_THREADING_STATE_UNSPECIFIED 预留。
THREADED_MESSAGES 支持消息串的已命名聊天室。用户回复消息后,可以在消息串中回复消息,这样回复就能保持在原始消息的上下文中。
GROUPED_MESSAGES 已命名的聊天室,其中对话按主题整理。主题及其回复会归为一组。
UNTHREADED_MESSAGES 两人之间的私信 (DM),以及 3 人或更多人的群组对话。

SpaceDetails

聊天室的详细信息,包括说明和规则。

JSON 表示法
{
  "description": string,
  "guidelines": string
}
字段
description

string

可选。聊天室的说明。例如,说明聊天室的讨论主题、功能用途或参与者。

最多包含 150 个字符。

guidelines

string

可选。聊天室的规则、期望和礼仪。

最多支持 5,000 个字符。

HistoryState

消息和聊天室的聊天记录状态。指定邮件和会话在创建后保留多长时间。

枚举
HISTORY_STATE_UNSPECIFIED 默认值。请勿使用。
HISTORY_OFF 聊天记录功能已关闭。消息和消息串会保留 24 小时
HISTORY_ON 聊天记录功能已开启。组织的保险柜保留规则规定了消息和会话的保留时长。

AccessSettings

表示聊天室的访问权限设置

JSON 表示法
{
  "accessState": enum (AccessState),
  "audience": string
}
字段
accessState

enum (AccessState)

仅供输出。指示聊天室的访问状态。

audience

string

可选。可以访问该聊天室的目标对象群组的资源名称。将此字段设为有效的目标对象群组 ID,使聊天室可供搜索,或使用 audiences/default 别名在管理控制台中的默认访问权限设置来设置聊天室。有关详情,请参阅让目标对象群组可以开放聊天室。取消设置此字段即可限制聊天室。仅当聊天室开放时,才会填充此字段。格式:audiences/{audience}audiences/default 可用作默认 Chat 共享设置的别名。

AccessState

表示聊天室的访问状态。

枚举
ACCESS_STATE_UNSPECIFIED 访问状态未知或此 API 不支持。
PRIVATE 添加或受邀的成员或群组可以找到聊天室。
DISCOVERABLE 选定的目标对象群组以及添加或受邀的成员或群组都可以找到聊天室。

方法

completeImport

完成指定空间的导入流程,并使其对用户可见。

create

创建命名空间。

delete

删除已命名的聊天室。

findDirectMessage

返回与指定用户的现有私信。

get

返回聊天室的相关详细信息。

list

列出调用者所属的聊天室。

patch

更新聊天室。

setup

创建聊天室并添加指定用户。