Method: spaces.setup

Tạo một không gian và thêm những 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à không được chỉ định làm thành viên trong yêu cầu. Để biết ví dụ, hãy xem Thiết lập không gian có những thành viên đầu tiên.

Để chỉ định những thành viên mà bạn muốn thêm, hãy thêm gói thành viên có membership.member.name phù hợp. Để thêm người dùng là người thật, 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ơ cá nhân API Mọi người cho 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.

Để chỉ định các nhóm Google cần thêm, hãy thêm các thành viên bằng membership.group_member.name thích hợp. Để thêm hoặc mời một nhóm trên Google Groups, hãy sử dụng groups/{group}, trong đó {group} là id cho nhóm từ API Cloud Identity Groups. Ví dụ: bạn có thể sử dụng API tra cứu nhóm trên Cloud Identity để truy xuất mã 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. Email nhóm không được hỗ trợ và bạn chỉ có thể thêm nhóm trên Google làm thành viên trong các không gian được đặt tên.

Đối với không gian hoặc cuộc trò chuyện nhóm có tên, 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 đang gọi và một người dùng 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 đó. Nếu một người dùng chặn người kia, thì yêu cầu sẽ không thành công và tin nhắn trực tiếp 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ể dùng phương thức này để thiết lập tin nhắn trực tiếp với ứng dụng gọi. Để thêm ứng dụng gọi làm thành viên của không gian hoặc 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/ứ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 vào thời điểm có 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 không gian, hãy thử một displayName khác. Một không gian hiện có trong tổ chức trên 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 không gian, hãy thử một displayName khác. Một không gian hiện có trong tổ chức trên 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. Đừng đặt Space.displayName.

Để tạo cuộc trò chuyện 1:1 giữa những 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 gọi điện trong Chat, 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ã nhận dạng duy nhất (UUID) ngẫu nhiên. Việc chỉ định mã nhận dạng yêu cầu hiện có sẽ trả về không gian được tạo bằng mã nhận dạng đó 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 Google Chat mà bạn muốn mời tham gia không gian. Bỏ qua người dùng đang gọi vì người dùng này được thêm tự động.

Chế độ này hiện cho phép sử dụng tối đa 20 thành viên (ngoài người gọi).

Đối với tư cách thành viên do con người thực hiện, 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 khi thiết lập không gian (tính năng thêm ứng dụng trong Chat chỉ được hỗ trợ khi thiết lập tin nhắn trực tiếp bằng ứng dụng gọi điện). Bạn cũng có thể thêm thành viên bằ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 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}.

Đối với tư cách thành viên trong nhóm trên Google Groups, trường Membership.group_member phải chứa group có name được điền sẵn (định dạng groups/{group}). Bạn chỉ có thể thêm các nhóm trên Google Groups 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 2 gói thành viên.

Bắt buộc khi đặt Space.spaceType thành DIRECT_MESSAGE với một người dùng là người, 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 nhắn tin đang 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.