Package google.chat.v1

Chỉ mục

ChatService

Cho phép nhà phát triển xây dựng các ứng dụng và dịch vụ tích hợp trong Chat trên Nền tảng Google Chat.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Hoàn tất quy trình nhập không gian được chỉ định và hiển thị không gian đó cho người dùng. Yêu cầu xác thực ứng dụng và uỷ quyền trên toàn miền. Để biết thêm thông tin, hãy xem bài viết Cho phép ứng dụng Google Chat nhập dữ liệu.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/chat.import

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Tạo gói thành viên do con người thực hiện hoặc gói thành viên của ứng dụng cho ứng dụng gọi. Không hỗ trợ tạo gói thành viên cho các ứng dụng khác. Ví dụ: hãy xem bài viết Mời hoặc thêm người dùng hoặc ứng dụng Google Chat vào một không gian. Khi tạo thành viên, nếu thành viên được chỉ định đã tắt chính sách tự động chấp nhận, thì họ sẽ được mời và phải chấp nhận lời mời tham gia không gian. Nếu không, khi tạo một thành viên, thành viên đó sẽ được thêm trực tiếp vào không gian được chỉ định. Yêu cầu xác thực người dùng.

Để chỉ định thành viên cần thêm, hãy đặt membership.member.name cho thành viên trong ứng dụng hoặc người thực, hoặc đặt membership.group_member.name cho thành viên nhóm.

  • Để thêm ứng dụng gọi điện vào một không gian hoặc tin nhắn trực tiếp giữa 2 người dùng, hãy sử dụng users/app. Không thể thêm các ứng dụng khác vào không gian.

  • Để 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.

  • Để thêm hoặc mời một nhóm trên Google Groups trong không gian được đặt tên, hãy sử dụng groups/{group}, trong đó {group} là id cho nhóm theo 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 hoặc mời nhóm vào một không gian được đặt tên 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 Groups làm thành viên trong các không gian được đặt tên.

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.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

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

rpc CreateMessage(CreateMessageRequest) returns (Message)

Tạo tin nhắn trong phòng Google Chat. Kích thước tin nhắn tối đa (bao gồm cả văn bản và thẻ) là 32.000 byte. Để biết ví dụ, hãy xem phần Gửi tin nhắn.

Để gọi phương thức này, bạn phải xác thực và hỗ trợ các loại xác thực sau:

  • Đối với tin nhắn văn bản, hệ thống hỗ trợ xác thực người dùng hoặc xác thực ứng dụng.
  • Đối với tin nhắn qua thẻ, hệ thống chỉ hỗ trợ phương thức xác thực ứng dụng. (Chỉ các ứng dụng trong Chat mới có thể tạo tin nhắn thẻ.)
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.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

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

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Tạo một lượt thể hiện cảm xúc rồi thêm vào một tin nhắn. Chỉ hỗ trợ biểu tượng cảm xúc Unicode. Để xem ví dụ, hãy xem bài viết Thêm biểu tượng cảm xúc vào tin nhắn. Yêu cầu xác thực người dùng.

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.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

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

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Tạo một không gian được đặt tên. Không hỗ trợ không gian được nhóm theo chủ đề. Để biết ví dụ, hãy xem phần Tạo không gian.

Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS khi tạo 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.

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.import
  • 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.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Xoá gói thành viên. Ví dụ: xem phần Xoá người dùng hoặc ứng dụng Google Chat khỏi một không gian.

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

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.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

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

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Xoá tin nhắn. Để xem ví dụ, hãy xem phần Xoá thư.

Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng. Khi sử dụng phương thức xác thực ứng dụng, các yêu cầu chỉ có thể xoá tin nhắn do ứng dụng gọi điện tạo trong Chat.

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.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

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

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Xoá lượt thể hiện cảm xúc với một tin nhắn. Chỉ hỗ trợ biểu tượng cảm xúc Unicode. Để biết ví dụ, hãy xem bài viết Xoá một lượt thể hiện cảm xúc. Yêu cầu xác thực người dùng.

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.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

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

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Xoá một không gian đã đặt tên. Luôn xoá theo tầng, tức là tài nguyên con của không gian (chẳng hạn như tin nhắn được đăng trong không gian và thành viên trong không gian) cũng sẽ bị xoá. Ví dụ: hãy xem phần Xoá không gian. Yêu cầu xác thực người dùng của người dùng có quyền xoá không gian.

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.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

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

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Trả về tin nhắn trực tiếp hiện có với người dùng được chỉ định. Nếu không tìm thấy không gian tin nhắn trực tiếp, hàm sẽ trả về lỗi 404 NOT_FOUND. Để biết ví dụ, hãy xem phần Tìm tin nhắn trực tiếp.

Với xác thực người dùng, hàm sẽ trả về không gian tin nhắn trực tiếp giữa người dùng đã chỉ định và người dùng được xác thực.

Với chế độ xác thực ứng dụng, hãy trả về không gian tin nhắn trực tiếp giữa người dùng đã chỉ định và ứng dụng gọi trong Chat.

Cần phải xác thực người dùng hoặc xác thực ứng dụng.

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.readonly
  • https://www.googleapis.com/auth/chat.bot

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Lấy siêu dữ liệu của tệp đính kèm tin nhắn. Dữ liệu tệp đính kèm được tìm nạp bằng API nội dung nghe nhìn. Để biết ví dụ, hãy xem phần Lấy siêu dữ liệu về tệp đính kèm tin nhắn. Yêu cầu xác thực ứng dụng.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/chat.bot

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

rpc GetMembership(GetMembershipRequest) returns (Membership)

Trả về thông tin chi tiết về một gói thành viên. Ví dụ: xem bài viết Xem thông tin chi tiết về gói thành viên của người dùng hoặc gói thành viên của ứng dụng Google Chat.

Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng.

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.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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

rpc GetMessage(GetMessageRequest) returns (Message)

Trả về thông tin chi tiết về một tin nhắn. Để xem ví dụ, hãy xem phần Xem thông tin chi tiết về một tin nhắn.

Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng.

Lưu ý: Có thể trả về tin nhắn của một thành viên hoặc không gian bị chặn.

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.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

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

rpc GetSpace(GetSpaceRequest) returns (Space)

Trả về thông tin chi tiết về một không gian. Để xem ví dụ, hãy xem phần Xem thông tin chi tiết về một không gian.

Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng.

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.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

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

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Trả về một sự kiện từ phòng Google Chat. Tải trọng sự kiện chứa phiên bản gần đây nhất của tài nguyên đã thay đổi. Ví dụ: nếu bạn yêu cầu một sự kiện về một thông báo mới nhưng sau đó thông báo đó được cập nhật, thì máy chủ sẽ trả về tài nguyên Message đã cập nhật trong tải trọng sự kiện.

Yêu cầu xác thực người dùng. Để nhận một sự kiện, người dùng đã xác thực phải là thành viên của không gian.

Ví dụ: xem phần Xem thông tin chi tiết về một sự kiện từ một phòng Google Chat.

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.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Trả về thông tin chi tiết về trạng thái đã đọc của người dùng trong một không gian, dùng để xác định tin nhắn đã đọc và chưa đọc. Ví dụ: xem phần Nhận thông tin chi tiết về trạng thái đọc không gian của người dùng.

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

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.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

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

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Trả về thông tin chi tiết về trạng thái đã đọc của người dùng trong một chuỗi, dùng để xác định thư đã đọc và chưa đọc. Ví dụ: hãy xem phần Xem thông tin chi tiết về trạng thái đọc chuỗi của người dùng.

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

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.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

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

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Liệt kê thành viên trong một không gian. Ví dụ: hãy xem bài viết Liệt kê người dùng và ứng dụng Google Chat trong một không gian. Thành viên của trang thông tin có phương thức xác thực ứng dụng liệt kê tư cách thành viên trong những không gian mà ứng dụng Chat có quyền truy cập, nhưng không bao gồm tư cách thành viên của ứng dụng Chat, kể cả không gian của chính ứng dụng đó. Thành viên của trang thông tin có chế độ Xác thực người dùng liệt kê thành viên trong những không gian mà người dùng đã xác thực có quyền truy cập.

Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng.

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.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Liệt kê tin nhắn trong một không gian mà người gọi là thành viên, bao gồm cả tin nhắn của các thành viên và không gian bị chặn. Để biết ví dụ, hãy xem bài viết Liệt kê tin nhắn. Yêu cầu xác thực người dùng.

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.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

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

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Liệt kê các lượt bày tỏ cảm xúc với một tin nhắn. Để xem ví dụ, hãy xem bài viết Liệt kê các lượt thể hiện cảm xúc cho một tin nhắn. Yêu cầu xác thực người dùng.

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.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Liệt kê các sự kiện từ một phòng Google Chat. Đối với mỗi sự kiện, tải trọng chứa phiên bản mới nhất của tài nguyên trong Chat. Ví dụ: nếu bạn liệt kê sự kiện về thành viên mới của không gian, máy chủ sẽ trả về các tài nguyên Membership chứa thông tin chi tiết mới nhất về thành viên. Nếu các thành viên mới bị xoá trong khoảng thời gian được yêu cầu, thì tải trọng sự kiện sẽ chứa một tài nguyên Membership trống.

Yêu cầu xác thực người dùng. Để liệt kê các sự kiện, người dùng đã xác thực phải là thành viên của không gian.

Ví dụ: hãy xem bài viết Liệt kê các sự kiện từ một phòng Google Chat.

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.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Liệt kê các không gian mà phương thức gọi là thành viên. Các cuộc trò chuyện nhóm và tin nhắn trực tiếp không được liệt kê cho đến khi tin nhắn đầu tiên được gửi. Để biết ví dụ, hãy xem phần Liệt kê không gian.

Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng.

Liệt kê các không gian hiển thị cho người gọi hoặc người dùng đã xác thực. Các cuộc trò chuyện nhóm và tin nhắn trực tiếp không được liệt kê cho đến khi tin nhắn đầu tiên được gửi.

Để liệt kê tất cả không gian có tên theo tổ chức trên Google Workspace, hãy sử dụng phương thức spaces.search() bằng các đặc quyền của quản trị viên Workspace.

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.readonly
  • https://www.googleapis.com/auth/chat.bot

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

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Trả về danh sách không gian dựa trên nội dung tìm kiếm của người dùng. Yêu cầu xác thực người dùng. Người dùng phải là quản trị viên của tổ chức Google Workspace. Trong yêu cầu, hãy đặt use_admin_access thành true.

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.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

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

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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 Groups 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ể 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. Để 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 2 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 còn lại 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.

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.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Cập nhật một gói thành viên. Ví dụ: xem phần Cập nhật gói thành viên của người dùng trong một không gian.

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

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.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

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

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Cập nhật tin nhắn. Có sự khác biệt giữa phương thức patch và update. Phương thức patch sử dụng yêu cầu patch còn phương thức update sử dụng yêu cầu put. Bạn nên sử dụng phương thức patch. Để biết ví dụ, hãy xem phần Cập nhật tin nhắn.

Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng. Khi sử dụng phương thức xác thực ứng dụng, các yêu cầu chỉ có thể cập nhật tin nhắn do ứng dụng gọi Chat tạo.

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.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

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

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Cập nhật một không gian. Để biết ví dụ, hãy xem phần Cập nhật không gian.

Nếu bạn đang cập nhật trường displayName và nhận được thông báo lỗi ALREADY_EXISTS, hãy thử dùng một tên hiển thị 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.

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.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

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

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Cập nhật trạng thái đã đọc của người dùng trong một không gian, dùng để xác định tin nhắn đã đọc và chưa đọc. Ví dụ: xem phần Cập nhật trạng thái đọc không gian của người dùng.

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

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/chat.users.readstate

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

AccessoryWidget

Một hoặc nhiều tiện ích tương tác xuất hiện ở cuối thư. Để biết thông tin chi tiết, hãy xem phần Thêm tiện ích tương tác ở cuối thư.

Trường
Trường kết hợp action. Loại hành động. action chỉ có thể là một trong những trạng thái sau đây:
button_list

ButtonList

Danh sách các nút.

ActionResponse

Các thông số mà ứng dụng Chat có thể dùng để định cấu hình cách đăng câu trả lời.

Trường
type

ResponseType

Chỉ nhập. Loại phản hồi của ứng dụng trong Chat.
url

string

Chỉ nhập. URL để người dùng xác thực hoặc định cấu hình. (Chỉ dành cho REQUEST_CONFIG loại phản hồi.)
dialog_action

DialogAction

Chỉ nhập. Phản hồi cho một sự kiện tương tác liên quan đến hộp thoại. Phải kèm theo ResponseType.Dialog.
updated_widget

UpdatedWidget

Chỉ nhập. Phản hồi của tiện ích đã cập nhật.

ResponseType

Loại phản hồi của ứng dụng trong Chat.

Enum
TYPE_UNSPECIFIED Loại mặc định được xử lý là NEW_MESSAGE.
NEW_MESSAGE Đăng dưới dạng tin nhắn mới trong chủ đề.
UPDATE_MESSAGE Cập nhật tin nhắn của ứng dụng Chat. Điều này chỉ được phép trên sự kiện CARD_CLICKED khi loại người gửi thư là BOT.
UPDATE_USER_MESSAGE_CARDS Cập nhật các thẻ trên tin nhắn của người dùng. Điều này chỉ được phép dùng làm phản hồi cho sự kiện MESSAGE có URL khớp hoặc sự kiện CARD_CLICKED khi loại người gửi thư là HUMAN. Bỏ qua văn bản.
REQUEST_CONFIG Yêu cầu riêng tư người dùng xác thực hoặc định cấu hình bổ sung.
DIALOG Trình bày một hộp thoại.
UPDATE_WIDGET Truy vấn các lựa chọn tự động hoàn thành văn bản trong tiện ích.

SelectionItems

Danh sách kết quả tự động hoàn thành tiện ích.

Trường
items[]

SelectionItem

Một mảng gồm các đối tượng SelectionItem.

UpdatedWidget

Phản hồi của tiện ích đã cập nhật. Dùng để cung cấp các lựa chọn tự động hoàn thành cho một tiện ích.

Trường
widget

string

Mã của tiện ích đã cập nhật. Mã này phải khớp với mã của tiện ích đã kích hoạt yêu cầu cập nhật.
Trường kết hợp updated_widget. Tiện ích này đã được cập nhật theo hành động của người dùng. updated_widget chỉ có thể là một trong những trạng thái sau đây:
suggestions

SelectionItems

Danh sách kết quả tự động hoàn thành tiện ích

ActionStatus

Biểu thị trạng thái của một yêu cầu gọi hoặc gửi hộp thoại.

Trường
status_code

Code

Mã trạng thái.
user_facing_message

string

Thông báo gửi cho người dùng về trạng thái yêu cầu của họ. Nếu bạn không đặt chính sách này, một thông báo chung dựa trên status_code sẽ được gửi.

Annotation

Chỉ có đầu ra. Các chú thích liên kết với nội dung văn bản thuần tuý của thông báo. Để thêm định dạng cơ bản cho tin nhắn văn bản, hãy xem phần Định dạng tin nhắn văn bản.

Ví dụ về nội dung thư dưới dạng văn bản thuần tuý:

Hello @FooBot how are you!"

Siêu dữ liệu chú thích tương ứng:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Trường
type

AnnotationType

Loại của chú thích này.
length

int32

Độ dài của chuỗi con trong nội dung thông báo dạng văn bản thuần tuý tương ứng với chú thích này.
start_index

int32

Chỉ mục bắt đầu (dựa trên 0, bao gồm cả 0) trong nội dung thông báo văn bản thuần tuý tương ứng với chú thích này.
Trường kết hợp metadata. Siêu dữ liệu bổ sung về chú thích. metadata chỉ có thể là một trong những trạng thái sau đây:
user_mention

UserMentionMetadata

Siêu dữ liệu về lượt đề cập người dùng.
slash_command

SlashCommandMetadata

Siêu dữ liệu cho lệnh dấu gạch chéo.

AnnotationType

Loại chú thích.

Enum
ANNOTATION_TYPE_UNSPECIFIED Giá trị mặc định của enum. Không sử dụng.
USER_MENTION Một người dùng được đề cập.
SLASH_COMMAND Lệnh dấu gạch chéo được gọi.

AttachedGif

Hình ảnh GIF do URL chỉ định.

Trường
uri

string

Chỉ có đầu ra. URL lưu trữ hình ảnh GIF.

Tệp đính kèm

Một tệp đính kèm trong Google Chat.

Trường
name

string

Tên tài nguyên của tệp đính kèm, ở dạng spaces/{space}/messages/{message}/attachments/{attachment}.
content_name

string

Chỉ có đầu ra. Tên tệp gốc cho nội dung, không phải đường dẫn đầy đủ.
content_type

string

Chỉ có đầu ra. Loại nội dung (loại MIME) của tệp.
thumbnail_uri

string

Chỉ có đầu ra. URL hình thu nhỏ nên được sử dụng để xem trước tệp đính kèm cho người dùng thực. Các ứng dụng nhắn tin không nên dùng URL này để tải nội dung tệp đính kèm xuống.
download_uri

string

Chỉ có đầu ra. URL tải xuống nên được sử dụng để cho phép người dùng thực tải xuống tệp đính kèm. Các ứng dụng nhắn tin không nên dùng URL này để tải nội dung tệp đính kèm xuống.
source

Source

Chỉ có đầu ra. Nguồn của tệp đính kèm.
Trường kết hợp data_ref. Dữ liệu tham chiếu đến tệp đính kèm. data_ref chỉ có thể là một trong những trạng thái sau đây:
attachment_data_ref

AttachmentDataRef

Tham chiếu đến dữ liệu tệp đính kèm. Trường này được dùng với API nội dung nghe nhìn để tải dữ liệu tệp đính kèm xuống.
drive_data_ref

DriveDataRef

Chỉ có đầu ra. Tham chiếu đến tệp đính kèm trên Google Drive. Trường này được dùng với API Google Drive.

Nguồn

Nguồn của tệp đính kèm.

Enum
SOURCE_UNSPECIFIED Đã đặt trước.
DRIVE_FILE Tệp này là một tệp trên Google Drive.
UPLOADED_CONTENT Tệp đã được tải lên Chat.

AttachmentDataRef

Tham chiếu đến dữ liệu tệp đính kèm.

Trường
resource_name

string

Tên tài nguyên của dữ liệu tệp đính kèm. Trường này được dùng với API nội dung nghe nhìn để tải dữ liệu tệp đính kèm xuống.
attachment_upload_token

string

Mã thông báo mờ chứa thông tin tham chiếu đến một tệp đính kèm đã tải lên. Được ứng dụng coi là một chuỗi mờ và dùng để tạo hoặc cập nhật tin nhắn trong Chat có tệp đính kèm.

CardWithId

Một thẻ trong tin nhắn trên Google Chat.

Chỉ các ứng dụng trong Chat mới có thể tạo thẻ. Nếu ứng dụng Chat của bạn xác thực với tư cách là một người dùng, thì tin nhắn không được chứa thẻ.

Thiết kế và xem trước thẻ bằng Trình tạo thẻ.

Mở Trình tạo thẻ

Trường
card_id

string

Bắt buộc nếu thư chứa nhiều thẻ. Giá trị nhận dạng duy nhất của thẻ trong thông báo.
card

Card

Thẻ. Kích thước tối đa là 32 KB.

ChatSpaceLinkData

Dữ liệu của các đường liên kết đến phòng Chat.

Trường
space

string

Không gian của tài nguyên phòng Chat được liên kết.

Định dạng spaces/{space}
thread

string

Luồng của tài nguyên phòng Chat được liên kết.

Định dạng spaces/{space}/threads/{thread}
message

string

Tin nhắn của tài nguyên trong phòng Chat được liên kết.

Định dạng spaces/{space}/messages/{message}

CompleteImportSpaceRequest

Thông báo yêu cầu hoàn tất quy trình nhập một không gian.

Trường
name

string

Bắt buộc. Tên tài nguyên của không gian chế độ nhập.

Định dạng spaces/{space}

CompleteImportSpaceResponse

Thông báo phản hồi để yêu cầu hoàn tất quy trình nhập một không gian.

Trường
space

Space

Không gian cho chế độ nhập.

ContextualAddOnMarkup

Loại này không có trường nào.

Mã đánh dấu dành cho nhà phát triển để chỉ định nội dung của Tiện ích bổ sung theo ngữ cảnh.

Thẻ

Thẻ là một thành phần trên giao diện người dùng có thể chứa các tiện ích giao diện người dùng như văn bản và hình ảnh.

Trường
header

CardHeader

Tiêu đề thẻ. Tiêu đề thường chứa tiêu đề và hình ảnh.
sections[]

Section

Các phần được phân tách bằng đường phân cách.
card_actions[]

CardAction

Thao tác của thẻ này.
name

string

Tên thẻ.

CardAction

Hành động đối với thẻ là hành động liên quan đến thẻ. Đối với thẻ hoá đơn, thao tác thông thường sẽ là: xoá hoá đơn, gửi hoá đơn qua email hoặc mở hoá đơn trong trình duyệt.

Không được các ứng dụng Google Chat hỗ trợ.

Trường
action_label

string

Nhãn từng xuất hiện trong mục trong trình đơn thao tác.
on_click

OnClick

Hành động nhấp cho mục hành động này.

CardHeader

Trường
title

string

Bạn phải chỉ định tiêu đề. Tiêu đề có chiều cao cố định: nếu cả tiêu đề và phụ đề được chỉ định thì mỗi tiêu đề sẽ chiếm một dòng. Nếu chỉ có tiêu đề được chỉ định, thì tiêu đề sẽ chiếm cả hai dòng.
subtitle

string

Phụ đề của tiêu đề thẻ.
image_style

ImageStyle

Loại hình ảnh (ví dụ: đường viền vuông hoặc đường viền tròn).
image_url

string

URL của hình ảnh trong tiêu đề thẻ.

ImageStyle

Enum
IMAGE_STYLE_UNSPECIFIED
IMAGE Đường viền hình vuông.
AVATAR Đường viền tròn.

Phần

Phần chứa một tập hợp các tiện ích được hiển thị (theo chiều dọc) theo thứ tự được chỉ định. Trên tất cả các nền tảng, thẻ có chiều rộng cố định hẹp, vì vậy hiện không cần thuộc tính bố cục (ví dụ: độ chính xác đơn).

Trường
header

string

Tiêu đề của phần. Văn bản được định dạng được hỗ trợ. Để biết thêm thông tin về việc định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.
widgets[]

WidgetMarkup

Mỗi mục phải chứa ít nhất một tiện ích.

CreateMembershipRequest

Yêu cầu tin nhắn để tạo gói thành viên.

Trường
parent

string

Bắt buộc. Tên tài nguyên của không gian để tạo thành viên.

Định dạng: dấu cách/{space}
membership

Membership

Bắt buộc. Mối quan hệ thành viên cần tạo. Trường memberType phải chứa người dùng đã điền sẵn các trường user.name và user.type. Máy chủ sẽ chỉ định tên tài nguyên và ghi đè mọi nội dung được chỉ định. Khi tạo mối quan hệ thành viên cho một người dùng thực, ứng dụng Chat phải sử dụng phạm vi chat.memberships, đặt user.type thành HUMAN và đặt user.name có định 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 của người trong API Mọi người hoặc là id của 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. Khi tạo mối quan hệ thành viên cho chính mình, một ứng dụng trong Chat phải sử dụng phạm vi chat.memberships.app, đặt user.type thành BOT và đặt user.name thành users/app.
use_admin_access

bool

Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu chat.admin.memberships phạm vi OAuth 2.0.

Quyền quản trị không hỗ trợ tính năng tạo thành viên trong ứng dụng hoặc tạo thành viên cho người dùng bên ngoài tổ chức Google Workspace của quản trị viên.

CreateMessageRequest

Tạo một thông báo.

Trường
parent

string

Bắt buộc. Tên tài nguyên của không gian nơi tạo thông báo.

Định dạng spaces/{space}
message

Message

Bắt buộc. Nội dung thư.
thread_key
(deprecated)

string

Không bắt buộc. Không dùng nữa: Chuyển sang dùng thread.thread_key. Mã nhận dạng của chuỗi. Hỗ trợ lên đến 4.000 ký tự. Để bắt đầu hoặc thêm vào một chuỗi, hãy tạo một thông điệp và chỉ định threadKey hoặc thread.name. Để biết ví dụ về cách sử dụng, hãy xem phần Bắt đầu hoặc trả lời một chuỗi tin nhắn.
request_id

string

Không bắt buộc. Mã yêu cầu duy nhất cho thông báo này. Việc chỉ định mã nhận dạng yêu cầu hiện có sẽ trả về thông báo được tạo bằng mã nhận dạng đó thay vì tạo một thông báo mới.
message_reply_option

MessageReplyOption

Không bắt buộc. Chỉ định xem một tin nhắn sẽ bắt đầu một chuỗi tin nhắn hay trả lời một chuỗi tin nhắn. Chỉ được hỗ trợ trong không gian được đặt tên.
message_id

string

Không bắt buộc. Mã tuỳ chỉnh của một thư. Cho phép các ứng dụng trong Chat nhận, cập nhật hoặc xoá tin nhắn mà không cần lưu trữ mã nhận dạng do hệ thống chỉ định trong tên tài nguyên của tin nhắn (được biểu thị trong trường name của thông báo).

Giá trị cho trường này phải đáp ứng các yêu cầu sau:

  • Bắt đầu bằng client-. Ví dụ: client-custom-name là mã tuỳ chỉnh hợp lệ, nhưng custom-name thì không.
  • Chứa tối đa 63 ký tự và chỉ chứa chữ cái viết thường, số và dấu gạch nối.
  • Là duy nhất trong một không gian. Một ứng dụng Chat không thể sử dụng cùng một mã tuỳ chỉnh cho nhiều tin nhắn.

Để biết thông tin chi tiết, hãy xem phần Đặt tên cho thông báo.

MessageReplyOption

Chỉ định cách trả lời một tin nhắn. Chúng tôi có thể sẽ thêm các tiểu bang khác trong tương lai.

Enum
MESSAGE_REPLY_OPTION_UNSPECIFIED Mặc định. Bắt đầu một chuỗi mới. Khi sử dụng tuỳ chọn này, bạn sẽ bỏ qua mọi thread ID hoặc thread_key có trong tuỳ chọn này.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Tạo tin nhắn dưới dạng tin nhắn trả lời cho chuỗi do thread ID hoặc thread_key chỉ định. Nếu không thành công, tin nhắn sẽ bắt đầu một chuỗi tin nhắn mới.
REPLY_MESSAGE_OR_FAIL Tạo tin nhắn dưới dạng tin nhắn trả lời cho chuỗi do thread ID hoặc thread_key chỉ định. Nếu bạn sử dụng thread_key mới, thì một luồng mới sẽ được tạo. Nếu không tạo được thông báo, hệ thống sẽ trả về lỗi NOT_FOUND.

CreateReactionRequest

Tạo lượt thể hiện cảm xúc với một tin nhắn.

Trường
parent

string

Bắt buộc. Thông báo nơi tạo lượt thể hiện cảm xúc.

Định dạng spaces/{space}/messages/{message}
reaction

Reaction

Bắt buộc. Phản ứng muốn tạo.

CreateSpaceRequest

Yêu cầu tạo một không gian được đặt tên.

Trường
space

Space

Bắt buộc. Bạn phải điền vào các trường displayName và spaceType. Chỉ hỗ trợ SpaceType.SPACE.

Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS, 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.

Không gian name được chỉ định trên máy chủ nên mọi nội dung được chỉ định trong trường này sẽ bị bỏ qua.
request_id

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.

CustomEmoji

Đại diện cho một biểu tượng cảm xúc tuỳ chỉnh.

Trường
uid

string

Chỉ có đầu ra. Khoá duy nhất cho tài nguyên biểu tượng cảm xúc tuỳ chỉnh.

DeleteMembershipRequest

Yêu cầu xoá thành viên trong một không gian.

Trường
name

string

Bắt buộc. Tên tài nguyên của gói thành viên cần xoá. Các ứng dụng trong Chat có thể xoá dữ liệu của người dùng hoặc gói hội viên của chính họ. Ứng dụng Chat không thể xoá các ứng dụng khác gói hội viên.

Khi xoá gói thành viên do con người thực hiện, bạn phải có phạm vi chat.memberships và định dạng spaces/{space}/members/{member}. Bạn có thể sử dụng email này làm email đại diện cho {member}. Ví dụ: spaces/{space}/members/example@gmail.com, trong đó example@gmail.com là email của người dùng Google Chat.

Khi xoá một gói thành viên của ứng dụng, bạn phải có phạm vi chat.memberships.app và định dạng spaces/{space}/members/app.

Định dạng: spaces/{space}/members/{member} hoặc spaces/{space}/members/app.
use_admin_access

bool

Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu chat.admin.memberships phạm vi OAuth 2.0.

Không thể xoá thành viên của ứng dụng trong một không gian khi sử dụng quyền quản trị.

DeleteMessageRequest

Yêu cầu xoá tin nhắn.

Trường
name

string

Bắt buộc. Tên tài nguyên của thông báo.

Định dạng spaces/{space}/messages/{message}

Nếu đã đặt mã tuỳ chỉnh cho thông báo của mình thì bạn có thể sử dụng giá trị từ trường clientAssignedMessageId cho {message}. Để biết thông tin chi tiết, hãy xem phần Đặt tên cho thông báo.
force

bool

Khi true, việc xoá một tin nhắn cũng sẽ xoá các tin nhắn trả lời theo chuỗi. Khi false, nếu một tin nhắn có tin nhắn trả lời theo chuỗi thì không xoá được.

Chỉ áp dụng khi xác thực với tư cách là người dùng. Không có hiệu lực khi xác thực dưới dạng một ứng dụng Chat.

DeleteReactionRequest

Xoá lượt thể hiện cảm xúc với một tin nhắn.

Trường
name

string

Bắt buộc. Tên của phản ứng muốn xoá.

Định dạng spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

Yêu cầu xoá không gian.

Trường
name

string

Bắt buộc. Tên tài nguyên của không gian cần xoá.

Định dạng spaces/{space}
use_admin_access

bool

Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu chat.admin.delete phạm vi OAuth 2.0.

DeletionMetadata

Thông tin về một thư đã xoá. Một tin nhắn sẽ bị xoá khi bạn đặt delete_time.

Trường
deletion_type

DeletionType

Cho biết ai đã xoá tin nhắn.

DeletionType

Ai đã xoá tin nhắn và cách tin nhắn bị xoá.

Enum
DELETION_TYPE_UNSPECIFIED Giá trị này chưa được sử dụng.
CREATOR Người dùng đã xoá tin nhắn của chính họ.
SPACE_OWNER Chủ sở hữu không gian đã xoá tin nhắn này.
ADMIN Một quản trị viên Google Workspace đã xoá tin nhắn này.
APP_MESSAGE_EXPIRY Một ứng dụng Chat đã xoá tin nhắn của chính mình khi tin nhắn đó hết hạn.
CREATOR_VIA_APP Một ứng dụng Chat đã thay mặt người dùng xoá tin nhắn.
SPACE_OWNER_VIA_APP Một ứng dụng Chat đã xoá tin nhắn này thay mặt cho chủ sở hữu không gian.

Hộp thoại

Xuống dòng bao quanh phần thân thẻ của hộp thoại.

Trường
body

Card

Chỉ nhập. Nội dung của hộp thoại, được hiển thị theo phương thức. Ứng dụng Google Chat không hỗ trợ các thực thể thẻ sau: DateTimePicker, OnChangeAction.

DialogAction

Chứa hộp thoại và yêu cầu mã trạng thái.

Trường
action_status

ActionStatus

Chỉ nhập. Trạng thái của một yêu cầu gọi hoặc gửi hộp thoại. Hiện trạng thái và thông báo cho người dùng nếu cần. Ví dụ: trong trường hợp lỗi hoặc thành công.
Trường kết hợp action. Hành động cần thực hiện. action chỉ có thể là một trong những trạng thái sau đây:
dialog

Dialog

Chỉ nhập. Hộp thoại cho yêu cầu.

DriveDataRef

Một tham chiếu đến dữ liệu của một tệp đính kèm trên Drive.

Trường
drive_file_id

string

Mã nhận dạng của tệp trên Drive. Dùng với API Drive.

DriveLinkData

Dữ liệu cho các đường liên kết đến Google Drive.

Trường
drive_data_ref

DriveDataRef

DriveDataRef tham chiếu đến một tệp trên Google Drive.
mime_type

string

Loại mime của tài nguyên Google Drive được liên kết.

Biểu tượng cảm xúc

Biểu tượng cảm xúc được dùng để thể hiện cảm xúc với một tin nhắn.

Trường
Trường kết hợp content. Nội dung của biểu tượng cảm xúc. content chỉ có thể là một trong những trạng thái sau đây:
unicode

string

Một biểu tượng cảm xúc cơ bản được biểu thị bằng một chuỗi Unicode.
custom_emoji

CustomEmoji

Chỉ có đầu ra. Một biểu tượng cảm xúc tuỳ chỉnh.

EmojiReactionSummary

Số người đã thể hiện cảm xúc với một tin nhắn bằng một biểu tượng cảm xúc cụ thể.

Trường
emoji

Emoji

Biểu tượng cảm xúc liên kết với các lượt bày tỏ cảm xúc.
reaction_count

int32

Tổng số lượt thể hiện cảm xúc bằng biểu tượng cảm xúc được liên kết.

FindDirectMessageRequest

Yêu cầu nhận không gian tin nhắn trực tiếp dựa trên tài nguyên người dùng.

Trường
name

string

Bắt buộc. Tên tài nguyên của người dùng để tìm tin nhắn trực tiếp.

Định dạng: users/{user}, trong đó {user} là id cho người trong API Mọi người hoặc id cho người dùng trong API Thư mục. Ví dụ: nếu mã hồ sơ API Mọi người là 123456789, bạn có thể tìm thấy tin nhắn trực tiếp với người đó bằng cách sử dụng users/123456789 làm name. Khi được xác thực với tư cách là người dùng, bạn có thể sử dụng email đó làm email đại diện cho {user}. Ví dụ: users/example@gmail.com, trong đó example@gmail.com là email của người dùng Google Chat.

GetAttachmentRequest

Yêu cầu tải tệp đính kèm.

Trường
name

string

Bắt buộc. Tên tài nguyên của tệp đính kèm, ở dạng spaces/{space}/messages/{message}/attachments/{attachment}.

GetMembershipRequest

Yêu cầu đăng ký làm thành viên của một không gian.

Trường
name

string

Bắt buộc. Tên tài nguyên của gói thành viên cần truy xuất.

Để nhận tư cách thành viên riêng trong ứng dụng bằng cách sử dụng xác thực người dùng, bạn có thể tuỳ ý sử dụng spaces/{space}/members/app.

Định dạng: spaces/{space}/members/{member} hoặc spaces/{space}/members/app

Khi được xác thực là người dùng, bạn có thể sử dụng email của người dùng đó làm bí danh cho {member}. Ví dụ: spaces/{space}/members/example@gmail.com, trong đó example@gmail.com là email của người dùng Google Chat.
use_admin_access

bool

Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu các phạm vi OAuth 2.0 chat.admin.memberships hoặc chat.admin.memberships.readonly.

Khi sử dụng quyền quản trị, tính năng thành viên của ứng dụng trong một không gian không được hỗ trợ.

GetMessageRequest

Yêu cầu nhận tin nhắn.

Trường
name

string

Bắt buộc. Tên tài nguyên của thông báo.

Định dạng spaces/{space}/messages/{message}

Nếu đã đặt mã tuỳ chỉnh cho thông báo của mình thì bạn có thể sử dụng giá trị từ trường clientAssignedMessageId cho {message}. Để biết thông tin chi tiết, hãy xem phần Đặt tên cho thông báo.

GetSpaceEventRequest

Yêu cầu tin nhắn để nhận sự kiện trong không gian.

Trường
name

string

Bắt buộc. Tên tài nguyên của sự kiện trong không gian.

Định dạng spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceReadStateRequest

Thông báo yêu cầu đối với API GetSpaceReadState.

Trường
name

string

Bắt buộc. Tên tài nguyên của trạng thái đọc không gian cần truy xuất.

Chỉ hỗ trợ nhận trạng thái đọc cho người dùng gọi.

Để tham chiếu đến người dùng gọi, hãy thiết lập một trong các tuỳ chọn sau:

  • Bí danh me. Ví dụ: users/me/spaces/{space}/spaceReadState.

  • Địa chỉ email Workspace của họ. Ví dụ: users/user@example.com/spaces/{space}/spaceReadState.

  • Mã nhận dạng người dùng của khách hàng. Ví dụ: users/123456789/spaces/{space}/spaceReadState.

Định dạng: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

Yêu cầu trả về một không gian.

Trường
name

string

Bắt buộc. Tên tài nguyên của không gian, ở dạng spaces/{space}.

Định dạng spaces/{space}
use_admin_access

bool

Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu các phạm vi OAuth 2.0 chat.admin.spaces hoặc chat.admin.spaces.readonly.

GetThreadReadStateRequest

Thông báo yêu cầu đối với API GetThreadReadStateRequest.

Trường
name

string

Bắt buộc. Tên tài nguyên của trạng thái đọc luồng cần truy xuất.

Chỉ hỗ trợ nhận trạng thái đọc cho người dùng gọi.

Để tham chiếu đến người dùng gọi, hãy thiết lập một trong các tuỳ chọn sau:

  • Bí danh me. Ví dụ: users/me/spaces/{space}/threads/{thread}/threadReadState.

  • Địa chỉ email Workspace của họ. Ví dụ: users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

  • Mã nhận dạng người dùng của khách hàng. Ví dụ: users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Định dạng: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Nhóm

Một nhóm trên Google Groups trong Google Chat.

Trường
name

string

Tên tài nguyên của một nhóm trên Google Groups.

Đại diện cho một nhóm trong Cloud Identity Groups API.

Định dạng: nhóm/{group}

HistoryState

Trạng thái nhật ký của tin nhắn và không gian. Chỉ định khoảng thời gian lưu giữ các tin nhắn và chuỗi trò chuyện sau khi tạo.

Enum
HISTORY_STATE_UNSPECIFIED Giá trị mặc định. Không được dùng.
HISTORY_OFF Đã tắt nhật ký. Tin nhắn và chuỗi tin nhắn được lưu giữ trong 24 giờ.
HISTORY_ON Đã bật nhật ký. Quy tắc lưu giữ của Vault của tổ chức chỉ định khoảng thời gian lưu giữ thư và chuỗi.

ListMembershipsRequest

Yêu cầu tin nhắn để đăng ký thành viên của trang thông tin.

Trường
parent

string

Bắt buộc. Tên tài nguyên của không gian cần tìm nạp danh sách thành viên.

Định dạng: dấu cách/{space}
page_size

int32

Không bắt buộc. Số lượng gói hội viên tối đa cần trả lại. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu bạn không xác định, hệ thống sẽ trả lại tối đa 100 gói hội viên.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000.

Giá trị âm trả về lỗi INVALID_ARGUMENT.
page_token

string

Không bắt buộc. Mã thông báo trang, nhận được từ một cuộc gọi trước đó để liệt kê thành viên. Cung cấp tham số này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các thông số khác được cung cấp phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn.
filter

string

Không bắt buộc. Bộ lọc truy vấn.

Bạn có thể lọc tư cách thành viên theo vai trò (role) và loại của thành viên (member.type).

Để lọc theo vai trò, hãy đặt role thành ROLE_MEMBER hoặc ROLE_MANAGER.

Để lọc theo loại, hãy đặt member.type thành HUMAN hoặc BOT. Bản dùng thử cho nhà phát triển: Bạn cũng có thể lọc member.type bằng toán tử !=.

Để lọc theo cả vai trò và loại, hãy sử dụng toán tử AND. Để lọc theo vai trò hoặc loại, hãy sử dụng toán tử OR.

Bạn phải nhập member.type = "HUMAN" hoặc member.type != "BOT" khi đặt use_admin_access thành true. Các bộ lọc loại thành viên khác sẽ bị từ chối.

Ví dụ: các truy vấn sau đây là hợp lệ:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Các truy vấn sau không hợp lệ:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Máy chủ có lỗi INVALID_ARGUMENT từ chối các truy vấn không hợp lệ.
show_groups

bool

Không bắt buộc. Khi true, cũng trả về các gói hội viên liên kết với một Google Group, ngoài các loại gói hội viên khác. Nếu bạn đặt filter, thì hệ thống sẽ không trả về những gói thành viên của Google Group không khớp với tiêu chí lọc.
show_invited

bool

Không bắt buộc. Khi true, cũng trả về các gói hội viên liên kết với các thành viên invited, ngoài các loại gói hội viên khác. Nếu bạn đặt bộ lọc, thì những gói thành viên invited không khớp với tiêu chí bộ lọc sẽ không được trả về.

Hiện yêu cầu xác thực người dùng.
use_admin_access

bool

Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu phạm vi OAuth 2.0 chat.admin.memberships.readonly hoặc chat.admin.memberships.

Không hỗ trợ việc liệt kê tư cách thành viên của ứng dụng trong một không gian khi sử dụng quyền quản trị.

ListMembershipsResponse

Phản hồi danh sách thành viên của không gian.

Trường
memberships[]

Membership

Danh sách không theo thứ tự. Danh sách thành viên trên trang yêu cầu (hoặc trang đầu tiên).
next_page_token

string

Mã thông báo mà bạn có thể gửi dưới dạng pageToken để truy xuất trang kết quả tiếp theo. Nếu trống thì không có trang tiếp theo nào.

ListMessagesRequest

Liệt kê tin nhắn trong không gian chỉ định mà người dùng là thành viên.

Trường
parent

string

Bắt buộc. Tên tài nguyên của không gian để liệt kê tin nhắn.

Định dạng spaces/{space}
page_size

int32

Số lượng tin nhắn tối đa được trả về. Dịch vụ có thể trả về ít tin nhắn hơn giá trị này.

Nếu không chỉ định, hàm trả về tối đa 25 trường.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000.

Giá trị âm trả về lỗi INVALID_ARGUMENT.
page_token

string

Không bắt buộc, nếu tiếp tục từ một truy vấn trước đó.

Đã nhận được mã thông báo trang từ một lệnh gọi tin nhắn danh sách trước đó. Cung cấp tham số này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các thông số khác được cung cấp phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn.
filter

string

Bộ lọc truy vấn.

Bạn có thể lọc thư theo ngày (create_time) và chuỗi (thread.name).

Để lọc thư theo ngày tạo, hãy chỉ định create_time kèm theo dấu thời gian ở định dạng RFC-3339 và dùng dấu ngoặc kép. Ví dụ: "2023-04-21T11:30:00-04:00". Bạn có thể sử dụng toán tử lớn hơn > để liệt kê các thông báo được tạo sau một dấu thời gian, hoặc sử dụng toán tử nhỏ hơn < để liệt kê các thông báo được tạo trước một dấu thời gian. Để lọc thông báo trong một khoảng thời gian, hãy sử dụng toán tử AND giữa hai dấu thời gian.

Để lọc theo chuỗi, hãy chỉ định thread.name, có định dạng là spaces/{space}/threads/{thread}. Bạn chỉ có thể chỉ định một thread.name cho mỗi truy vấn.

Để lọc theo cả chuỗi và ngày, hãy sử dụng toán tử AND trong truy vấn của bạn.

Ví dụ: các truy vấn sau đây là hợp lệ:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Máy chủ có lỗi INVALID_ARGUMENT từ chối các truy vấn không hợp lệ.
order_by

string

Không bắt buộc, nếu tiếp tục từ một truy vấn trước đó.

Cách sắp xếp danh sách tin nhắn. Chỉ định giá trị cho đơn đặt hàng bằng một thao tác đặt hàng. Sau đây là các giá trị toán tử có thứ tự hợp lệ:

  • ASC để tăng dần.

  • DESC để giảm dần.

Thứ tự mặc định là create_time ASC.
show_deleted

bool

Liệu có bao gồm thư đã xoá hay không. Tin nhắn bị xoá bao gồm cả thời gian đã xoá và siêu dữ liệu về việc xoá tin nhắn, nhưng không có nội dung tin nhắn.

ListMessagesResponse

Tin nhắn phản hồi cho tin nhắn danh sách.

Trường
messages[]

Message

Danh sách tin nhắn.
next_page_token

string

Bạn có thể gửi mã thông báo dưới dạng pageToken để truy xuất trang kết quả tiếp theo. Nếu trống thì không có trang tiếp theo nào.

ListReactionsRequest

Liệt kê các lượt bày tỏ cảm xúc với một tin nhắn.

Trường
parent

string

Bắt buộc. Tin nhắn mà người dùng đã thể hiện cảm xúc.

Định dạng spaces/{space}/messages/{message}
page_size

int32

Không bắt buộc. Số lượt thể hiện cảm xúc tối đa được trả về. Dịch vụ có thể trả về ít phản ứng hơn giá trị này. Nếu bạn không chỉ định, giá trị mặc định sẽ là 25. Giá trị tối đa là 200; các giá trị trên 200 sẽ được thay đổi thành 200.
page_token

string

Không bắt buộc. (Nếu tiếp tục từ một truy vấn trước đó.)

Mã thông báo trang nhận được từ một lệnh gọi thể hiện cảm xúc danh sách trước đó. Cung cấp mã này để truy xuất trang tiếp theo.

Khi phân trang, giá trị bộ lọc phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển một giá trị khác có thể dẫn đến kết quả không mong muốn.
filter

string

Không bắt buộc. Bộ lọc truy vấn.

Bạn có thể lọc lượt bày tỏ cảm xúc theo biểu tượng cảm xúc (emoji.unicode hoặc emoji.custom_emoji.uid) và người dùng (user.name).

Để lọc lượt thể hiện cảm xúc cho nhiều biểu tượng cảm xúc hoặc người dùng, hãy kết hợp các trường tương tự bằng toán tử OR, chẳng hạn như emoji.unicode = "🙂" OR emoji.unicode = "👍" và user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Để lọc lượt thể hiện cảm xúc theo biểu tượng cảm xúc và người dùng, hãy sử dụng toán tử AND, chẳng hạn như emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Nếu truy vấn của bạn sử dụng cả AND và OR, hãy nhóm chúng bằng dấu ngoặc đơn.

Ví dụ: các truy vấn sau đây là hợp lệ:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

Các truy vấn sau không hợp lệ:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

Máy chủ có lỗi INVALID_ARGUMENT từ chối các truy vấn không hợp lệ.

ListReactionsResponse

Phản hồi lời mời bày tỏ cảm xúc dành cho danh sách.

Trường
reactions[]

Reaction

Danh sách lượt thể hiện cảm xúc trên trang được yêu cầu (hoặc trang đầu tiên).
next_page_token

string

Mã thông báo tiếp tục để truy xuất trang kết quả tiếp theo. Trang kết quả cuối cùng vẫn trống.

ListSpaceEventsRequest

Yêu cầu gửi tin nhắn cho các sự kiện trong không gian liệt kê.

Trường
parent

string

Bắt buộc. Tên tài nguyên của phòng Google Chat nơi diễn ra sự kiện.

Định dạng: spaces/{space}.
page_size

int32

Không bắt buộc. Số lượng tối đa các sự kiện trong không gian được trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Giá trị âm trả về lỗi INVALID_ARGUMENT.
page_token

string

Mã thông báo trang, nhận được từ lệnh gọi sự kiện không gian danh sách trước đó. Cung cấp mã này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các thông số khác được cung cấp để liệt kê sự kiện của không gian phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn.
filter

string

Bắt buộc. Bộ lọc truy vấn.

Bạn phải chỉ định ít nhất một loại sự kiện (event_type) bằng toán tử có :. Để lọc theo nhiều loại sự kiện, hãy sử dụng toán tử OR. Hãy bỏ qua các loại sự kiện theo lô trong bộ lọc của bạn. Yêu cầu này tự động trả về mọi sự kiện theo lô có liên quan. Ví dụ: nếu bạn lọc theo biểu tượng cảm xúc mới (google.workspace.chat.reaction.v1.created), thì máy chủ cũng trả về hàng loạt sự kiện phản ứng mới (google.workspace.chat.reaction.v1.batchCreated). Để biết danh sách các loại sự kiện được hỗ trợ, hãy xem tài liệu tham khảo về SpaceEvents.

Nếu muốn, bạn cũng có thể lọc theo thời gian bắt đầu (start_time) và thời gian kết thúc (end_time):

  • start_time: Dấu thời gian dành riêng dùng để bắt đầu liệt kê các sự kiện trong không gian. Bạn có thể liệt kê những sự kiện đã xảy ra cách đây tối đa 28 ngày. Nếu bạn chưa chỉ định, hãy liệt kê các sự kiện trong không gian trong 28 ngày qua.
  • end_time: Dấu thời gian bao gồm cho đến khi các sự kiện trong không gian được liệt kê. Nếu bạn chưa chỉ định, tính năng này sẽ liệt kê các sự kiện cho đến thời điểm yêu cầu.

Để chỉ định thời gian bắt đầu hoặc kết thúc, hãy sử dụng toán tử bằng = và định dạng trong RFC-3339. Để lọc theo cả start_time và end_time, hãy sử dụng toán tử AND.

Ví dụ: các truy vấn sau đây là hợp lệ:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

Các truy vấn sau không hợp lệ:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

Máy chủ có lỗi INVALID_ARGUMENT từ chối các truy vấn không hợp lệ.

ListSpaceEventsResponse

Tin nhắn phản hồi cho các sự kiện trong không gian liệt kê.

Trường
space_events[]

SpaceEvent

Kết quả được trả về theo thứ tự thời gian (sự kiện cũ nhất được xếp trước).
next_page_token

string

Mã thông báo tiếp tục được dùng để tìm nạp thêm sự kiện. Nếu trường này bị bỏ qua thì sẽ không có trang tiếp theo.

ListSpacesRequest

Yêu cầu liệt kê những không gian mà phương thức gọi là thành viên.

Trường
page_size

int32

Không bắt buộc. Số lượng dấu cách tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu bạn không chỉ định thì hệ thống sẽ trả về tối đa 100 dấu cách.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000.

Giá trị âm trả về lỗi INVALID_ARGUMENT.
page_token

string

Không bắt buộc. Mã thông báo trang, nhận được từ một lệnh gọi không gian danh sách trước đó. Cung cấp tham số này để truy xuất trang tiếp theo.

Khi phân trang, giá trị bộ lọc phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển một giá trị khác có thể dẫn đến kết quả không mong muốn.
filter

string

Không bắt buộc. Bộ lọc truy vấn.

Bạn có thể lọc không gian theo loại không gian (space_type).

Để lọc theo loại không gian, bạn phải chỉ định giá trị enum hợp lệ, chẳng hạn như SPACE hoặc GROUP_CHAT (space_type không được là SPACE_TYPE_UNSPECIFIED). Để truy vấn nhiều loại không gian, hãy sử dụng toán tử OR.

Ví dụ: các truy vấn sau đây là hợp lệ:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Máy chủ có lỗi INVALID_ARGUMENT từ chối các truy vấn không hợp lệ.

ListSpacesResponse

Phản hồi cho yêu cầu về không gian danh sách.

Trường
spaces[]

Space

Danh sách các không gian trong trang được yêu cầu (hoặc trang đầu tiên).
next_page_token

string

Bạn có thể gửi mã thông báo dưới dạng pageToken để truy xuất trang kết quả tiếp theo. Nếu trống thì không có trang tiếp theo nào.

MatchedUrl

URL trùng khớp trong một tin nhắn trên Chat. Các ứng dụng nhắn tin có thể xem trước URL đã khớp. Để biết thêm thông tin, hãy xem bài viết Xem trước đường liên kết.

Trường
url

string

Chỉ có đầu ra. URL được so khớp.

Gói thành viên

Thể hiện mối quan hệ thành viên trong Google Chat, chẳng hạn như người dùng hoặc ứng dụng Chat được mời tham gia, là một phần hay vắng mặt trong không gian.

Trường
name

string

Tên tài nguyên của gói thành viên, do máy chủ chỉ định.

Định dạng spaces/{space}/members/{member}
state

MembershipState

Chỉ có đầu ra. Trạng thái của gói thành viên.
role

MembershipRole

Không bắt buộc. Vai trò của người dùng trong phòng Chat. Vai trò này xác định những hành động được phép họ thực hiện trong không gian đó.

Bạn chỉ có thể dùng trường này làm dữ liệu đầu vào trong UpdateMembership.
create_time

Timestamp

Không bắt buộc. Bất biến. Thời gian tạo thành viên, chẳng hạn như thời điểm thành viên tham gia hoặc được mời tham gia không gian. Trường này chỉ được cung cấp cho kết quả đầu ra, trừ phi trường này được dùng để nhập tư cách thành viên trước đây vào không gian ở chế độ nhập.
delete_time

Timestamp

Không bắt buộc. Bất biến. Thời gian xoá thành viên, chẳng hạn như khi một thành viên rời khỏi hoặc bị xoá khỏi không gian. Trường này chỉ được cung cấp cho kết quả đầu ra, trừ phi trường này được dùng để nhập tư cách thành viên trước đây vào không gian ở chế độ nhập.
Trường kết hợp memberType. Thành viên liên kết với gói thành viên này. Các loại thành viên khác có thể sẽ được hỗ trợ trong tương lai. memberType chỉ có thể là một trong những trạng thái sau đây:
member

User

Người dùng hoặc ứng dụng Google Chat tương ứng với gói thành viên. Nếu ứng dụng Chat xác thực với tư cách là một người dùng, thì dữ liệu đầu ra sẽ được điền cho người dùng name và type.
group_member

Group

Nhóm Google tương ứng với tư cách thành viên.

MembershipRole

Biểu thị các hành động được phép của người dùng trong phòng Chat. Trong tương lai, có thể sẽ thêm các giá trị enum khác.

Enum
MEMBERSHIP_ROLE_UNSPECIFIED Giá trị mặc định. Đối với users: họ không phải là thành viên của không gian nhưng có thể được mời. Đối với Google Groups: họ luôn được chỉ định vai trò này (các giá trị enum khác có thể được sử dụng trong tương lai).
ROLE_MEMBER Một thành viên của không gian. Người dùng có các quyền cơ bản, chẳng hạn như gửi tin nhắn đến không gian. Trong các cuộc trò chuyện nhóm 1:1 và chưa đặt tên, mọi người đều có vai trò này.
ROLE_MANAGER Người quản lý không gian. Người dùng có tất cả các quyền cơ bản cùng với những quyền quản trị cho phép họ quản lý không gian, chẳng hạn như thêm hoặc xoá thành viên. Chỉ được hỗ trợ trong SpaceType.SPACE.

MembershipState

Chỉ định mối quan hệ của thành viên với một không gian. Các trạng thái thành viên khác có thể được hỗ trợ trong tương lai.

Enum
MEMBERSHIP_STATE_UNSPECIFIED Giá trị mặc định. Không sử dụng.
JOINED Người dùng được thêm vào không gian và có thể tham gia vào không gian.
INVITED Người dùng được mời tham gia không gian nhưng chưa tham gia.
NOT_A_MEMBER Người dùng không thuộc không gian và không có lời mời đang chờ xử lý để tham gia không gian.

MembershipBatchCreatedEventData

Tải trọng sự kiện cho nhiều gói thành viên mới.

Loại sự kiện: google.workspace.chat.membership.v1.batchCreated

Trường
memberships[]

MembershipCreatedEventData

Danh sách gói hội viên mới.

MembershipBatchDeletedEventData

Tải trọng sự kiện cho nhiều gói thành viên đã xoá.

Loại sự kiện: google.workspace.chat.membership.v1.batchDeleted

Trường
memberships[]

MembershipDeletedEventData

Danh sách những gói hội viên đã xoá.

MembershipBatchUpdatedEventData

Tải trọng sự kiện cho nhiều gói thành viên đã cập nhật.

Loại sự kiện: google.workspace.chat.membership.v1.batchUpdated

Trường
memberships[]

MembershipUpdatedEventData

Danh sách những gói hội viên mới cập nhật.

MembershipCreatedEventData

Tải trọng sự kiện cho một gói thành viên mới.

Loại sự kiện: google.workspace.chat.membership.v1.created.

Trường
membership

Membership

Gói thành viên mới.

MembershipDeletedEventData

Tải trọng sự kiện cho một gói thành viên đã xoá.

Loại sự kiện: google.workspace.chat.membership.v1.deleted

Trường
membership

Membership

Gói thành viên đã xoá. Chỉ có các trường name và state được điền sẵn.

MembershipUpdatedEventData

Tải trọng sự kiện cho một gói thành viên đã cập nhật.

Loại sự kiện: google.workspace.chat.membership.v1.updated

Trường
membership

Membership

Gói thành viên mới cập nhật.

Thông điệp

Một tin nhắn trong phòng Google Chat.

Trường
name

string

Tên tài nguyên của thông báo.

Định dạng spaces/{space}/messages/{message}

Trong đó {space} là mã nhận dạng của không gian nơi thông báo được đăng và {message} là mã nhận dạng do hệ thống chỉ định cho thông báo đó. Ví dụ: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Nếu đặt mã tuỳ chỉnh khi tạo thông báo, bạn có thể sử dụng mã này để chỉ định thông báo trong yêu cầu bằng cách thay thế {message} bằng giá trị trong trường clientAssignedMessageId. Ví dụ: spaces/AAAAAAAAAAA/messages/client-custom-name. Để biết thông tin chi tiết, hãy xem phần Đặt tên cho thông báo.
sender

User

Chỉ có đầu ra. Người dùng đã tạo thông báo. Nếu ứng dụng Chat xác thực với tư cách là một người dùng, thì dữ liệu đầu ra sẽ được điền cho người dùng name và type.
create_time

Timestamp

Không bắt buộc. Bất biến. Đối với những không gian được tạo trong Chat, đó là thời điểm tin nhắn được tạo. Trường này chỉ dành cho kết quả đầu ra, trừ phi được dùng trong không gian ở chế độ nhập.

Đối với không gian ở chế độ nhập, hãy đặt trường này thành dấu thời gian trước đây khi thông báo được tạo trong nguồn để duy trì thời gian tạo ban đầu.
last_update_time

Timestamp

Chỉ có đầu ra. Thời điểm người dùng chỉnh sửa thư gần đây nhất. Nếu thư chưa từng được chỉnh sửa, thì trường này trống.
delete_time

Timestamp

Chỉ có đầu ra. Thời điểm tin nhắn bị xoá trong Google Chat. Nếu thư không bao giờ bị xoá, thì trường này trống.
text

string

Nội dung thư bằng văn bản thuần tuý. Đường liên kết đầu tiên đến một hình ảnh, video hoặc trang web sẽ tạo ra một khối xem trước. Bạn cũng có thể đề cập đến một người dùng Google Chat bằng@ hoặc mọi người trong không gian.

Để tìm hiểu về cách tạo tin nhắn văn bản, hãy xem bài viết Gửi tin nhắn văn bản.
formatted_text

string

Chỉ có đầu ra. Chứa thông báo text cùng với mã đánh dấu được thêm vào để thể hiện định dạng. Trường này có thể không bao gồm tất cả định dạng hiển thị trong giao diện người dùng, nhưng bao gồm các định dạng sau:

  • Cú pháp đánh dấu để in đậm, in nghiêng, gạch ngang, đơn cách, khối đơn cách và danh sách có dấu đầu dòng.

  • Người dùng đề cập đến bằng định dạng <users/{user}>.

  • Siêu liên kết tuỳ chỉnh sử dụng định dạng <{url}|{rendered_text}>, trong đó chuỗi đầu tiên là URL và chuỗi thứ hai là văn bản được kết xuất, ví dụ: <http://example.com|custom text>.

  • Biểu tượng cảm xúc tuỳ chỉnh ở định dạng :{emoji_name}: (ví dụ: :smile:). Điều này không áp dụng cho biểu tượng cảm xúc Unicode, chẳng hạn như U+1F600 cho biểu tượng cảm xúc mặt cười toe toét.

Để biết thêm thông tin, hãy xem phần Xem định dạng văn bản được gửi trong thư
cards[]
(deprecated)

Card

Không dùng nữa: Chuyển sang dùng cards_v2.

Các thẻ có nội dung phong phú, có định dạng và có tính tương tác mà bạn có thể dùng để hiển thị các thành phần trên giao diện người dùng như: văn bản được định dạng, nút và hình ảnh có thể nhấp vào. Thẻ thường xuất hiện bên dưới nội dung văn bản thuần tuý của thư. cards và cards_v2 có thể có kích thước tối đa là 32 KB.
cards_v2[]

CardWithId

Một mảng thẻ.

Chỉ các ứng dụng trong Chat mới có thể tạo thẻ. Nếu ứng dụng Chat của bạn xác thực với tư cách là người dùng, thì tin nhắn không được chứa thẻ.

Để tìm hiểu về thẻ và cách tạo thẻ, hãy xem bài viết Gửi tin nhắn thẻ.

Thiết kế và xem trước thẻ bằng Trình tạo thẻ.

Mở Trình tạo thẻ
annotations[]

Annotation

Chỉ có đầu ra. Chú thích liên kết với text trong thông báo này.
thread

Thread

Chuỗi thư chứa thư. Để biết ví dụ về cách sử dụng, hãy xem phần Bắt đầu hoặc trả lời một chuỗi tin nhắn.
space

Space

Nếu ứng dụng Chat xác thực với tư cách người dùng, thì dữ liệu đầu ra sẽ được điền vào không gian name.
fallback_text

string

Nội dung mô tả dưới dạng văn bản thuần tuý về các thẻ của thông báo, được sử dụng khi không thể hiển thị thẻ thực tế (ví dụ: thông báo trên thiết bị di động).
action_response

ActionResponse

Chỉ nhập. Các thông số mà ứng dụng Chat có thể dùng để định cấu hình cách đăng câu trả lời.
argument_text

string

Chỉ có đầu ra. Nội dung tin nhắn ở dạng văn bản thuần tuý, trong đó tất cả nội dung đề cập trong ứng dụng Chat đều bị loại bỏ.
slash_command

SlashCommand

Chỉ có đầu ra. Thông tin về lệnh dấu gạch chéo, nếu có.
attachment[]

Attachment

Tệp đính kèm do người dùng tải lên.
matched_url

MatchedUrl

Chỉ có đầu ra. URL trong spaces.messages.text khớp với một mẫu xem trước đường liên kết. Để biết thêm thông tin, hãy xem bài viết Xem trước đường liên kết.
thread_reply

bool

Chỉ có đầu ra. Khi true, tin nhắn sẽ là phản hồi trong chuỗi trả lời. Khi false, tin nhắn sẽ xuất hiện trong cuộc trò chuyện cấp cao nhất của không gian dưới dạng tin nhắn đầu tiên trong chuỗi hoặc tin nhắn không có tin nhắn trả lời theo chuỗi.

Nếu không gian không hỗ trợ trả lời trong chuỗi tin nhắn, thì trường này luôn là false.
client_assigned_message_id

string

Không bắt buộc. Mã tuỳ chỉnh của thư. Bạn có thể sử dụng trường để xác định tin nhắn, hoặc để nhận, xoá hay cập nhật tin nhắn. Để đặt mã tuỳ chỉnh, hãy chỉ định trường messageId khi bạn tạo thông báo. Để biết thông tin chi tiết, hãy xem phần Đặt tên cho thông báo.
emoji_reaction_summaries[]

EmojiReactionSummary

Chỉ có đầu ra. Danh sách tóm tắt về biểu tượng cảm xúc trong tin nhắn.
private_message_viewer

User

Bất biến. Dữ liệu đầu vào để tạo thông báo, nếu không thì chỉ có dữ liệu đầu ra. Người dùng có thể xem thông báo. Khi bạn đặt chính sách này, tin nhắn sẽ ở chế độ riêng tư và chỉ hiển thị với người dùng được chỉ định cũng như ứng dụng Chat. Không hỗ trợ bản xem trước đường liên kết và tệp đính kèm đối với tin nhắn riêng tư.

Chỉ các ứng dụng trong Chat mới có thể gửi tin nhắn riêng tư. Nếu ứng dụng Chat xác thực tư cách người dùng để gửi tin nhắn, thì tin nhắn không thể ở chế độ riêng tư và phải bỏ qua trường này.

Để biết thông tin chi tiết, hãy xem bài viết Gửi tin nhắn riêng tư cho người dùng Google Chat.
deletion_metadata

DeletionMetadata

Chỉ có đầu ra. Thông tin về một thư đã xoá. Một tin nhắn sẽ bị xoá khi bạn đặt delete_time.
quoted_message_metadata

QuotedMessageMetadata

Chỉ có đầu ra. Thông tin về một tin nhắn do một người dùng Google Chat trích dẫn trong một không gian. Người dùng Google Chat có thể trích dẫn một tin nhắn để trả lời.
attached_gifs[]

AttachedGif

Chỉ có đầu ra. Hình ảnh GIF được đính kèm vào thư.
accessory_widgets[]

AccessoryWidget

Một hoặc nhiều tiện ích tương tác xuất hiện ở cuối thư. Bạn có thể thêm tiện ích phụ kiện vào những tin nhắn chứa văn bản, thẻ hoặc cả văn bản và thẻ. Không hỗ trợ cho các tin nhắn chứa hộp thoại. Để biết thông tin chi tiết, hãy xem phần Thêm tiện ích tương tác ở cuối thư.

Để tạo tin nhắn bằng các tiện ích phụ kiện, bạn cần xác thực ứng dụng.

MessageBatchCreatedEventData

Tải trọng sự kiện cho nhiều tin nhắn mới.

Loại sự kiện: google.workspace.chat.message.v1.batchCreated

Trường
messages[]

MessageCreatedEventData

Danh sách tin nhắn mới.

MessageBatchDeletedEventData

Tải trọng sự kiện cho nhiều thư đã xoá.

Loại sự kiện: google.workspace.chat.message.v1.batchDeleted

Trường
messages[]

MessageDeletedEventData

Danh sách các thư đã xoá.

MessageBatchUpdatedEventData

Tải trọng sự kiện cho nhiều thông báo được cập nhật.

Loại sự kiện: google.workspace.chat.message.v1.batchUpdated

Trường
messages[]

MessageUpdatedEventData

Danh sách tin nhắn đã cập nhật.

MessageCreatedEventData

Tải trọng sự kiện cho một tin nhắn mới.

Loại sự kiện: google.workspace.chat.message.v1.created

Trường
message

Message

Tin nhắn mới.

MessageDeletedEventData

Tải trọng sự kiện cho một thư đã xoá.

Loại sự kiện: google.workspace.chat.message.v1.deleted

Trường
message

Message

Tin nhắn đã xoá. Chỉ có các trường name, createTime, deleteTime và deletionMetadata được điền sẵn.

MessageUpdatedEventData

Tải trọng sự kiện cho một thông báo đã cập nhật.

Loại sự kiện: google.workspace.chat.message.v1.updated

Trường
message

Message

Tin nhắn đã cập nhật.

QuotedMessageMetadata

Thông tin về tin nhắn được trích dẫn.

Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của tin nhắn được trích dẫn.

Định dạng spaces/{space}/messages/{message}
last_update_time

Timestamp

Chỉ có đầu ra. Dấu thời gian khi tin nhắn được trích dẫn được tạo hoặc thời điểm tin nhắn được trích dẫn được cập nhật lần gần đây nhất.

Video phản ứng

Thể hiện cảm xúc với một tin nhắn.

Trường
name

string

Tên tài nguyên của phản ứng.

Định dạng spaces/{space}/messages/{message}/reactions/{reaction}
user

User

Chỉ có đầu ra. Người dùng đã tạo lượt thể hiện cảm xúc.
emoji

Emoji

Biểu tượng cảm xúc được dùng trong lượt thể hiện cảm xúc.

ReactionBatchCreatedEventData

Tải trọng sự kiện cho nhiều lượt thể hiện cảm xúc mới.

Loại sự kiện: google.workspace.chat.reaction.v1.batchCreated

Trường
reactions[]

ReactionCreatedEventData

Danh sách các lượt bày tỏ cảm xúc mới.

ReactionBatchDeletedEventData

Tải trọng sự kiện cho nhiều phản ứng đã xoá.

Loại sự kiện: google.workspace.chat.reaction.v1.batchDeleted

Trường
reactions[]

ReactionDeletedEventData

Danh sách các biểu tượng cảm xúc đã bị xoá.

ReactionCreatedEventData

Tải trọng sự kiện cho một phản ứng mới.

Loại sự kiện: google.workspace.chat.reaction.v1.created

Trường
reaction

Reaction

Lượt thể hiện cảm xúc mới.

ReactionDeletedEventData

Tải trọng sự kiện cho một phản ứng đã xoá.

Loại: google.workspace.chat.reaction.v1.deleted

Trường
reaction

Reaction

Biểu tượng cảm xúc đã xoá.

RichLinkMetadata

Đường liên kết đa dạng thức đến một tài nguyên.

Trường
uri

string

URI của đường liên kết này.
Trường kết hợp data. Dữ liệu cho tài nguyên được liên kết. data chỉ có thể là một trong những trạng thái sau đây:

RichLinkType

Loại đường liên kết đa dạng thức. Trong tương lai, chúng tôi có thể sẽ thêm các loại khác.

Enum
DRIVE_FILE Loại đường liên kết đa dạng thức trên Google Drive.
CHAT_SPACE Loại đường liên kết đa dạng thức của phòng Chat. Ví dụ: khối thông minh là không gian.

SearchSpacesRequest

Yêu cầu tìm kiếm danh sách không gian dựa trên cụm từ tìm kiếm.

Trường
use_admin_access

bool

Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu phạm vi OAuth 2.0 chat.admin.spaces.readonly hoặc chat.admin.spaces.

Phương thức này hiện chỉ hỗ trợ quyền quản trị, do đó, chỉ có true được chấp nhận cho trường này.
page_size

int32

Số lượng dấu cách tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu bạn không chỉ định thì hệ thống sẽ trả về tối đa 100 dấu cách.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000.
page_token

string

Mã thông báo, nhận được từ lệnh gọi không gian tìm kiếm trước đó. Cung cấp tham số này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các thông số khác được cung cấp phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn.
query

string

Bắt buộc. Cụm từ tìm kiếm.

Bạn có thể tìm kiếm bằng cách sử dụng các tham số sau:

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time và last_active_time chấp nhận dấu thời gian ở định dạng RFC-3339 và các toán tử so sánh được hỗ trợ là: =, <, >, <=, >=.

customer là bắt buộc và dùng để cho biết khách hàng nào cần tìm nạp không gian. customers/my_customer là giá trị duy nhất được hỗ trợ.

display_name chỉ chấp nhận toán tử HAS (:). Trước tiên, văn bản cần so khớp được mã hoá thành mã thông báo. Mỗi mã thông báo được so khớp với tiền tố, không phân biệt chữ hoa chữ thường và độc lập dưới dạng một chuỗi con ở bất kỳ đâu trong display_name của không gian. Ví dụ: Fun Eve khớp với Fun event hoặc The evening was fun, nhưng không khớp với notFun event hoặc even.

external_user_allowed chấp nhận true hoặc false.

space_history_state chỉ chấp nhận các giá trị từ trường historyState của tài nguyên space.

space_type là bắt buộc và giá trị hợp lệ duy nhất là SPACE.

Trong các trường khác nhau, chỉ có toán tử AND được hỗ trợ. Ví dụ hợp lệ là space_type = "SPACE" AND display_name:"Hello" và space_type = "SPACE" OR display_name:"Hello" không hợp lệ.

Trong cùng một trường, space_type không hỗ trợ toán tử AND hoặc OR. display_name, "space_history_state" và "external_user_disallow" chỉ hỗ trợ toán tử OR. last_active_time và create_time hỗ trợ cả toán tử AND và OR. Bạn chỉ có thể sử dụng AND để biểu thị một khoảng thời gian, chẳng hạn như last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Các truy vấn mẫu sau đây là hợp lệ:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

Không bắt buộc. Cách sắp xếp danh sách không gian.

Sau đây là các thuộc tính được hỗ trợ để sắp xếp theo:

  • membership_count.joined_direct_human_user_count – Cho biết số người dùng đã trực tiếp tham gia không gian.
  • last_active_time — Cho biết thời điểm mục đủ điều kiện gần nhất được thêm vào bất kỳ chủ đề nào của không gian này.
  • create_time — Cho biết thời gian tạo không gian.

Các giá trị của toán tử theo thứ tự hợp lệ là:

  • ASC để tăng dần. Giá trị mặc định.

  • DESC để giảm dần.

Cú pháp được hỗ trợ là:

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

Phản hồi có danh sách dấu cách tương ứng với yêu cầu tìm kiếm không gian.

Trường
spaces[]

Space

Một trang chứa các không gian được yêu cầu.
next_page_token

string

Mã thông báo có thể được dùng để truy xuất trang tiếp theo. Nếu trường này trống thì sẽ không có trang tiếp theo.
total_size

int32

Tổng số không gian phù hợp với cụm từ tìm kiếm trên tất cả các trang. Nếu kết quả có hơn 10.000 không gian, thì giá trị này chỉ là ước tính.

SetUpSpaceRequest

Yêu cầu tạo một không gian và thêm những người dùng được chỉ định vào không gian đó.

Trường
space

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.
request_id

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[]

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ì họ đượ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 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 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, 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).

SlashCommand

Lệnh gạch chéo trong Google Chat.

Trường
command_id

int64

Mã của lệnh dấu gạch chéo đã được gọi ra.

SlashCommandMetadata

Siêu dữ liệu chú thích cho lệnh dấu gạch chéo (/).

Trường
bot

User

Ứng dụng Chat có lệnh đã được gọi.
type

Type

Loại lệnh dấu gạch chéo.
command_name

string

Tên của lệnh dấu gạch chéo được gọi.
command_id

int64

Mã lệnh của lệnh dấu gạch chéo đã gọi.
triggers_dialog

bool

Cho biết lệnh dấu gạch chéo có dành cho hộp thoại hay không.

Loại

Enum
TYPE_UNSPECIFIED Giá trị mặc định của enum. Không sử dụng.
ADD Thêm ứng dụng Chat vào không gian.
INVOKE Gọi lệnh dấu gạch chéo trong không gian.

Không gian

Một không gian trong Google Chat. Không gian là các cuộc trò chuyện giữa hai hoặc nhiều người dùng hoặc tin nhắn 1:1 giữa một người dùng và một ứng dụng trong Chat.

Trường
name

string

Tên tài nguyên của không gian.

Định dạng spaces/{space}
type
(deprecated)

Type

Chỉ có đầu ra. Không dùng nữa: Chuyển sang dùng space_type. Loại không gian.
space_type

SpaceType

Loại không gian. Bắt buộc khi tạo không gian hoặc cập nhật loại không gian của không gian. Chỉ có đầu ra cho mục đích sử dụng khác.
single_user_bot_dm

bool

Không bắt buộc. Liệu không gian có phải là tin nhắn trực tiếp giữa một ứng dụng Chat và một người hay không.
threaded
(deprecated)

bool

Chỉ có đầu ra. Không dùng nữa: Chuyển sang dùng spaceThreadingState. Liệu thư có được tạo chuỗi trong không gian này hay không.
display_name

string

Tên hiển thị của không gian. Bắt buộc khi tạo không gian. Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS khi tạo không gian hoặc cập nhật displayName, 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.

Đối với tin nhắn trực tiếp, trường này có thể trống.

Hỗ trợ tối đa 128 ký tự.
external_user_allowed

bool

Bất biến. Liệu không gian này có cho phép bất kỳ người dùng Google Chat nào làm thành viên hay không. Nhập dữ liệu khi tạo không gian trong một tổ chức trên Google Workspace. Bỏ qua trường này khi tạo khoảng trắng trong các điều kiện sau:

  • Người dùng đã xác thực sử dụng tài khoản người dùng cá nhân (tài khoản người dùng không được quản lý). Theo mặc định, không gian do tài khoản người dùng cá nhân tạo sẽ cho phép mọi người dùng Google Chat.

Đối với không gian hiện có, trường này chỉ là dữ liệu đầu ra.
space_threading_state

SpaceThreadingState

Chỉ có đầu ra. Trạng thái của chuỗi tin nhắn trong phòng Chat.
space_details

SpaceDetails

Thông tin chi tiết về không gian, bao gồm cả nội dung mô tả và quy tắc.
space_history_state

HistoryState

Trạng thái nhật ký tin nhắn của tin nhắn và chuỗi tin nhắn trong không gian này.
import_mode

bool

Không bắt buộc. Liệu không gian này có được tạo trong Import Mode trong quá trình di chuyển dữ liệu sang Google Workspace hay không. Mặc dù không gian đang được nhập, người dùng sẽ không nhìn thấy chúng cho đến khi quá trình nhập hoàn tất.
create_time

Timestamp

Không bắt buộc. Bất biến. Thời gian tạo không gian đối với các không gian được tạo trong Chat. Trường này chỉ dành cho kết quả đầu ra, trừ phi được dùng trong không gian ở chế độ nhập.

Đối với không gian ở chế độ nhập, hãy đặt trường này thành dấu thời gian trước đây khi không gian được tạo trong nguồn để duy trì thời gian tạo ban đầu.

Chỉ được điền sẵn vào kết quả khi spaceType là GROUP_CHAT hoặc SPACE.
last_active_time

Timestamp

Chỉ có đầu ra. Dấu thời gian của tin nhắn cuối cùng trong không gian.

admin_installed

bool

Chỉ có đầu ra. Đối với những không gian nhắn tin trực tiếp (DM) có ứng dụng Chat, thông tin cho biết không gian đó có phải do quản trị viên Google Workspace tạo hay không. Quản trị viên có thể thay mặt người dùng trong tổ chức cài đặt và thiết lập tin nhắn trực tiếp bằng ứng dụng Chat.

Để hỗ trợ việc cài đặt ứng dụng quản trị viên, ứng dụng Chat của bạn phải có tính năng nhắn tin trực tiếp.
membership_count

MembershipCount

Chỉ có đầu ra. Số lượng hội viên đã tham gia được nhóm theo loại thành viên. Được điền sẵn khi space_type là SPACE, DIRECT_MESSAGE hoặc GROUP_CHAT.

access_settings

AccessSettings

Không bắt buộc. Chỉ định chế độ cài đặt quyền truy cập của không gian. Chỉ được điền khi space_type là SPACE.
space_uri

string

Chỉ có đầu ra. URI để người dùng truy cập vào không gian.
Trường kết hợp space_permission_settings. Đại diện cho các chế độ cài đặt quyền của một không gian. Chỉ được điền khi space_type là SPACE. space_permission_settings chỉ có thể là một trong những trạng thái sau đây:
predefined_permission_settings

PredefinedPermissionSettings

Không bắt buộc. Chỉ nhập. Cài đặt quyền đối với không gian. Dữ liệu đầu vào để tạo không gian, không gian cộng tác sẽ được tạo nếu bạn không đặt trường này. Sau khi bạn tạo không gian, các chế độ cài đặt sẽ được điền sẵn vào trường PermissionSettings.

permission_settings

PermissionSettings

Không bắt buộc. Có thể đặt đúng chế độ cài đặt quyền để cập nhật không gian. Mục nhập để cập nhật một không gian. Nếu không, chỉ có thể xuất đầu ra. Để tạo không gian, hãy sử dụng predefined_permission_settings.

AccessSettings

Đại diện cho chế độ cài đặt quyền truy cập của không gian.

Trường
access_state

AccessState

Chỉ có đầu ra. Cho biết trạng thái truy cập của không gian.
audience

string

Không bắt buộc. Tên tài nguyên của đối tượng mục tiêu có thể khám phá không gian, tham gia không gian và xem trước tin nhắn trong không gian. Nếu bạn không đặt chính sách này, thì chỉ những người dùng hoặc nhóm trên Google Groups đã được mời hoặc thêm riêng vào không gian mới có thể truy cập vào không gian. Để biết thông tin chi tiết, hãy xem bài viết Giúp đối tượng mục tiêu có thể tìm thấy không gian.

Định dạng audiences/{audience}

Để sử dụng đối tượng mục tiêu mặc định cho tổ chức Google Workspace, hãy đặt thành audiences/default.

AccessState

Biểu thị trạng thái truy cập của không gian.

Enum
ACCESS_STATE_UNSPECIFIED Trạng thái truy cập không xác định hoặc không được hỗ trợ trong API này.
PRIVATE Chỉ những người dùng hoặc nhóm trên Google Groups mà quản trị viên Google Workspace hoặc người dùng khác thêm hoặc mời riêng mới có thể khám phá và truy cập vào không gian.
DISCOVERABLE Người quản lý không gian đã cấp cho một đối tượng mục tiêu quyền truy cập vào không gian. Những người dùng hoặc nhóm trên Google Groups được thêm hoặc mời riêng vào không gian cũng có thể khám phá và truy cập vào không gian. Để tìm hiểu thêm, hãy xem bài viết Đặt không gian có thể tìm thấy cho những người dùng cụ thể.

MembershipCount

Biểu thị số lượng thành viên của một không gian, được nhóm thành các danh mục.

Trường
joined_direct_human_user_count

int32

Số người dùng đã trực tiếp tham gia không gian, không tính số người dùng tham gia khi là thành viên trong một nhóm đã tham gia.
joined_group_count

int32

Số lượng tất cả các nhóm đã trực tiếp tham gia không gian.

PermissionSetting

Đại diện cho một chế độ cài đặt quyền của không gian.

Trường
managers_allowed

bool

Việc người quản lý không gian có quyền này hay không.
members_allowed

bool

Liệu các thành viên không phải là người quản lý có quyền này hay không.

PermissionSettings

Cài đặt quyền cho một không gian được đặt tên. Để thiết lập chế độ cài đặt quyền khi tạo không gian, hãy chỉ định trường PredefinedPermissionSettings trong yêu cầu của bạn.

Trường
manage_members_and_groups

PermissionSetting

Chế độ cài đặt để quản lý thành viên và nhóm trong một không gian.
modify_space_details

PermissionSetting

Chế độ cài đặt để cập nhật tên, hình đại diện, nội dung mô tả và nguyên tắc của không gian.
toggle_history

PermissionSetting

Chế độ cài đặt để bật và tắt nhật ký của không gian.
use_at_mention_all

PermissionSetting

Chế độ cài đặt để sử dụng tính năng đề cập tất cả bằng @trong một không gian.
manage_apps

PermissionSetting

Chế độ cài đặt để quản lý ứng dụng trong một không gian.
manage_webhooks

PermissionSetting

Chế độ cài đặt để quản lý webhook trong không gian.
post_messages

PermissionSetting

Chỉ có đầu ra. Chế độ cài đặt để đăng tin nhắn trong không gian.
reply_messages

PermissionSetting

Chế độ cài đặt để trả lời tin nhắn trong một không gian.

PredefinedPermissionSettings

Chế độ cài đặt quyền của không gian mà bạn có thể chỉ định khi tạo không gian được đặt tên. Trong tương lai, chúng tôi có thể sẽ thêm các chế độ cài đặt khác. Để biết thông tin chi tiết về các chế độ cài đặt quyền cho không gian được đặt tên, hãy xem bài viết Tìm hiểu về không gian.

Enum
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Không xác định. Không sử dụng.
COLLABORATION_SPACE Chế độ cài đặt biến không gian thành không gian cộng tác mà tất cả thành viên đều có thể đăng tin nhắn.
ANNOUNCEMENT_SPACE Chế độ cài đặt chuyển không gian thành không gian thông báo, nơi chỉ người quản lý không gian mới có thể đăng tin nhắn.

SpaceDetails

Thông tin chi tiết về không gian, bao gồm cả nội dung mô tả và quy tắc.

Trường
description

string

Không bắt buộc. Nội dung mô tả không gian. Ví dụ: mô tả chủ đề thảo luận của không gian, mục đích chức năng hoặc người tham gia.

Hỗ trợ tối đa 150 ký tự.
guidelines

string

Không bắt buộc. Quy tắc, yêu cầu và nghi thức của không gian.

Hỗ trợ tối đa 5.000 ký tự.

SpaceThreadingState

Chỉ định loại trạng thái của chuỗi tin nhắn trong phòng Chat.

Enum
SPACE_THREADING_STATE_UNSPECIFIED Đã đặt trước.
THREADED_MESSAGES Không gian được đặt tên có hỗ trợ các chuỗi tin nhắn. Khi trả lời thư, người dùng có thể trả lời dưới dạng chuỗi, tức là câu trả lời của họ vẫn nằm trong ngữ cảnh của thư gốc.
GROUPED_MESSAGES Không gian được đặt tên, trong đó cuộc trò chuyện được sắp xếp theo chủ đề. Các chủ đề và câu trả lời của các chủ đề đó sẽ được nhóm lại với nhau.
UNTHREADED_MESSAGES Tin nhắn trực tiếp (DM) giữa 2 người và cuộc trò chuyện nhóm giữa 3 người trở lên.

SpaceType

Loại không gian. Bắt buộc khi tạo hoặc cập nhật không gian. Chỉ có đầu ra cho mục đích sử dụng khác.

Enum
SPACE_TYPE_UNSPECIFIED Đã đặt trước.
SPACE Một nơi để mọi người gửi tin nhắn, chia sẻ tệp và cộng tác. SPACE có thể bao gồm các ứng dụng trong Chat.
GROUP_CHAT Cuộc trò chuyện nhóm giữa 3 người trở lên. GROUP_CHAT có thể bao gồm các ứng dụng trong Chat.
DIRECT_MESSAGE Tin nhắn 1:1 giữa hai người hoặc giữa một người và một ứng dụng trong Chat.

Loại

Không dùng nữa: Chuyển sang dùng SpaceType.

Enum
TYPE_UNSPECIFIED Đã đặt trước.
ROOM Cuộc trò chuyện giữa hai hoặc nhiều người.
DM Tin nhắn trực tiếp 1:1 giữa người dùng và ứng dụng Chat, trong đó tất cả tin nhắn đều ở dạng cố định. Xin lưu ý rằng điều này không bao gồm tin nhắn trực tiếp giữa hai người.

SpaceBatchUpdatedEventData

Tải trọng sự kiện cho nhiều nội dung cập nhật cho một không gian.

Loại sự kiện: google.workspace.chat.space.v1.batchUpdated

Trường
spaces[]

SpaceUpdatedEventData

Danh sách các không gian đã cập nhật.

SpaceEvent

Sự kiện đại diện cho một thay đổi hoặc một hoạt động trong phòng Google Chat. Để tìm hiểu thêm, hãy xem bài viết Làm việc với các sự kiện từ Google Chat.

Trường
name

string

Tên tài nguyên của sự kiện trong không gian.

Định dạng spaces/{space}/spaceEvents/{spaceEvent}
event_time

Timestamp

Thời gian khi sự kiện xảy ra.
event_type

string

Loại sự kiện trên không gian. Mỗi loại sự kiện có một phiên bản lô, đại diện cho nhiều lần diễn ra của loại sự kiện xảy ra trong một khoảng thời gian ngắn. Đối với các yêu cầu spaceEvents.list(), hãy bỏ qua các loại sự kiện hàng loạt trong bộ lọc truy vấn. Theo mặc định, máy chủ trả về cả loại sự kiện và phiên bản lô của sự kiện.

Các loại sự kiện được hỗ trợ cho tin nhắn:

  • Tin nhắn mới: google.workspace.chat.message.v1.created
  • Tin nhắn đã cập nhật: google.workspace.chat.message.v1.updated
  • Tin nhắn đã xoá: google.workspace.chat.message.v1.deleted
  • Nhiều tin nhắn mới: google.workspace.chat.message.v1.batchCreated
  • Nhiều tin nhắn đã cập nhật: google.workspace.chat.message.v1.batchUpdated
  • Nhiều thư bị xoá: google.workspace.chat.message.v1.batchDeleted

Các loại sự kiện được hỗ trợ cho chương trình hội viên:

  • Gói hội viên mới: google.workspace.chat.membership.v1.created
  • Đã cập nhật gói thành viên: google.workspace.chat.membership.v1.updated
  • Đã xoá gói thành viên: google.workspace.chat.membership.v1.deleted
  • Nhiều gói thành viên mới: google.workspace.chat.membership.v1.batchCreated
  • Nhiều gói thành viên mới cập nhật: google.workspace.chat.membership.v1.batchUpdated
  • Nhiều gói thành viên đã xoá: google.workspace.chat.membership.v1.batchDeleted

Các loại sự kiện được hỗ trợ cho phản ứng:

  • Lượt thể hiện cảm xúc mới: google.workspace.chat.reaction.v1.created
  • Đã xoá lượt thể hiện cảm xúc: google.workspace.chat.reaction.v1.deleted
  • Nhiều lượt thể hiện cảm xúc mới: google.workspace.chat.reaction.v1.batchCreated
  • Nhiều biểu tượng bày tỏ cảm xúc đã bị xoá: google.workspace.chat.reaction.v1.batchDeleted

Các loại sự kiện được hỗ trợ cho không gian:

  • Không gian đã cập nhật: google.workspace.chat.space.v1.updated
  • Nhiều thông tin cập nhật về không gian: google.workspace.chat.space.v1.batchUpdated

Trường kết hợp payload.

payload chỉ có thể là một trong những trạng thái sau đây:
message_created_event_data

MessageCreatedEventData

Tải trọng sự kiện cho một tin nhắn mới.

Loại sự kiện: google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

Tải trọng sự kiện cho một thông báo đã cập nhật.

Loại sự kiện: google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

Tải trọng sự kiện cho một thư đã xoá.

Loại sự kiện: google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

Tải trọng sự kiện cho nhiều tin nhắn mới.

Loại sự kiện: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

Tải trọng sự kiện cho nhiều thông báo được cập nhật.

Loại sự kiện: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

Tải trọng sự kiện cho nhiều thư đã xoá.

Loại sự kiện: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

Tải trọng sự kiện cho một lần cập nhật không gian.

Loại sự kiện: google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

Tải trọng sự kiện cho nhiều nội dung cập nhật cho một không gian.

Loại sự kiện: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

Tải trọng sự kiện cho một gói thành viên mới.

Loại sự kiện: google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

Tải trọng sự kiện cho một gói thành viên đã cập nhật.

Loại sự kiện: google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

Tải trọng sự kiện cho một gói thành viên đã xoá.

Loại sự kiện: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

Tải trọng sự kiện cho nhiều gói thành viên mới.

Loại sự kiện: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

Tải trọng sự kiện cho nhiều gói thành viên đã cập nhật.

Loại sự kiện: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

Tải trọng sự kiện cho nhiều gói thành viên đã xoá.

Loại sự kiện: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

Tải trọng sự kiện cho một phản ứng mới.

Loại sự kiện: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

Tải trọng sự kiện cho một phản ứng đã xoá.

Loại sự kiện: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data

ReactionBatchCreatedEventData

Tải trọng sự kiện cho nhiều phản ứng mới.

Loại sự kiện: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

Tải trọng sự kiện cho nhiều phản ứng đã xoá.

Loại sự kiện: google.workspace.chat.reaction.v1.batchDeleted

SpaceReadState

Trạng thái đã đọc của người dùng trong một không gian, dùng để xác định tin nhắn đã đọc và chưa đọc.

Trường
name

string

Tên tài nguyên của trạng thái đọc không gian.

Định dạng users/{user}/spaces/{space}/spaceReadState
last_read_time

Timestamp

Không bắt buộc. Thời điểm cập nhật trạng thái đọc không gian của người dùng. Thông thường, giá trị này tương ứng với dấu thời gian của tin nhắn đọc gần đây nhất hoặc dấu thời gian do người dùng chỉ định để đánh dấu vị trí đọc gần đây nhất trong một không gian.

SpaceUpdatedEventData

Tải trọng sự kiện cho một không gian đã cập nhật.

Loại sự kiện: google.workspace.chat.space.v1.updated

Trường
space

Space

Không gian mới được cập nhật.

Chuỗi hội thoại

Một chuỗi cuộc trò chuyện trong phòng Google Chat. Để biết ví dụ về cách sử dụng, hãy xem phần Bắt đầu hoặc trả lời một chuỗi tin nhắn.

Nếu chỉ định một chuỗi khi tạo thông báo, thì bạn có thể đặt trường messageReplyOption để xác định việc sẽ xảy ra nếu không tìm thấy chuỗi nào trùng khớp.

Trường
name

string

Tên tài nguyên của luồng.

Ví dụ: spaces/{space}/threads/{thread}
thread_key

string

Không bắt buộc. Thông tin đầu vào để tạo hoặc cập nhật một chuỗi tin nhắn. Nếu không, chỉ có thể xuất đầu ra. Mã nhận dạng của chuỗi. Hỗ trợ lên đến 4.000 ký tự.

Đây là mã nhận dạng duy nhất của ứng dụng Chat đặt ra mã này. Ví dụ: nếu nhiều ứng dụng trong Chat tạo tin nhắn bằng cùng một khoá chuỗi tin nhắn, thì tin nhắn đó sẽ được đăng trong nhiều chuỗi tin nhắn. Để trả lời trong chuỗi tin nhắn do người hoặc ứng dụng Chat khác tạo, hãy chỉ định trường name của chuỗi tin nhắn.

ThreadReadState

Trạng thái đã đọc của người dùng trong một chuỗi, dùng để xác định thư đã đọc và chưa đọc.

Trường
name

string

Tên tài nguyên của trạng thái đọc luồng.

Định dạng users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time

Timestamp

Thời điểm cập nhật trạng thái đọc chuỗi tin nhắn của người dùng. Thông thường, dấu thời gian này tương ứng với dấu thời gian của tin nhắn đọc lần gần đây nhất trong một chuỗi.

UpdateMembershipRequest

Yêu cầu gửi tin nhắn để cập nhật gói thành viên.

Trường
membership

Membership

Bắt buộc. Gói thành viên cần cập nhật. Chỉ những trường do update_mask chỉ định mới được cập nhật.
update_mask

FieldMask

Bắt buộc. Các đường dẫn của trường cần cập nhật. Hãy phân tách nhiều giá trị bằng dấu phẩy hoặc sử dụng * để cập nhật tất cả đường dẫn trường.

Đường dẫn trường hiện được hỗ trợ:

  • role
use_admin_access

bool

Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu chat.admin.memberships phạm vi OAuth 2.0.

UpdateMessageRequest

Yêu cầu cập nhật tin nhắn.

Trường
message

Message

Bắt buộc. Đã cập nhật thông báo có các trường.
update_mask

FieldMask

Bắt buộc. Các đường dẫn của trường cần cập nhật. Hãy phân tách nhiều giá trị bằng dấu phẩy hoặc sử dụng * để cập nhật tất cả đường dẫn trường.

Đường dẫn trường hiện được hỗ trợ:
allow_missing

bool

Không bắt buộc. Nếu không tìm thấy true và thông báo đó, thì một thông báo mới sẽ được tạo và updateMask sẽ bị bỏ qua. Mã nhận dạng thông báo được chỉ định phải là ứng dụng được chỉ định, nếu không yêu cầu không thành công.

UpdateSpaceReadStateRequest

Thông báo yêu cầu cho UpdateSpaceReadState API.

Trường
space_read_state

SpaceReadState

Bắt buộc. Không gian sẽ đọc trạng thái và các trường cần cập nhật.

Chỉ hỗ trợ cập nhật trạng thái đọc cho người dùng gọi.

Để tham chiếu đến người dùng gọi, hãy thiết lập một trong các tuỳ chọn sau:

  • Bí danh me. Ví dụ: users/me/spaces/{space}/spaceReadState.

  • Địa chỉ email Workspace của họ. Ví dụ: users/user@example.com/spaces/{space}/spaceReadState.

  • Mã nhận dạng người dùng của khách hàng. Ví dụ: users/123456789/spaces/{space}/spaceReadState.

Định dạng: users/{user}/spaces/{space}/spaceReadState
update_mask

FieldMask

Bắt buộc. Các đường dẫn của trường cần cập nhật. Đường dẫn trường hiện được hỗ trợ:

  • last_read_time

Khi last_read_time diễn ra trước thời gian tạo thông báo mới nhất, không gian sẽ xuất hiện dưới dạng chưa đọc trong giao diện người dùng.

Để đánh dấu không gian là đã đọc, hãy đặt last_read_time thành bất kỳ giá trị nào muộn hơn (lớn hơn) so với thời gian tạo thông báo gần đây nhất. last_read_time bị buộc phải khớp với thời gian tạo thông báo mới nhất. Xin lưu ý rằng trạng thái đã đọc của không gian chỉ ảnh hưởng đến trạng thái đã đọc của tin nhắn xuất hiện trong cuộc trò chuyện cấp cao nhất của không gian. Phản hồi trong chuỗi tin nhắn không chịu ảnh hưởng của dấu thời gian này. Thay vào đó, tin nhắn trả lời trong chuỗi tin nhắn sẽ phụ thuộc vào trạng thái đọc chuỗi.

UpdateSpaceRequest

Yêu cầu cập nhật một không gian.

Trường
space

Space

Bắt buộc. Không gian có các trường cần cập nhật. Space.name phải được điền theo dạng spaces/{space}. Chỉ những trường do update_mask chỉ định mới được cập nhật.
update_mask

FieldMask

Bắt buộc. Các đường dẫn trường đã cập nhật, được phân tách bằng dấu phẩy nếu có nhiều đường dẫn.

Bạn có thể cập nhật các trường sau đây cho một không gian:

  • space_details

  • display_name: Chỉ hỗ trợ cập nhật tên hiển thị cho các không gian có trường spaceType là SPACE. Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS, hãy thử một giá trị 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.

  • space_type: Chỉ hỗ trợ thay đổi loại không gian GROUP_CHAT thành SPACE. Đưa display_name cùng với space_type vào mặt nạ cập nhật và đảm bảo không gian được chỉ định có tên hiển thị không được để trống và có kiểu không gian SPACE. Bạn không bắt buộc phải thêm mặt nạ space_type và loại SPACE vào không gian được chỉ định khi cập nhật tên hiển thị nếu không gian hiện có đã có loại SPACE. Việc cố gắng cập nhật loại không gian theo cách khác sẽ dẫn đến lỗi đối số không hợp lệ. space_type không được hỗ trợ quyền quản trị.

  • space_history_state: Cập nhật chế độ cài đặt nhật ký của không gian bằng cách bật hoặc tắt nhật ký của không gian. Chỉ được hỗ trợ nếu chế độ cài đặt nhật ký được bật cho tổ chức Google Workspace. Để cập nhật trạng thái nhật ký của không gian, bạn phải bỏ qua tất cả mặt nạ trường khác trong yêu cầu của mình. space_history_state không được hỗ trợ quyền quản trị.

  • access_settings.audience: Cập nhật chế độ cài đặt quyền truy cập về những người có thể khám phá không gian, tham gia không gian và xem trước tin nhắn trong không gian có tên, trong đó trường spaceType là SPACE. Nếu không gian hiện có có đối tượng mục tiêu, bạn có thể xoá đối tượng và hạn chế quyền truy cập vào không gian bằng cách bỏ qua một giá trị cho mặt nạ trường này. Để cập nhật chế độ cài đặt quyền truy cập cho một không gian, người dùng xác thực phải là người quản lý không gian và bỏ qua tất cả các mặt nạ trường khác trong yêu cầu của bạn. Bạn không thể cập nhật trường này nếu không gian đang ở chế độ nhập. Để tìm hiểu thêm, hãy xem bài viết Đặt không gian có thể tìm thấy cho những người dùng cụ thể. access_settings.audience không được hỗ trợ quyền quản trị.

  • Bản dùng thử cho nhà phát triển: Hỗ trợ thay đổi chế độ cài đặt quyền của không gian, các đường dẫn trường được hỗ trợ bao gồm: permission_settings.manage_members_and_groups, permission_settings.modify_space_details, permission_settings.toggle_history, permission_settings.use_at_mention_all, permission_settings.manage_apps, permission_settings.manage_webhooks, permission_settings.reply_messages (Cảnh báo: loại trừ lẫn nhau với tất cả các đường dẫn trường cài đặt không cấp quyền khác). permission_settings không được hỗ trợ quyền quản trị.
use_admin_access

bool

Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu chat.admin.spaces phạm vi OAuth 2.0.

Một số giá trị FieldMask không được hỗ trợ bằng quyền quản trị. Để biết thông tin chi tiết, hãy xem nội dung mô tả về update_mask.

Người dùng

Một người dùng trong Google Chat. Khi được trả về dưới dạng kết quả của một yêu cầu, nếu ứng dụng Chat xác thực với tư cách một người dùng, thì kết quả cho tài nguyên User chỉ điền sẵn name và type của người dùng.

Trường
name

string

Tên tài nguyên của Google Chat user.

Định dạng: users/{user}. Bạn có thể dùng users/app làm biệt hiệu cho người dùng ứng dụng gọi bot.

Đối với human users, {user} giống với giá trị nhận dạng người dùng:

  • id cho Person (Người) trong API Mọi người. Ví dụ: users/123456789 trong API Chat biểu thị cùng một người với Mã hồ sơ cá nhân 123456789 trong API Mọi người.

  • id dành cho người dùng trong API Thư mục của SDK dành cho quản trị viên.

  • địa chỉ email của người dùng có thể được dùng làm email đại diện cho {user} trong các yêu cầu API. 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ể sử dụng users/user@example.com làm bí danh để tham chiếu users/123456789. Chỉ có tên tài nguyên chính tắc (ví dụ: users/123456789) được API trả về.
display_name

string

Chỉ có đầu ra. Tên hiển thị của người dùng.
domain_id

string

Giá trị nhận dạng duy nhất của miền Google Workspace của người dùng.
type

Type

Kiểu người dùng.
is_anonymous

bool

Chỉ có đầu ra. Khi true, người dùng sẽ bị xoá hoặc hồ sơ của họ không hiển thị.

Loại

Enum
TYPE_UNSPECIFIED Giá trị mặc định của enum. KHÔNG SỬ DỤNG.
HUMAN Người dùng.
BOT Người dùng ứng dụng Chat.

UserMentionMetadata

Siêu dữ liệu chú thích cho lượt đề cập của người dùng (@).

Trường
user

User

Người dùng đề cập.
type

Type

Loại nội dung đề cập đến người dùng.

Loại

Enum
TYPE_UNSPECIFIED Giá trị mặc định của enum. Không sử dụng.
ADD Thêm người dùng vào không gian.
MENTION Đề cập đến người dùng trong không gian.

WidgetMarkup

Tiện ích là một thành phần trên giao diện người dùng trình bày văn bản và hình ảnh.

Trường
buttons[]

Button

Danh sách các nút. Các nút cũng là oneof data và chỉ được đặt một trong các trường này.
Trường kết hợp data. WidgetMarkup chỉ có thể chứa một trong các mục sau. Bạn có thể sử dụng nhiều trường WidgetMarkup để hiển thị nhiều mặt hàng hơn. data chỉ có thể là một trong những trạng thái sau đây:
text_paragraph

TextParagraph

Hiển thị một đoạn văn bản trong tiện ích này.
image

Image

Hiển thị hình ảnh trong tiện ích này.
key_value

KeyValue

Hiển thị một mục khoá-giá trị trong tiện ích này.

Nút

Một nút. Có thể là nút văn bản hoặc nút hình ảnh.

Trường

Trường kết hợp type.

type chỉ có thể là một trong những trạng thái sau đây:
text_button

TextButton

Một nút có văn bản và hành động onclick.
image_button

ImageButton

Một nút có hình ảnh và hành động onclick.

FormAction

Tác vụ biểu mẫu mô tả hành vi khi biểu mẫu được gửi. Ví dụ: bạn có thể gọi Apps Script để xử lý biểu mẫu.

Trường
action_method_name

string

Tên phương thức được dùng để xác định phần nào của biểu mẫu đã kích hoạt việc gửi biểu mẫu. Thông tin này được lặp lại ứng dụng Chat trong sự kiện nhấp thẻ. Bạn có thể sử dụng cùng một tên phương thức cho một số phần tử kích hoạt hành vi phổ biến.
parameters[]

ActionParameter

Danh sách thông số hành động.

ActionParameter

Danh sách các tham số chuỗi cần cung cấp khi phương thức hành động được gọi. Ví dụ: hãy xem xét 3 nút tạm ẩn: tạm hoãn ngay bây giờ, tạm hoãn một ngày, tạm hoãn vào tuần tiếp theo. Bạn có thể sử dụng action method = snooze() để truyền loại tạm ẩn và thời gian tạm ẩn trong danh sách tham số chuỗi.

Trường
key

string

Tên của thông số cho tập lệnh hành động.
value

string

Giá trị của thông số.

Biểu tượng

Bộ biểu tượng được hỗ trợ.

Enum
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Bài đăng có hình ảnh

Hình ảnh do URL chỉ định và có thể có thao tác onclick.

Trường
image_url

string

URL của hình ảnh.
on_click

OnClick

Thao tác onclick.
aspect_ratio

double

Tỷ lệ khung hình của hình ảnh này (chiều rộng và chiều cao). Trường này cho phép bạn đặt trước chiều cao phù hợp cho hình ảnh trong khi chờ tải hình ảnh. Chế độ này không nhằm ghi đè tỷ lệ khung hình tích hợp sẵn của hình ảnh. Nếu bạn không đặt chính sách này, máy chủ sẽ điền giá trị bằng cách tìm nạp trước hình ảnh.

ImageButton

Một nút hình ảnh có thao tác onclick.

Trường
on_click

OnClick

Thao tác onclick.
name

string

Tên của image_button dùng để hỗ trợ tiếp cận. Giá trị mặc định sẽ được cung cấp nếu bạn không chỉ định tên này.
Trường kết hợp icons. Biểu tượng có thể được chỉ định bằng Icon enum hoặc URL. icons chỉ có thể là một trong những trạng thái sau đây:
icon

Icon

Biểu tượng do enum chỉ định để chỉ mục tới một biểu tượng do API Chat cung cấp.
icon_url

string

Biểu tượng do URL chỉ định.

KeyValue

Phần tử trên giao diện người dùng chứa khoá (nhãn) và giá trị (nội dung). Phần tử này cũng có thể chứa một số thao tác như nút onclick.

Trường
top_label

string

Văn bản của nhãn trên cùng. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về việc định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.
content

string

Văn bản của nội dung. Văn bản được định dạng được hỗ trợ và luôn bắt buộc. Để biết thêm thông tin về việc định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.
content_multiline

bool

Nội dung phải có nhiều dòng hay không.
bottom_label

string

Văn bản của nhãn dưới cùng. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về việc định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.
on_click

OnClick

Thao tác onclick. Chỉ nhãn trên cùng, nhãn dưới cùng và khu vực nội dung là có thể nhấp vào.
Trường kết hợp icons. Bạn phải xác định ít nhất một trong các biểu tượng, top_label và bottom_label. icons chỉ có thể là một trong những trạng thái sau đây:
icon

Icon

Một giá trị enum được API Chat thay thế bằng hình ảnh biểu tượng tương ứng.
icon_url

string

Biểu tượng do URL chỉ định.
Trường kết hợp control. Tiện ích điều khiển. Bạn có thể đặt button hoặc switch_widget, nhưng không thể đặt cả hai. control chỉ có thể là một trong những trạng thái sau đây:
button

Button

Nút mà người dùng có thể nhấp vào để kích hoạt một hành động.

OnClick

Một thao tác onclick (ví dụ: mở một đường liên kết).

Trường

Trường kết hợp data.

data chỉ có thể là một trong những trạng thái sau đây:
action

FormAction

Hành động onclick này sẽ kích hoạt một hành động đối với biểu mẫu nếu được chỉ định.

TextButton

Một nút có văn bản và hành động onclick.

Trường
text

string

Văn bản của nút.
on_click

OnClick

Hành động onclick của nút.

TextParagraph

Đoạn văn bản. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về việc định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.

Trường
text

string