Method: spaces.setup

建立聊天室並將指定使用者加入聊天室。發出呼叫的使用者會自動新增至聊天室，不應在要求中指定為成員。如需範例，請參閱「設定含有初始成員的聊天室」。

如要指定要新增的真人成員，請在 SetUpSpaceRequest 中新增具有適當 member.name 的成員。如要新增人類使用者，請使用 users/{user}，其中 {user} 可以是使用者的電子郵件地址。對於相同 Workspace 機構 ({user}) 中的使用者，其可以是 People API 中使用者的 id，或是 Directory API 中使用者的 id。舉例來說，如果 user@example.com 的 People API 個人資料 ID 為 123456789，您可以將 membership.member.name 設為 users/user@example.com 或 users/123456789，將使用者新增至聊天室。

以聊天室或群組通訊來說，如果來電者封鎖或遭到部分成員封鎖，系統就不會將這類成員新增至已建立的聊天室。

如要在進行通話的使用者和另一位真人使用者之間建立即時訊息 (DM)，請明確指定一個成員身分，代表該使用者身分。如果其中一位使用者封鎖對方，要求就會失敗，且不會建立即時訊息。

如要在發出呼叫的使用者和呼叫應用程式之間建立即時訊息，請將 Space.singleUserBotDm 設為 true，且不要指定任何成員。你只能使用這個方法透過呼叫應用程式設定即時訊息。如要將通話應用程式新增為聊天室成員，或是兩位真人使用者的現有即時訊息，請參閱「邀請使用者或應用程式加入聊天室」。

如果兩位使用者之間已有即時訊息，即使使用者在提出要求時封鎖對方，系統也會傳回現有的即時訊息。

不支援含有討論串回覆的聊天室。如果你在設定聊天室時收到錯誤訊息 ALREADY_EXISTS，請改用其他displayName。Google Workspace 機構中的現有聊天室可能已使用這個顯示名稱。

必須完成使用者驗證。

HTTP 要求

POST https://chat.googleapis.com/v1/spaces:setup

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
欄位
space

object (Space)

必要欄位。Space.spaceType 為必填欄位。

如要建立聊天室，請將 Space.spaceType 設為 SPACE 並設定 Space.displayName。如果你在設定聊天室時收到錯誤訊息 ALREADY_EXISTS，請改用其他displayName。Google Workspace 機構中的現有聊天室可能已使用這個顯示名稱。

如要建立群組通訊，請將 Space.spaceType 設為 GROUP_CHAT。不要設定 Space.displayName。

如要在人類之間建立 1:1 對話，請將 Space.spaceType 設為 DIRECT_MESSAGE，並將 Space.singleUserBotDm 設為 false。請勿設定 Space.displayName 或 Space.spaceDetails。

如要在真人和正在通話的 Chat 應用程式之間建立 1:1 對話，請將 Space.spaceType 設為 DIRECT_MESSAGE，並將 Space.singleUserBotDm 設為 true。請勿設定 Space.displayName 或 Space.spaceDetails。

如果 DIRECT_MESSAGE 聊天室已存在，系統會傳回該聊天室，而不會建立新聊天室。
requestId

string

選用設定。這項要求的專屬 ID。建議使用隨機 UUID。指定現有的要求 ID 會傳回以該 ID 建立的聊天室，而不會建立新聊天室。如果以不同的已驗證使用者指定相同的 Chat 應用程式，指定現有的要求 ID，則會傳回錯誤。
memberships[]

object (Membership)

選用設定。要邀請加入聊天室的 Google Chat 使用者。忽略發出呼叫的使用者，因為系統會自動新增呼叫者。

除了呼叫者外，目前此組合最多可擁有 20 個成員。

Membership.member 欄位必須包含 user，且已填入 name (格式：users/{user})，且 type 須設為 User.Type.HUMAN。你只能在設定聊天室時新增真人使用者。如要新增即時通訊應用程式，必須使用通話應用程式的即時訊息設定。您也可以透過使用者的電子郵件地址做為 {user} 的別名，為成員新增成員。舉例來說，user.name 可以是 users/example@gmail.com。如要邀請 Gmail 使用者或外部 Google Workspace 網域的使用者，使用者的電子郵件地址必須用於 {user}。

將 Space.spaceType 設為 SPACE 時可選用，

將 Space.spaceType 設為 GROUP_CHAT，且至少有兩個會籍時，此為必填屬性。

如果您和真人使用者將 Space.spaceType 設為 DIRECT_MESSAGE，且只有一個成員資格，則為必要欄位。

在真人與呼叫的 Chat 應用程式之間建立 1:1 對話時 (將 Space.spaceType 設為 DIRECT_MESSAGE、Space.singleUserBotDm 設為 true 時)，該對話必須留空。

回應主體

如果成功，回應主體會包含 Space 的執行例項。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

詳情請參閱授權指南。