REST Resource: spaces

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

資源:Space

Google Chat 的聊天室。「聊天室」是指兩位使用者之間的對話,或使用者和 Chat 應用程式之間的一對一訊息。

JSON 表示法
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState)
}
欄位
name

string

聊天室資源名稱。

格式:空格/{空格}

type
(deprecated)

enum (Type)

僅供輸出。已淘汰:請改用 singleUserBotDmspaceType (開發人員預覽版)。

聊天室類型。

spaceType

enum (SpaceType)

聊天室類型。建立或更新聊天室時必須提供。僅供其他用途使用。

singleUserBotDm

boolean

選用,聊天室是即時通訊應用程式與單一使用者之間的即時訊息。

threaded
(deprecated)

boolean

僅供輸出。已淘汰:請改用 spaceThreadingState。這個聊天室中的訊息是否以對話串形式顯示。

displayName

string

聊天室顯示名稱。建立聊天室時為必填。

如果是即時訊息,這個欄位可能會留空。

spaceThreadingState

enum (SpaceThreadingState)

僅供輸出。Chat 聊天室中的討論串狀態。

spaceDetails

object (SpaceDetails)

聊天室的詳細資料,包括說明和規則。

spaceHistoryState

enum (HistoryState)

這個聊天室中的訊息和討論串訊息記錄狀態。

類型

已淘汰:空格類型。請改用 singleUserBotDmspaceType (開發人員預覽版)。

列舉
TYPE_UNSPECIFIED
ROOM 兩人以上的對話。
DM 由使用者與 Chat 應用程式之間的 1:1 即時訊息,其中所有訊息都是平坦的。請注意,這不包括兩人之間的即時訊息。

空間類型

聊天室類型。建立或更新聊天室時必須提供。僅供其他用途使用。

列舉
SPACE_TYPE_UNSPECIFIED 已保留。
SPACE 使用者可透過這個平台傳送訊息、共用檔案及協同合作。SPACE可以包含即時通訊應用程式。
GROUP_CHAT 與 3 人以上使用者進行群組對話。GROUP_CHAT可以包含即時通訊應用程式。
DIRECT_MESSAGE 兩人或人工與 Chat 應用程式之間的 1:1 訊息。

空格執行緒狀態

指定 Chat 聊天室中的討論串狀態類型。

列舉
SPACE_THREADING_STATE_UNSPECIFIED 已保留。
THREADED_MESSAGES 支援訊息串的已命名聊天室。使用者回覆訊息時,可以在對話串中回覆,這樣就能保留原本的訊息內容。
GROUPED_MESSAGES 依主題將對話分類的已命名聊天室。主題及其回覆會歸在一組。
UNTHREADED_MESSAGES 兩人之間的即時訊息 (DM),以及 3 人以上顯示的群組對話。

聊天室詳細資料

聊天室的詳細資料,包括說明和規則。

JSON 表示法
{
  "description": string,
  "guidelines": string
}
欄位
description

string

選用,聊天室說明。可以描述聊天室的討論主題、功能目的或參與者。

guidelines

string

選用,這個空間的規則、期望和禮儀。

歷史記錄狀態

訊息和聊天室的記錄狀態。指定訊息和對話串在建立後會保留多久。

列舉
HISTORY_STATE_UNSPECIFIED 預設值。請勿使用。
HISTORY_OFF 記錄功能已關閉。訊息和討論串會保留 24 小時
HISTORY_ON 記錄功能已開啟。機構的保管箱資料保留規則會指定郵件與討論串的保留時間。

方法

create

建立已命名的聊天室。

delete

刪除已命名的聊天室。

get

傳回空格。

list

列出呼叫者所屬的聊天室。

patch

更新聊天室。

setup

建立聊天室並加入使用者。