REST Resource: spaces

資源：Space

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,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,
  "importModeExpireTime": string,
  "customer": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
欄位
name

string

ID。聊天室的資源名稱。

格式：spaces/{space}

其中 {space} 代表系統指派給空間的 ID。您可以呼叫 spaces.list() 方法，或從聊天室網址取得聊天室 ID。舉例來說，如果聊天室網址為 https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA，則聊天室 ID 為 AAAAAAAAA。
type
(deprecated)

enum (Type)

僅供輸出。已淘汰：請改用 spaceType。聊天室類型。
spaceType

enum (SpaceType)

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

boolean

選用設定。聊天室是否為 Chat 應用程式與單一使用者之間的 DM。
threaded
(deprecated)

boolean

僅供輸出。已淘汰：請改用 spaceThreadingState。這個聊天室中的訊息是否為討論串。
displayName

string

選用設定。聊天室的顯示名稱。使用 SPACE 的 spaceType 建立聊天室時，這是必要屬性。如果在建立聊天室或更新 displayName 時收到 ALREADY_EXISTS 錯誤訊息，請嘗試使用其他 displayName。Google Workspace 機構中現有的聊天室可能已使用這個顯示名稱。

對於即時訊息，這個欄位可能會為空白。

最多支援 128 個半形字元。
externalUserAllowed

boolean

選用設定。不可變動。這個聊天室是否允許任何 Google Chat 使用者加入。在 Google Workspace 機構中建立聊天室時輸入。在下列情況下建立聊天室時，請省略這個欄位：

  • 已驗證的使用者使用的是個人帳戶 (非代管使用者帳戶)。根據預設，個人帳戶建立的聊天室會允許任何 Google Chat 使用者加入。

對於現有的聊天室，這個欄位僅供輸出。
spaceThreadingState

enum (SpaceThreadingState)

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

object (SpaceDetails)

選用設定。聊天室的詳細資料，包括說明和規則。
spaceHistoryState

enum (HistoryState)

選用設定。這個聊天室中訊息和討論串的訊息記錄狀態。
importMode

boolean

選用設定。這個聊天室是在 Import Mode 中建立，並且是將資料遷移至 Google Workspace 的一部分。匯入聊天室時，使用者必須等到匯入作業完成後，才能看到聊天室。

您必須通過使用者驗證，才能在 Import Mode 中建立聊天室。
createTime

string (Timestamp format)

選用設定。不可變動。如果是在 Chat 中建立的聊天室，則為聊天室建立的時間。這個欄位只會輸出，除非用於匯入模式聊天室。

如果是匯入模式聊天室，請將這個欄位設為來源中建立聊天室的歷史時間戳記，以便保留原始建立時間。

只有在 spaceType 為 GROUP_CHAT 或 SPACE 時，輸出內容才會填入這個參照。
lastActiveTime

string (Timestamp format)

僅供輸出。聊天室中最後一則訊息的時間戳記。
adminInstalled

boolean

僅供輸出。針對使用 Chat 應用程式的即時訊息 (DM) 聊天室，是否由 Google Workspace 管理員建立聊天室。管理員可以代表機構中的使用者安裝 Chat 應用程式，並設定即時訊息。

如要支援管理員安裝功能，您的 Chat 應用程式必須提供即時訊息功能。
membershipCount

object (MembershipCount)

僅供輸出。已加入會員資格的次數，並按會員類型分組。當 spaceType 為 SPACE、DIRECT_MESSAGE 或 GROUP_CHAT 時，系統會填入這個值。
accessSettings

object (AccessSettings)

選用設定。指定聊天室的存取權設定。只有在 spaceType 為 SPACE 時才會填入。
spaceUri

string

僅供輸出。使用者存取聊天室的 URI。
importModeExpireTime

string (Timestamp format)

僅供輸出。如果聊天室仍處於匯入模式，系統會自動刪除聊天室。

在匯入模式中建立的每個聊天室，都必須在這個到期時間前使用 spaces.completeImport 退出這個模式。

這個欄位只會在使用匯入模式建立的聊天室中填入資料。
customer

string

選用設定。不可變動。聊天室網域的客戶 ID。只有在使用應用程式驗證建立聊天室，且 SpaceType 為 SPACE 時才需要設定，否則不應設定。

格式為 customers/{customer}，其中 customer 是 [Admin SDK 客戶資源]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) 中的 id。私人應用程式也可以使用 customers/my_customer 別名，在與應用程式相同的 Google Workspace 機構中建立聊天室。

對於即時訊息，這個欄位不會填入任何內容。

聯集欄位 space_permission_settings。代表聊天室的權限設定。只有在 space_type 為 SPACE 時才會填入。

需要使用者驗證。space_permission_settings 只能是下列其中一項：
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

選用設定。僅限輸入。預先定義的聊天室權限設定，僅在建立聊天室時輸入。如果未設定這個欄位，系統會建立協作空間。建立聊天室後，系統會在 PermissionSettings 欄位中填入設定。
permissionSettings

object (PermissionSettings)

選用設定。現有聊天室的聊天室權限設定。輸入內容會用來更新確切的聊天室權限設定，取代現有的權限設定。輸出內容會列出目前的權限設定。

類型

已淘汰：請改用 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

string

選用設定。聊天室說明。例如說明聊天室的討論主題、功能用途或參與者。

最多支援 150 個半形字元。
guidelines

string

選用設定。聊天室的規則、期望和禮儀。

最多支援 5,000 個半形字元。

HistoryState

訊息和聊天室的記錄狀態。指定訊息和對話串建立後的保留時間。

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

MembershipCount

代表聊天室成員人數，並分為不同類別。

JSON 表示法 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
欄位
joinedDirectHumanUserCount

integer

僅供輸出。直接加入聊天室的使用者人數，不含透過加入群組而加入聊天室的使用者。
joinedGroupCount

integer

僅供輸出。直接加入聊天室的所有群組數量。

AccessSettings

代表聊天室的存取權設定。

JSON 表示法 
{
  "accessState": enum (AccessState),
  "audience": string
}
欄位
accessState

enum (AccessState)

僅供輸出。用於表示空間的存取狀態。
audience

string

選用設定。目標對象的資源名稱，這些使用者可以探索聊天室、加入聊天室，以及預覽聊天室中的訊息。如果未設定，只有個別邀請或新增至聊天室的使用者或 Google 網路論壇群組才能存取聊天室。詳情請參閱「讓聊天室可供目標對象發現」。

格式：audiences/{audience}

如要使用 Google Workspace 機構的預設目標對象，請將值設為 audiences/default。

讀取目標對象支援：

如果您使用 chat.bot 範圍搭配應用程式驗證，系統就不會填入這個欄位。

設定目標對象時，需要進行使用者驗證。

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 (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
欄位
manageMembersAndGroups

object (PermissionSetting)

選用設定。管理聊天室成員和群組的設定。
modifySpaceDetails

object (PermissionSetting)

選用設定。設定聊天室名稱、顯示圖片、說明和規範的更新方式。
toggleHistory

object (PermissionSetting)

選用設定。用於開啟或關閉聊天室記錄的設定。
useAtMentionAll

object (PermissionSetting)

選用設定。在聊天室中使用 @all 的設定。
manageApps

object (PermissionSetting)

選用設定。用於管理聊天室中應用程式的設定。
manageWebhooks

object (PermissionSetting)

選用設定。用於管理聊天室中的 Webhook 設定。
postMessages

object (PermissionSetting)

僅供輸出。在聊天室中張貼訊息的設定。
replyMessages

object (PermissionSetting)

選用設定。回覆聊天室訊息的設定。

PermissionSetting

代表聊天室權限設定。

JSON 表示法 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
欄位
managersAllowed

boolean

選用設定。聊天室管理員是否具備這項權限。
membersAllowed

boolean

選用設定。非管理員成員是否具備這項權限。

方法

completeImport

 為指定的聊天室完成匯入程序，並讓使用者查看。

create

 建立聊天室。

delete

 刪除已命名的聊天室。

findDirectMessage

 傳回與指定使用者現有的即時訊息。

get

 傳回聊天室的詳細資料。

list

 列出呼叫端的聊天室成員。

patch

 更新聊天室。
根據管理員的搜尋內容，傳回 Google Workspace 機構中的聊天室清單。

setup

 建立聊天室並新增指定使用者。