Method: spaces.setup

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

建立聊天室，並在其中新增指定使用者。系統會自動將通話使用者加入聊天室，且你不應在要求中指定為成員資格，

如要指定要新增的成員，請在 SetUpSpaceRequest 中新增含有適當 member.name 的成員資格。如要新增使用者，請使用 users/{user}，其中 {user} 是 People API 中 person 的 {person_id}，或 Admin SDK Directory API 中 user 的 id。舉例來說，如果 People API Person resourceName 為 people/123456789，您可以將 users/123456789 加入為 member.name 的成員資格，藉此將使用者加入聊天室。

如要在通話使用者和其他使用者使用者之間建立即時訊息 (DM)，請指定一個能代表真人使用者的成員。

如要在通話使用者和通話應用程式之間建立即時訊息，請將 Space.singleUserBotDm 設為 true，且不要指定任何成員資格。您只能使用這個方法，將應用程式成員資格新增至即時訊息。如要將通話應用程式新增為其他聊天室類型的成員，請使用建立成員資格。

如果 2 位使用者之間已經有 DM，系統會傳回該 DM。否則，系統會建立即時訊息。

系統不支援有討論串式回覆或開放訪客加入的聊天室。

需要使用者驗證和 chat.spaces.create 範圍。

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。

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

如要在人與人之間進行 1:1 對話，請將 Space.spaceType 設為 DIRECT_MESSAGE，並將 Space.singleUserBotDm 設為 false。不要設定 Space.displayName 或 Space.spaceDetails。

如要在人類與通話即時通訊應用程式之間建立 1:1 對話，請將 Space.spaceType 設為 DIRECT_MESSAGE，並將 Space.singleUserBotDm 設為 true。不要設定 Space.displayName 或 Space.spaceDetails。
requestId

string

選填欄位，這個要求的專屬 ID。建議使用隨機的 UUID。只有在提供 requestId 或 DM 已存在時，此要求才是冪等的。透過不同已驗證使用者的同一個即時通訊應用程式指定 requestId 現有的值，就會傳回錯誤。
memberships[]

object (Membership)

選填欄位，受邀加入聊天室的網域內使用者或群組初始組合。

目前最多只能設定 20 個會員。

Membership.member 欄位必須包含填入 name 和 User.Type.HUMAN 的使用者。系統會忽略所有其他欄位。

將Space.spaceType設為SPACE，以及至少一項成員資格時為必填。

將Space.spaceType設為GROUP_CHAT時，以及至少兩位成員為必填欄位。

將 Space.spaceType 設為 DIRECT_MESSAGE 時，必須取得真人使用者，並只取得一名成員資格。

建立真人與撥號即時通訊應用程式之間的 1:1 對話時 (必須將 Space.spaceType 設為 DIRECT_MESSAGE 並將 Space.singleUserBotDm 設為 true)。

不支援：邀請使用者或新增其他即時通訊應用程式。

回應主體

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。