資源:Space
Google Chat 中的聊天室。聊天室是指兩位以上的使用者,或是使用者與 Chat 應用程式之間的 1:1 訊息。
JSON 表示法 |
---|
{ "name": string, "type": enum ( |
欄位 | |
---|---|
name |
聊天室的資源名稱。 格式︰ |
type |
僅供輸出。已淘汰:請改用 |
spaceType |
聊天室類型。建立聊天室或更新聊天室類型時必填。僅供其他用途使用。 |
singleUserBotDm |
選用設定。聊天室是否為 Chat 應用程式和一位真人之間的即時訊息。 |
threaded |
僅供輸出。已淘汰:請改用 |
displayName |
聊天室的顯示名稱。建立聊天室時為必要欄位。如果在建立聊天室或更新 如果是即時訊息,這個欄位可能會空白。 長度上限為 128 個半形字元。 |
externalUserAllowed |
不可變動。這個聊天室是否允許任何 Google Chat 使用者成為成員。在 Google Workspace 機構中建立聊天室時輸入。在下列情況下建立空格,請省略這個欄位:
如為現有聊天室,這個欄位只會輸出。 |
spaceThreadingState |
僅供輸出。Chat 聊天室的討論串狀態。 |
spaceDetails |
聊天室詳細資料,包括說明和規則。 |
spaceHistoryState |
這個聊天室中訊息和討論串的訊息記錄狀態。 |
importMode |
選用設定。這個聊天室是否在遷移至 Google Workspace 的過程中在「 |
createTime |
選用設定。不可變動。在 Chat 中建立的聊天室,這是聊天室的建立時間。這個欄位只會輸出,但用於匯入模式空格時除外。 針對匯入模式聊天室,請將這個欄位設為在來源中建立聊天室時的歷來時間戳記,以保留原本的建立時間。 只有在 |
adminInstalled |
僅供輸出。搭配 Chat 應用程式的即時訊息 (DM) 聊天室 (無論聊天室是否由 Google Workspace 管理員建立)。管理員可以代表機構中的使用者安裝 Chat 應用程式及設定即時訊息。 如要支援管理員安裝功能,Chat 應用程式必須提供即時訊息功能。 |
accessSettings |
選用設定。指定聊天室的存取權設定。只有在 |
spaceUri |
僅供輸出。聊天室的 URI。 |
類型
已淘汰:請改用 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 |
選用設定。聊天室說明。例如,描述聊天室的討論主題、功能用途或參與者。 長度上限為 150 個半形字元。 |
guidelines |
選用設定。聊天室的規則、期望和禮儀。 最多可以支援 5,000 個半形字元。 |
HistoryState
訊息和聊天室的記錄狀態。指定訊息和討論串建立後要保留多久。
列舉 | |
---|---|
HISTORY_STATE_UNSPECIFIED |
預設值。請勿使用。 |
HISTORY_OFF |
記錄功能已關閉。訊息和討論串會保留 24 小時。 |
HISTORY_ON |
記錄功能已開啟。機構的保管箱資料保留規則會指定訊息和討論串的保留時間。 |
AccessSettings
代表聊天室的存取權設定。
JSON 表示法 |
---|
{
"accessState": enum ( |
欄位 | |
---|---|
accessState |
僅供輸出。指出聊天室的存取狀態。 |
audience |
選用設定。可存取聊天室的目標對象資源名稱。如要讓聊天室可供搜尋,請將這個欄位設為有效的目標對象 ID,或是使用 |
AccessState
代表聊天室的存取權狀態。
列舉 | |
---|---|
ACCESS_STATE_UNSPECIFIED |
存取權狀態不明或不受這個 API 支援。 |
PRIVATE |
加入或受邀的成員或群組可搜尋聊天室。 |
DISCOVERABLE |
可供所選目標對象、已新增或受邀的成員或群組搜尋聊天室。 |
方法 |
|
---|---|
|
完成指定聊天室的匯入程序,並向使用者顯示。 |
|
建立已命名的聊天室。 |
|
刪除已命名的聊天室。 |
|
傳回指定使用者的現有即時訊息。 |
|
傳回聊天室詳細資料。 |
|
列出呼叫者所屬的聊天室。 |
|
更新聊天室。 |
|
建立聊天室並將指定使用者加入聊天室。 |