Method: spaces.setup

Tạo không gian và thêm người dùng được 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à bạn không nên chỉ định người dùng đó làm 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 với các thành viên đầu tiên.

Để chỉ định những thành viên cần thêm, hãy thêm thành viên bằng member.name thích hợp trong SetUpSpaceRequest. Để thêm người dùng, 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 đối với người dùng trong API Mọi người hoặc id đối với người dùng trong API Thư mục. Ví dụ: nếu mã hồ sơ người dùng API People của user@example.com là 123456789, 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.

Đối với một không gian 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, 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 khác, hãy chỉ định chính xác một thành viên đại diện cho người dùng đó. Nếu một người dùng chặn người dùng kia, 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ỳ thành viên nào. Bạn chỉ có thể sử dụng phương thức này để thiết lập tin nhắn trực tiếp bằng ứng dụng gọi điện. Để thêm ứng dụng gọi làm thành viên của một không gian hoặc một tin nhắn trực tiếp hiện có giữa hai người dùng, hãy xem phần Mời hoặc thêm người dùng hay ứng dụng vào không gian.

Nếu một tin nhắn trực tiếp đã 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 đưa ra yêu cầu, thì tin nhắn trực tiếp 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 một không gian, hãy thử một displayName khác. Một không gian hiện tại 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 không gian, hãy đặt Space.spaceType thành SPACE rồi đặt Space.displayName. Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS khi thiết lập một không gian, hãy thử một displayName khác. Một không gian hiện tại 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 với nhau, hãy đặt Space.spaceType thành DIRECT_MESSAGE và đặt Space.singleUserBotDm thành false. Đừ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 nhắn tin gọi điện, hãy đặt Space.spaceType thành DIRECT_MESSAGE và Space.singleUserBotDm thành true. Đừng đặt Space.displayName hoặc Space.spaceDetails.

Nếu đã có một không gian DIRECT_MESSAGE, thì không gian đó sẽ được trả về thay vì tạo một 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 một mã nhận dạng duy nhất (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ột 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ề một lỗi.
memberships[]

object (Membership)

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

Nhóm này hiện cho phép tối đa 20 thành viên (ngoài người gọi).

Trường Membership.member phải chứa user có name được điền sẵn (đị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à người khi thiết lập không gian (chỉ hỗ trợ thêm ứng dụng trong Chat khi 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 biệt hiệu 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 thuộc 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}.

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 2 gói thành viên.

Bắt buộc khi đặt Space.spaceType thành DIRECT_MESSAGE với người dùng là người, cùng với đúng một tư cách 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 (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 đây:

  • 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 bài viết Hướng dẫn uỷ quyền.