Method: spaces.setup

Tạo một không gian và thêm những người dùng đã chỉ định vào không gian đó. Người dùng gọi sẽ tự động được thêm vào không gian và không được chỉ định là thành viên trong yêu cầu. Để biết ví dụ, hãy xem bài viết Thiết lập không gian có các thành viên ban đầu.

Để chỉ định thành viên là người dùng cần thêm, hãy thêm gói thành viên bằng membership.member.name thích hợp. Để thêm người dùng là con người, hãy sử dụng users/{user}, trong đó {user} có thể là địa chỉ email của người dùng. Đối với người dùng trong cùng một tổ chức Workspace, {user} cũng có thể là id cho người dùng trong API People hoặc id cho người dùng trong API Directory. Ví dụ: nếu mã hồ sơ người dùng của API People cho user@example.com là 123456789, thì bạn có thể thêm người dùng vào không gian bằng cách đặt membership.member.name thành users/user@example.com hoặc users/123456789.

Để chỉ định các nhóm Google cần thêm, hãy thêm gói thành viên bằng membership.group_member.name thích hợp. Để thêm hoặc mời một nhóm Google, hãy sử dụng groups/{group}, trong đó {group} là id cho nhóm đó trong Cloud Identity Groups API. Ví dụ: bạn có thể sử dụng API tra cứu Nhóm Cloud Identity để truy xuất mã nhận dạng 123456789 cho email nhóm group@example.com, sau đó thêm nhóm vào không gian bằng cách đặt membership.group_member.name thành groups/123456789. Không hỗ trợ email nhóm và bạn chỉ có thể thêm nhóm Google làm thành viên trong không gian có tên.

Đối với không gian có tên hoặc cuộc trò chuyện nhóm, nếu người gọi chặn hoặc bị một số thành viên chặn hoặc không có quyền thêm một số thành viên, thì những thành viên đó sẽ không được thêm vào không gian đã tạo.

Để tạo tin nhắn trực tiếp (DM) giữa người dùng gọi và một người dùng thực khác, hãy chỉ định chính xác một gói thành viên để đại diện cho người dùng thực. Nếu một người dùng chặn người dùng khác, thì yêu cầu sẽ không thành công và tin nhắn trực tiếp sẽ không được tạo.

Để tạo tin nhắn trực tiếp giữa người dùng gọi và ứng dụng gọi, hãy đặt Space.singleUserBotDm thành true và không chỉ định bất kỳ gói thành viên nào. Bạn chỉ có thể sử dụng phương thức này để thiết lập cuộc trò chuyện riêng tư với ứng dụng gọi. Để thêm ứng dụng gọi làm thành viên của một không gian hoặc cuộc trò chuyện riêng tư hiện có giữa hai người dùng, hãy xem bài viết Mời hoặc thêm người dùng hoặc ứng dụng vào không gian.

Nếu một cuộc trò chuyện riêng tư đã tồn tại giữa hai người dùng, ngay cả khi một người dùng chặn người dùng kia tại thời điểm yêu cầu được thực hiện, thì cuộc trò chuyện riêng tư hiện có sẽ được trả về.

Không hỗ trợ không gian có câu trả lời theo chuỗi. Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS khi thiết lập không gian, hãy thử một displayName khác. Một không gian hiện có trong tổ chức Google Workspace có thể đã sử dụng tên hiển thị này.

Yêu cầu xác thực người dùng.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Trường
space

object (Space)

Bắt buộc. Trường Space.spaceType là bắt buộc.

Để tạo một không gian, hãy đặt Space.spaceType thành SPACE và đặt Space.displayName. Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS khi thiết lập không gian, hãy thử một displayName khác. Một không gian hiện có trong tổ chức Google Workspace có thể đã sử dụng tên hiển thị này.

Để tạo cuộc trò chuyện nhóm, hãy đặt Space.spaceType thành GROUP_CHAT. Không đặt Space.displayName.

Để tạo cuộc trò chuyện 1:1 giữa con người, hãy đặt Space.spaceType thành DIRECT_MESSAGE và đặt Space.singleUserBotDm thành false. Không đặt Space.displayName hoặc Space.spaceDetails.

Để tạo cuộc trò chuyện 1:1 giữa người dùng và ứng dụng Chat đang gọi, hãy đặt Space.spaceType thành DIRECT_MESSAGE và Space.singleUserBotDm thành true. Không đặt Space.displayName hoặc Space.spaceDetails.

Nếu không gian DIRECT_MESSAGE đã tồn tại, thì không gian đó sẽ được trả về thay vì tạo không gian mới.
requestId

string

Không bắt buộc. Giá trị nhận dạng duy nhất cho yêu cầu này. Bạn nên dùng UUID ngẫu nhiên. Việc chỉ định mã yêu cầu hiện có sẽ trả về không gian được tạo bằng mã đó thay vì tạo không gian mới. Việc chỉ định mã yêu cầu hiện có từ cùng một ứng dụng Chat với một người dùng đã xác thực khác sẽ trả về lỗi.
memberships[]

object (Membership)

Không bắt buộc. Người dùng hoặc nhóm trên Google Chat mà bạn muốn mời tham gia không gian. Bỏ qua người dùng gọi vì họ được thêm tự động.

Tập hợp này hiện cho phép tối đa 49 gói thành viên (ngoài người gọi).

Đối với gói thành viên dành cho con người, trường Membership.member phải chứa user đã điền sẵn name (định dạng: users/{user}) và type được đặt thành User.Type.HUMAN. Bạn chỉ có thể thêm người dùng là con người khi thiết lập không gian (chỉ hỗ trợ thêm ứng dụng Chat để thiết lập tin nhắn trực tiếp với ứng dụng gọi điện). Bạn cũng có thể thêm thành viên bằng cách sử dụng email của người dùng làm email đại diện cho {user}. Ví dụ: user.name có thể là users/example@gmail.com. Để mời người dùng Gmail hoặc người dùng từ các miền Google Workspace bên ngoài, bạn phải sử dụng email của người dùng cho {user}.

Đối với tư cách thành viên nhóm trên Google, trường Membership.group_member phải chứa group đã điền sẵn name (định dạng groups/{group}). Bạn chỉ có thể thêm nhóm trên Google khi đặt Space.spaceType thành SPACE.

Không bắt buộc khi đặt Space.spaceType thành SPACE.

Bắt buộc khi đặt Space.spaceType thành GROUP_CHAT, cùng với ít nhất hai gói thành viên.

Bắt buộc khi đặt Space.spaceType thành DIRECT_MESSAGE với người dùng thực, cùng với đúng một gói thành viên.

Phải để trống khi tạo cuộc trò chuyện 1:1 giữa người dùng và ứng dụng Chat gọi (khi đặt Space.spaceType thành DIRECT_MESSAGE và Space.singleUserBotDm thành true).

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Space.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.