REST Resource: spaces

資源:Space

Google Chat 中的聊天室。聊天室是指兩位以上的使用者,或是使用者與 Chat 應用程式之間的 1:1 訊息。

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)
  }
}
欄位
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 帳戶。根據預設,聊天室允許所有 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 中建立的聊天室,這是聊天室的建立時間。這個欄位只會輸出,但用於匯入模式空格時除外。

針對匯入模式聊天室,請將這個欄位設為在來源中建立聊天室時的歷來時間戳記,以保留原本的建立時間。

只有在 spaceTypeGROUP_CHATSPACE 時,系統才會在輸出內容中填入資料。

adminInstalled

boolean

僅供輸出。即時通訊應用程式是否由 Google Workspace 管理員安裝。管理員可以為網域、機構單位或使用者群組安裝 Chat 應用程式。

管理員只能安裝 Chat 專用應用程式,以便在使用者和應用程式之間傳送即時訊息。如要讓管理員安裝支援,您的應用程式必須提供即時訊息功能。

accessSettings

object (AccessSettings)

選用設定。指定聊天室的存取權設定。只有在 spaceTypeSPACE 時才會填入資料。

類型

已淘汰:請改用 SpaceType

列舉
TYPE_UNSPECIFIED
ROOM 兩位以上人類之間的對話。
DM 1:1 使用者與 Chat 應用程式互傳的即時訊息,所有訊息都是平面形式。請注意,這不包含兩人之間的即時訊息。

SpaceType

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

列舉
SPACE_TYPE_UNSPECIFIED 已預約。
SPACE 可供使用者傳送訊息、共用檔案及進行協作的地方。「SPACE」可包含 Chat 擴充應用程式。
GROUP_CHAT 與 3 位以上使用者進行群組對話。「GROUP_CHAT」可包含 Chat 擴充應用程式。
DIRECT_MESSAGE 兩人或人類與 Chat 應用程式互傳的 1:1 訊息。

SpaceThreadingState

指定 Chat 聊天室中的執行緒狀態類型。

列舉
SPACE_THREADING_STATE_UNSPECIFIED 已預約。
THREADED_MESSAGES 支援訊息討論串的已命名聊天室。使用者回覆訊息時,可以在討論串中回覆,回應原始訊息的內容。
GROUPED_MESSAGES 依主題分類對話的已命名聊天室。主題和回覆會歸在一組。
UNTHREADED_MESSAGES 與 3 位以上使用者互傳的即時訊息 (DM),以及群組對話。

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

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