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
}
字段
name

string

聊天室的资源名称。

格式：spaces/{space}
type
(deprecated)

enum (Type)

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

enum (SpaceType)

聊天室的类型。创建聊天室或更新聊天室的聊天室类型时需要填写。输出仅供其他用途使用。
singleUserBotDm

boolean

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

boolean

仅供输出。已弃用：请改用 spaceThreadingState。消息是否在此聊天室中以话题式显示。
displayName

string

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

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

最多包含 128 个字符。
externalUserAllowed

boolean

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

  • 经过身份验证的用户使用 Google 帐号。默认情况下，聊天室允许所有 Google Chat 用户。

  • 该聊天室用于将数据导入 Google Chat。导入模式聊天室必须仅允许来自同一 Google Workspace 组织的成员。

对于现有聊天室，此字段是仅输出的。
spaceThreadingState

enum (SpaceThreadingState)

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

object (SpaceDetails)

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

enum (HistoryState)

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

boolean

可选。此聊天室是在向 Google Workspace 迁移数据时在“Import Mode”中创建的。聊天室导入期间，在导入完成前，用户看不到这些聊天室。
createTime

string (Timestamp format)

可选。对于在 Chat 中创建的聊天室，此维度是指聊天室的创建时间。此字段仅为输出字段，在导入的聊天室中使用时除外。

对于导入的聊天室，请将此字段设为在来源中创建聊天室的历史时间戳，以保留最初的创建时间。

仅当 spaceType 为 GROUP_CHAT 或 SPACE 时，才会在输出中填充。
adminInstalled

boolean

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

管理员只能安装 Chat 应用，以便在用户与应用之间直接收发消息。为支持管理员安装，您的应用必须包含私信功能。

类型

已弃用：请改用 SpaceType。

枚举
TYPE_UNSPECIFIED
ROOM 两人或多人之间的对话。
DM 用户与 Chat 应用之间的一对一私信，其中的消息均为平面消息。请注意，这不包括两个人之间的私信。

空间类型

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

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

SpaceThreadingState

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

枚举
SPACE_THREADING_STATE_UNSPECIFIED 预留。
THREADED_MESSAGES 支持消息会话的已命名聊天室。当用户回复某条消息时，他们可在会话中进行回复，这样可确保用户的回复始终处于原始消息的上下文中。
GROUPED_MESSAGES 按主题整理对话的已命名聊天室。主题及其回复会归为一组。
UNTHREADED_MESSAGES 两人之间的私信 (DM) 以及三人或多人之间的群组对话。

聊天室详细信息

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

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

string

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

最多包含 150 个字符。
guidelines

string

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

最多支持 5,000 个字符。

历史记录状态

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

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

方法

completeImport

 完成指定聊天室的导入流程，并将其显示给用户。

create

 创建命名空间。

delete

 删除命名空间。

findDirectMessage

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

get

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

list

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

patch

 更新聊天室。

setup

 创建聊天室并将指定用户添加到其中。