資源:Space
Google Chat 中的聊天室。聊天室是指兩人以上使用者之間的對話,或使用者與 Chat 應用程式之間的一對一訊息。
JSON 表示法 |
---|
{ "name": string, "type": enum ( |
欄位 | |
---|---|
name |
ID。聊天室的資源名稱。 格式: 其中 |
type |
僅供輸出。已淘汰:請改用 |
space |
選用設定。聊天室類型。建立聊天室或更新聊天室類型時必須提供。僅供其他用途使用。 |
single |
選用設定。聊天室是否為 Chat 應用程式與單一使用者之間的 DM。 |
threaded |
僅供輸出。已淘汰:請改用 |
display |
選用設定。聊天室的顯示名稱。使用 對於即時訊息,這個欄位可能會為空白。 最多支援 128 個半形字元。 |
external |
選用設定。不可變動。這個聊天室是否允許任何 Google Chat 使用者成為成員。在 Google Workspace 機構中建立聊天室時輸入。在下列情況下建立聊天室時,請省略這個欄位:
對於現有的聊天室,這個欄位僅供輸出。 |
space |
僅供輸出。Chat 聊天室中的討論串狀態。 |
space |
選用設定。聊天室的詳細資料,包括說明和規則。 |
space |
選用設定。這個聊天室中訊息和討論串的訊息記錄狀態。 |
import |
選用設定。這個聊天室是在 您必須通過使用者驗證,才能在 |
create |
選用設定。不可變動。如果是在 Chat 中建立的聊天室,則為聊天室建立的時間。這個欄位只會輸出,除非用於匯入模式聊天室。 如果是匯入模式聊天室,請將這個欄位設為來源中建立聊天室的歷史時間戳記,以便保留原始建立時間。 只有在 |
last |
僅供輸出。聊天室中最後一則訊息的時間戳記。 |
admin |
僅供輸出。針對使用 Chat 應用程式的即時訊息 (DM) 聊天室,請指出聊天室是由 Google Workspace 管理員建立。管理員可以代表機構中的使用者安裝 Chat 應用程式,並設定即時訊息。 如要支援管理員安裝功能,您的 Chat 應用程式必須提供即時訊息功能。 |
membership |
僅供輸出。已加入會員資格的次數,並按會員類型分組。當 |
access |
選用設定。指定聊天室的存取權設定。只有在 |
space |
僅供輸出。使用者存取聊天室的 URI。 |
import |
僅供輸出。如果聊天室仍處於匯入模式,系統會自動刪除聊天室。 在匯入模式中建立的每個聊天室,都必須在 這個欄位只會在使用匯入模式建立的聊天室中填入資料。 |
customer |
選用設定。不可變動。聊天室網域的客戶 ID。只有在使用應用程式驗證建立聊天室,且 格式為 對於即時訊息,這個欄位不會填入任何內容。 |
聯集欄位 需要使用者驗證。 |
|
predefined |
選用設定。僅限輸入。預先定義的聊天室權限設定,僅在建立聊天室時輸入。如果未設定這個欄位,系統會建立協作空間。建立聊天室後,系統會在 |
permission |
選用設定。現有聊天室的聊天室權限設定。用於更新確切的聊天室權限設定,取代現有的權限設定。輸出內容會列出目前的權限設定。 |
類型
已淘汰:請改用 SpaceType
。
列舉 | |
---|---|
TYPE_UNSPECIFIED |
保留。 |
ROOM |
兩人以上使用者之間的對話。 |
DM |
使用者與 Chat 應用程式之間的 1 對 1 即時訊息,所有訊息都是平面訊息。請注意,這項功能不包含兩位使用者之間的即時訊息。 |
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 |
兩人之間的即時訊息 (DM),以及 3 人以上參與者的群組對話。 |
SpaceDetails
聊天室的詳細資料,包括說明和規則。
JSON 表示法 |
---|
{ "description": string, "guidelines": string } |
欄位 | |
---|---|
description |
選用設定。聊天室說明。例如說明聊天室的討論主題、功能用途或參與者。 最多支援 150 個半形字元。 |
guidelines |
選用設定。聊天室的規則、期望和禮儀。 最多支援 5,000 個半形字元。 |
HistoryState
訊息和聊天室的記錄狀態。指定訊息和對話串建立後的保留時間。
列舉 | |
---|---|
HISTORY_STATE_UNSPECIFIED |
預設值。請勿使用。 |
HISTORY_OFF |
記錄關閉。訊息和對話串會保留 24 小時。 |
HISTORY_ON |
記錄功能已開啟。貴機構的保管箱資料保留規則會指定郵件和會話串保留的時間長度。 |
MembershipCount
代表聊天室成員人數,並分為不同類別。
JSON 表示法 |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
欄位 | |
---|---|
joined |
僅供輸出。直接加入聊天室的使用者人數,不含透過加入群組而加入聊天室的使用者。 |
joined |
僅供輸出。直接加入聊天室的所有群組數量。 |
AccessSettings
代表聊天室的存取權設定。
JSON 表示法 |
---|
{
"accessState": enum ( |
欄位 | |
---|---|
access |
僅供輸出。用於表示空間的存取狀態。 |
audience |
選用設定。目標對象的資源名稱,這些使用者可以探索聊天室、加入聊天室,以及預覽聊天室中的訊息。如果未設定,只有個別邀請或新增至聊天室的使用者或 Google 網路論壇成員才能存取聊天室。詳情請參閱「讓目標對象能夠輕鬆找到聊天室」。 格式: 如要使用 Google Workspace 機構的預設目標對象,請將值設為 讀取目標對象支援: 如果您使用 設定目標對象時,需要進行使用者驗證。 |
AccessState
代表聊天室的存取狀態。
列舉 | |
---|---|
ACCESS_STATE_UNSPECIFIED |
這個 API 不支援或無法判斷存取狀態。 |
PRIVATE |
只有其他使用者或 Google Workspace 管理員個別新增或邀請的使用者或 Google 網路論壇群組,才能探索及存取聊天室。 |
DISCOVERABLE |
聊天室管理員已授予目標對象聊天室存取權。已個別新增或邀請加入聊天室的使用者或 Google 群組,也可以探索及存取聊天室。詳情請參閱「讓特定使用者可自由加入聊天室」。 建立可自由加入的聊天室需要使用者驗證。 |
PredefinedPermissionSettings
預先定義的權限設定,您只能在建立命名聊天室時指定。日後可能會新增更多設定。如要進一步瞭解命名聊天室的權限設定,請參閱「瞭解聊天室」。
列舉 | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
不明。請勿使用。 |
COLLABORATION_SPACE |
設定,將聊天室設為協作聊天室,讓所有成員都能發布訊息。 |
ANNOUNCEMENT_SPACE |
將聊天室設為公告聊天室,只有聊天室管理員可以張貼訊息。 |
PermissionSettings
您可以在更新現有命名聊天室時指定的權限設定。
如要在建立空間時設定權限,請在要求中指定 PredefinedPermissionSettings
欄位。
JSON 表示法 |
---|
{ "manageMembersAndGroups": { object ( |
欄位 | |
---|---|
manage |
選用設定。管理聊天室成員和群組的設定。 |
modify |
選用設定。設定聊天室名稱、顯示圖片、說明和規範的更新方式。 |
toggle |
選用設定。用於開啟或關閉聊天室記錄的設定。 |
use |
選用設定。在聊天室中使用 @all 的設定。 |
manage |
選用設定。用於管理聊天室中應用程式的設定。 |
manage |
選用設定。用於管理聊天室中的 Webhook 設定。 |
post |
僅供輸出。在聊天室中張貼訊息的設定。 |
reply |
選用設定。回覆聊天室中訊息的設定。 |
PermissionSetting
代表聊天室權限設定。
JSON 表示法 |
---|
{ "managersAllowed": boolean, "membersAllowed": boolean } |
欄位 | |
---|---|
managers |
選用設定。聊天室管理員是否具備這項權限。 |
members |
選用設定。非管理員成員是否具備這項權限。 |
方法 |
|
---|---|
|
完成指定聊天室的匯入程序,並讓使用者查看。 |
|
建立聊天室。 |
|
刪除已命名的聊天室。 |
|
傳回與指定使用者互傳的現有即時訊息。 |
|
傳回聊天室的詳細資料。 |
|
列出呼叫端的聊天室成員。 |
|
更新聊天室。 |
|
根據管理員的搜尋內容,傳回 Google Workspace 機構中的聊天室清單。 |
|
建立聊天室並新增指定使用者。 |