Package google.chat.v1

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Hoàn tất quy trình nhập cho không gian được chỉ định và cho phép người dùng nhìn thấy không gian đó.

Yêu cầu xác thực người dùng và uỷ quyền trên toàn miền bằng phạm vi uỷ quyền:

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

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

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Tạo biểu tượng cảm xúc tuỳ chỉnh.

Chỉ tài khoản Google Workspace mới sử dụng được biểu tượng cảm xúc tuỳ chỉnh và quản trị viên phải bật biểu tượng cảm xúc tuỳ chỉnh cho tổ chức. Để biết thêm thông tin, hãy xem bài viết Tìm hiểu về biểu tượng cảm xúc tuỳ chỉnh trong Google Chat và Quản lý quyền đối với biểu tượng cảm xúc tuỳ chỉnh.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Tạo tư cách thành viên cho ứng dụng Chat đang gọi, một người dùng hoặc một nhóm trên Google Groups. Tính năng tạo gói thành viên cho các ứng dụng nhắn tin khác không được hỗ trợ. Khi tạo một 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 trước khi tham gia. Nếu không, việc tạo một thành viên sẽ thêm trực tiếp thành viên đó vào không gian được chỉ định.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng có sự phê duyệt của quản trị viên và phạm vi uỷ quyền:

  • https://www.googleapis.com/auth/chat.app.memberships

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app (để thêm ứng dụng gọi điện vào không gian)
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)
  • Quy trình xác thực người dùng sẽ cấp đặc quyền của quản trị viên khi tài khoản quản trị viên xác thực, use_admin_access là true và phạm vi uỷ quyền sau đây được sử dụng:
    • https://www.googleapis.com/auth/chat.admin.memberships

Tính năng xác thực ứng dụng không được hỗ trợ cho các trường hợp sử dụng sau:

• Mời người dùng bên ngoài tổ chức Workspace sở hữu không gian.
• Thêm một nhóm trên Google Groups vào một không gian.
• Thêm ứng dụng Chat vào không gian.

Để biết ví dụ về cách sử dụng, hãy xem:

• Mời hoặc thêm người dùng vào không gian.
• Mời hoặc thêm một nhóm trên Google Groups vào không gian.
• Thêm ứng dụng Chat vào 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.app.memberships
• 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.

rpc CreateMessage(CreateMessageRequest) returns (Message)

Tạo tin nhắn trong không gian Google Chat. Để biết ví dụ, hãy xem phần Gửi tin nhắn.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng với phạm vi uỷ quyền:
  • https://www.googleapis.com/auth/chat.bot
• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:
  • https://www.googleapis.com/auth/chat.messages.create
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)

Chat ghi nhận người gửi tin nhắn theo cách khác nhau tuỳ thuộc vào loại phương thức xác thực mà bạn sử dụng trong yêu cầu.

Hình ảnh sau đây cho thấy cách Chat ghi nhận một tin nhắn khi bạn sử dụng phương thức xác thực ứng dụng. Chat hiển thị ứng dụng Chat là người gửi tin nhắn. Nội dung của tin nhắn có thể chứa văn bản (text), thẻ (cardsV2) và tiện ích phụ (accessoryWidgets).

Hình ảnh sau đây cho thấy cách Chat ghi nhận một tin nhắn khi bạn sử dụng phương thức xác thực người dùng. Chat hiển thị người dùng là người gửi tin nhắn và ghi nhận ứng dụng Chat cho tin nhắn bằng cách hiển thị tên của ứng dụng. Nội dung của tin nhắn chỉ được chứa văn bản (text).

Kích thước tối đa của tin nhắn, bao gồm cả nội dung tin nhắn, là 32.000 byte.

Đối với các yêu cầu webhook, phản hồi không chứa toàn bộ thông báo. Phản hồi chỉ điền vào các trường name và thread.name ngoài thông tin có trong yêu cầu.

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.

rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin)

Tạo một tin nhắn được ghim.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

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

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

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

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Tạo một biểu tượng cảm xúc và thêm biểu tượng đó vào tin nhắn. Để xem ví dụ, hãy xem phần 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 bằng một trong các phạm vi uỷ quyền sau:

• https://www.googleapis.com/auth/chat.messages.reactions.create
• https://www.googleapis.com/auth/chat.messages.reactions
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)

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.

rpc CreateSection(CreateSectionRequest) returns (Section)

Tạo một mục trong Google Chat. Các mục giúp người dùng nhóm các cuộc trò chuyện và tuỳ chỉnh danh sách không gian xuất hiện trong bảng điều hướng của Chat. Chỉ có thể tạo các phần thuộc loại CUSTOM_SECTION. Để biết thông tin chi tiết, hãy xem bài viết Tạo và sắp xếp các mục trong Google Chat.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Tạo không gian. Có thể dùng để tạo một không gian có tên hoặc một cuộc trò chuyện nhóm trong Import mode. Để xem ví dụ, hãy xem phần Tạo không gian.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng có sự phê duyệt của quản trị viên và một trong các phạm vi uỷ quyền sau:

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

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)

Khi xác thực dưới dạng một ứng dụng, bạn phải đặt trường space.customer trong yêu cầu.

Khi xác thực dưới dạng ứng dụng, ứng dụng Chat sẽ được thêm làm thành viên của không gian. Tuy nhiên, không giống như quy trình xác thực của con người, ứng dụng Chat không được thêm làm người quản lý không gian. Theo mặc định, tất cả thành viên trong không gian đều có thể xoá ứng dụng Chat khỏi không gian. Để chỉ cho phép người quản lý không gian xoá ứng dụng khỏi không gian, hãy đặt space.permission_settings.manage_apps thành managers_allowed.

Thành viên của không gian khi tạo phụ thuộc vào việc không gian đó được tạo trong Import mode:

• Chế độ nhập: Không có thành viên nào được tạo.
• Tất cả các chế độ khác: Người dùng gọi điện được thêm làm thành viên. Đây là:
  • Bản thân ứng dụng khi sử dụng phương thức xác thực ứng dụng.
  • Người dùng là con người khi sử dụng phương thức xác thực người dùng.

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 Google Workspace có thể đã sử dụng tên hiển thị này.

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

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Xoá biểu tượng cảm xúc tuỳ chỉnh. Theo mặc định, người dùng chỉ có thể xoá biểu tượng cảm xúc tuỳ chỉnh mà họ đã tạo. Người quản lý biểu tượng cảm xúc do quản trị viên chỉ định có thể xoá mọi biểu tượng cảm xúc tuỳ chỉnh trong tổ chức. Xem bài viết Tìm hiểu về biểu tượng cảm xúc tuỳ chỉnh trong Google Chat.

Chỉ tài khoản Google Workspace mới sử dụng được biểu tượng cảm xúc tuỳ chỉnh và quản trị viên phải bật biểu tượng cảm xúc tuỳ chỉnh cho tổ chức. Để biết thêm thông tin, hãy xem bài viết Tìm hiểu về biểu tượng cảm xúc tuỳ chỉnh trong Google Chat và Quản lý quyền đối với biểu tượng cảm xúc tuỳ chỉnh.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Xoá một gói thành viên. Để xem ví dụ, hãy xem bài viết Xoá người dùng hoặc ứng dụng Google Chat khỏi không gian.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng có sự phê duyệt của quản trị viên và phạm vi uỷ quyền:

  • https://www.googleapis.com/auth/chat.app.memberships

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app (để xoá ứng dụng gọi điện khỏi không gian)
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)
  • Quy trình xác thực người dùng sẽ cấp đặc quyền của quản trị viên khi tài khoản quản trị viên xác thực, use_admin_access là true và phạm vi uỷ quyền sau đây được sử dụng:
    • https://www.googleapis.com/auth/chat.admin.memberships

Tính năng xác thực ứng dụng không được hỗ trợ cho các trường hợp sử dụng sau:

• Xoá một nhóm trên Google Groups khỏi không gian.
• Xoá ứng dụng Chat khỏi không gian.

Để xoá tư cách thành viên của người quản lý không gian, người yêu cầu phải là người quản lý không gian. Nếu bạn đang sử dụng phương thức xác thực ứng dụng, thì ứng dụng Chat phải là người tạo 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.app.memberships
• 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.

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

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

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng bằng phạm vi uỷ quyền:

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

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)

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 Chat gọi 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.

rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty)

Xoá tin nhắn đã ghim.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

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

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

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

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Xoá một phản ứng đối với tin nhắn. Để xem ví dụ, hãy tham khảo phần Xoá biểu tượng cảm xúc.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

• https://www.googleapis.com/auth/chat.messages.reactions
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)

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.

rpc DeleteSection(DeleteSectionRequest) returns (Empty)

Xoá một phần thuộc loại CUSTOM_SECTION.

Nếu mục này chứa các mục như không gian, thì các mục đó sẽ được chuyển đến các mục mặc định của Google Chat và không bị xoá.

Để biết thông tin chi tiết, hãy xem bài viết Tạo và sắp xếp các mục trong Google Chat.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Xoá một không gian có tên. Luôn thực hiện thao tác xoá theo tầng, tức là các tài nguyên con của không gian (như tin nhắn được đăng trong không gian và tư cách thành viên trong không gian) cũng sẽ bị xoá. Để biết ví dụ, hãy xem phần Xoá không gian.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng có sự phê duyệt của quản trị viên và phạm vi uỷ quyền:

  • https://www.googleapis.com/auth/chat.app.delete (chỉ trong không gian do ứng dụng tạo)

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.delete
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)
  • Quy trình xác thực người dùng sẽ cấp đặc quyền của quản trị viên khi tài khoản quản trị viên xác thực, use_admin_access là true và phạm vi uỷ quyền sau đây được sử dụng:
    • https://www.googleapis.com/auth/chat.admin.delete

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.app.delete
• 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.

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 nào, hàm này 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.

Khi dùng phương thức xác thực ứng dụng, phương thức này sẽ trả về không gian tin nhắn trực tiếp giữa người dùng được chỉ định và ứng dụng Chat đang gọi.

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

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng bằng phạm vi uỷ quyền:

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

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

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

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.

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

Trả về tất cả không gian có spaceType == GROUP_CHAT, có thành viên là người dùng chứa chính xác người dùng đang gọi và người dùng được chỉ định trong FindGroupChatsRequest.users. Chỉ hỗ trợ những thành viên đã tham gia cuộc trò chuyện. Để biết ví dụ, hãy xem phần Tìm cuộc trò chuyện nhóm.

Nếu người dùng gọi chặn hoặc bị một số người dùng chặn và không tìm thấy không gian nào có toàn bộ nhóm người dùng được chỉ định, thì phương thức này sẽ trả về những không gian không bao gồm người dùng bị chặn hoặc người dùng chặn.

Tập hợp người dùng được chỉ định chỉ được chứa thành viên là con người (không phải ứng dụng). Yêu cầu chứa người dùng không phải là con người sẽ không trả về không gian nào.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

• https://www.googleapis.com/auth/chat.memberships.readonly
• https://www.googleapis.com/auth/chat.memberships

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Lấy siêu dữ liệu của tệp đính kèm trong thư. 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 trong thư.

Yêu cầu xác thực ứng dụng với phạm vi uỷ quyền:

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

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.

rpc GetAvailability(GetAvailabilityRequest) returns (Availability)

Trả về thông tin về trạng thái rảnh/bận của người dùng trong Google Chat. Ví dụ: bạn có thể dùng thông tin này để kiểm tra xem người dùng đang trực tuyến hay vắng mặt, hoặc để truy xuất thông báo trạng thái tuỳ chỉnh của họ.

Phương thức này chỉ truy xuất trạng thái rảnh/bận của người dùng đã xác thực.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

• https://www.googleapis.com/auth/chat.users.availability.readonly
• https://www.googleapis.com/auth/chat.users.availability

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

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

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Trả về thông tin chi tiết về một biểu tượng cảm xúc tuỳ chỉnh.

Chỉ tài khoản Google Workspace mới sử dụng được biểu tượng cảm xúc tuỳ chỉnh và quản trị viên phải bật biểu tượng cảm xúc tuỳ chỉnh cho tổ chức. Để biết thêm thông tin, hãy xem bài viết Tìm hiểu về biểu tượng cảm xúc tuỳ chỉnh trong Google Chat và Quản lý quyền đối với biểu tượng cảm xúc tuỳ chỉnh.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

• https://www.googleapis.com/auth/chat.customemojis.readonly
• https://www.googleapis.com/auth/chat.customemojis

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

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

rpc GetMembership(GetMembershipRequest) returns (Membership)

Trả về thông tin chi tiết về một gói thành viên. Để xem ví dụ, hãy xem phần Lấy thông tin chi tiết về tư cách thành viên của người dùng hoặc ứng dụng Google Chat.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.memberships (cần có sự phê duyệt của quản trị viên)

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • Quy trình xác thực người dùng sẽ cấp đặc quyền của quản trị viên khi tài khoản quản trị viên xác thực, use_admin_access là true và một trong các phạm vi uỷ quyền sau đây được sử dụng:
    • https://www.googleapis.com/auth/chat.admin.memberships.readonly
    • https://www.googleapis.com/auth/chat.admin.memberships

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.app.memberships
• 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.

rpc GetMessage(GetMessageRequest) returns (Message)

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

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.bot: Khi sử dụng phạm vi uỷ quyền này, phương thức này sẽ trả về thông tin chi tiết về một tin nhắn mà ứng dụng Chat có quyền truy cập, chẳng hạn như tin nhắn trực tiếp và lệnh dấu gạch chéo gọi ứng dụng Chat.
  • https://www.googleapis.com/auth/chat.app.messages.readonly khi có sự phê duyệt của quản trị viên. Khi sử dụng phạm vi xác thực này, phương thức này sẽ trả về thông tin chi tiết về một tin nhắn công khai trong một không gian.

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages

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

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

rpc GetSpace(GetSpaceRequest) returns (Space)

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

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces cần có sự phê duyệt của quản trị viên

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • Quy trình xác thực người dùng sẽ cấp đặc quyền của quản trị viên khi tài khoản quản trị viên xác thực, use_admin_access là true và một trong các phạm vi uỷ quyền sau được sử dụng:
    • https://www.googleapis.com/auth/chat.admin.spaces.readonly
    • https://www.googleapis.com/auth/chat.admin.spaces

Tính năng xác thực ứng dụng có các hạn chế sau:

• space.access_settings chỉ được điền sẵn khi sử dụng phạm vi chat.app.spaces.
• space.predefind_permission_settings và space.permission_settings chỉ được điền sẵn khi sử dụng phạm vi chat.app.spaces và chỉ cho những không gian mà ứng dụng 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.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
• https://www.googleapis.com/auth/chat.app.spaces

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

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Trả về một sự kiện từ một không gian trong Google Chat. Trọng tải sự kiện chứa phiên bản mới 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ề tin nhắn mới nhưng tin nhắn đó được cập nhật sau, thì máy chủ sẽ trả về tài nguyên Message đã cập nhật trong tải trọng sự kiện.

Lưu ý: Trường permissionSettings không được trả về trong đối tượng Không gian của dữ liệu sự kiện Không gian cho yêu cầu này.

Hỗ trợ các loại xác thực sau đây với phạm vi uỷ quyền phù hợp để đọc dữ liệu được yêu cầu:

• Xác thực ứng dụng có sự phê duyệt của quản trị viên với một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

Để nhận được sự kiện, phương thức gọi đã xác thực phải là thành viên của không gian.

Để xem ví dụ, hãy xem bài viết Lấy thông tin chi tiết về một sự kiện từ không gian trên 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.app.memberships
• https://www.googleapis.com/auth/chat.app.memberships.readonly
• https://www.googleapis.com/auth/chat.app.messages.readonly
• https://www.googleapis.com/auth/chat.app.spaces
• https://www.googleapis.com/auth/chat.app.spaces.readonly
• https://www.googleapis.com/auth/chat.app.all.messages.readonly
• https://www.googleapis.com/auth/chat.app.all.spaces.readonly
• https://www.googleapis.com/auth/chat.app.all.memberships.readonly
• 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.

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Lấy chế độ cài đặt thông báo của không gian. Để xem ví dụ, hãy xem phần Lấy chế độ cài đặt thông báo của không gian của phương thức gọi.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

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. Để xem ví dụ, hãy xem phần Lấy 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 bằng một trong các phạm vi uỷ quyền sau:

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

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.

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 tin nhắn, dùng để xác định tin nhắn đã đọc và chưa đọc. Để xem ví dụ, hãy xem phần Xem thông tin chi tiết về trạng thái đọc chuỗi tin nhắn của người dùng.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

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

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.

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Liệt kê các biểu tượng cảm xúc tuỳ chỉnh mà người dùng đã xác thực có thể nhìn thấy.

Chỉ tài khoản Google Workspace mới sử dụng được biểu tượng cảm xúc tuỳ chỉnh và quản trị viên phải bật biểu tượng cảm xúc tuỳ chỉnh cho tổ chức. Để biết thêm thông tin, hãy xem bài viết Tìm hiểu về biểu tượng cảm xúc tuỳ chỉnh trong Google Chat và Quản lý quyền đối với biểu tượng cảm xúc tuỳ chỉnh.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

• https://www.googleapis.com/auth/chat.customemojis.readonly
• https://www.googleapis.com/auth/chat.customemojis

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

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

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Liệt kê các thành viên trong một không gian. Để xem 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. Khi bạn liệt kê thành viên bằng phương thức xác thực ứng dụng, hệ thống sẽ liệt kê 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 thành viên của ứng dụng Chat, kể cả thành viên của chính ứng dụng đó. Khi bạn liệt kê các thành viên bằng phương thức Xác thực người dùng, hệ thống sẽ liệt kê các 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.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.memberships (cần có sự phê duyệt của quản trị viên)

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)
  • Quy trình xác thực người dùng sẽ cấp đặc quyền của quản trị viên khi tài khoản quản trị viên xác thực, use_admin_access là true và một trong các phạm vi uỷ quyền sau đây được sử dụng:
    • https://www.googleapis.com/auth/chat.admin.memberships.readonly
    • https://www.googleapis.com/auth/chat.admin.memberships

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

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse)

Liệt kê các tin nhắn được ghim trong một không gian. Người dùng có thể ghim tin nhắn quan trọng trong không gian để dễ dàng truy cập. Để biết thêm thông tin, hãy xem bài viết Ghim hoặc bỏ ghim cuộc trò chuyện trong Google Chat.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

• https://www.googleapis.com/auth/chat.spaces.pins.readonly
• https://www.googleapis.com/auth/chat.spaces.pins
• https://www.googleapis.com/auth/chat.spaces.readonly
• https://www.googleapis.com/auth/chat.spaces

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

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

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Liệt kê các 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. Tin nhắn hệ thống, chẳng hạn như tin nhắn thông báo về thành viên mới trong không gian, không được tính. Nếu bạn liệt kê tin nhắn từ một không gian không có tin nhắn, thì phản hồi sẽ là một đối tượng trống. Khi sử dụng giao diện REST/HTTP, phản hồi sẽ chứa một đối tượng JSON trống, {}. Để biết ví dụ, hãy xem phần Liệt kê tin nhắn.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng có sự phê duyệt của quản trị viên với phạm vi uỷ quyền:

  • https://www.googleapis.com/auth/chat.app.messages.readonly. Khi sử dụng phạm vi xác thực này, phương thức này chỉ trả về các tin nhắn công khai trong một không gian. Bản sao lưu này không bao gồm tin nhắn riêng tư.

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)

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

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

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Liệt kê các biểu tượng cảm xúc cho một tin nhắn. Để biết ví dụ, hãy xem phần Liệt kê các biểu tượng cảm xúc cho một tin nhắn.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

• https://www.googleapis.com/auth/chat.messages.reactions.readonly
• https://www.googleapis.com/auth/chat.messages.reactions
• https://www.googleapis.com/auth/chat.messages.readonly
• https://www.googleapis.com/auth/chat.messages

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.

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse)

Liệt kê các mục trong một phần.

Chỉ không gian mới có thể là mục trong phần. Để biết thông tin chi tiết, hãy xem bài viết Tạo và sắp xếp các mục trong Google Chat.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

• https://www.googleapis.com/auth/chat.users.sections
• https://www.googleapis.com/auth/chat.users.sections.readonly

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

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

rpc ListSections(ListSectionsRequest) returns (ListSectionsResponse)

Liệt kê các mục mà người dùng Chat có thể sử dụng. Các mục giúp người dùng nhóm các cuộc trò chuyện và tuỳ chỉnh danh sách không gian xuất hiện trong bảng điều hướng của Chat. Để biết thông tin chi tiết, hãy xem bài viết Tạo và sắp xếp các mục trong Google Chat.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

• https://www.googleapis.com/auth/chat.users.sections
• https://www.googleapis.com/auth/chat.users.sections.readonly

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

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

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Liệt kê các sự kiện trong một không gian trên Google Chat. Đối với mỗi sự kiện, trọng tải chứa phiên bản mới nhất của tài nguyên Chat. Ví dụ: nếu bạn liệt kê các sự kiện về thành viên mới trong không gian, thì máy chủ sẽ trả về tài nguyên Membership chứa thông tin chi tiết mới nhất về thành viên. Nếu 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 tài nguyên Membership trống.

Hỗ trợ các loại xác thực sau đây với phạm vi uỷ quyền phù hợp để đọc dữ liệu được yêu cầu:

• Xác thực ứng dụng có sự phê duyệt của quản trị viên với một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

Để liệt kê các sự kiện, phương thức gọi đã xác thực phải là thành viên của không gian.

Để xem ví dụ, hãy xem phần Liệt kê sự kiện trong không gian 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.app.memberships
• https://www.googleapis.com/auth/chat.app.memberships.readonly
• https://www.googleapis.com/auth/chat.app.messages.readonly
• https://www.googleapis.com/auth/chat.app.spaces
• https://www.googleapis.com/auth/chat.app.spaces.readonly
• https://www.googleapis.com/auth/chat.app.all.messages.readonly
• https://www.googleapis.com/auth/chat.app.all.spaces.readonly
• https://www.googleapis.com/auth/chat.app.all.memberships.readonly
• 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.

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Liệt kê các không gian mà người gọi là thành viên. Các cuộc trò chuyện nhóm và tin nhắn trực tiếp sẽ không xuất hiện 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.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng bằng phạm vi uỷ quyền:

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

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

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

Để liệt kê tất cả không gian có tên theo tổ chức Google Workspace, hãy sử dụng phương thức spaces.search() bằng đặ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.

rpc MarkAsActive(MarkAsActiveRequest) returns (Availability)

Đánh dấu người dùng là ACTIVE trong Google Chat.

Đặt trạng thái rảnh/bận của người dùng thành ACTIVE. Trạng thái ACTIVE kéo dài cho đến khi hết hạn, tại thời điểm đó, trạng thái của người dùng sẽ trở thành AWAY. Xin lưu ý rằng nếu người dùng đang tích cực sử dụng Chat, thì thời lượng của trạng thái ACTIVE có thể kéo dài hơn thời gian hết hạn đã cung cấp.

Phương thức này chỉ cập nhật trạng thái rảnh/bận của người dùng đã xác thực.

Yêu cầu xác thực người dùng với phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

rpc MarkAsAway(MarkAsAwayRequest) returns (Availability)

Đánh dấu người dùng là AWAY trong Google Chat.

Đặt trạng thái của người dùng thành vắng mặt và không bị ảnh hưởng bởi hoạt động của người dùng.

Phương thức này chỉ cập nhật trạng thái rảnh/bận của người dùng đã xác thực.

Yêu cầu xác thực người dùng với phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

rpc MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest) returns (Availability)

Đánh dấu người dùng là DO_NOT_DISTURB trong Google Chat.

Đặt trạng thái rảnh/bận của người dùng thành DO_NOT_DISTURB cho đến thời gian hết hạn đã chỉ định. Khi ở DO_NOT_DISTURB, người dùng thường sẽ không nhận được thông báo.

Phương thức này chỉ cập nhật trạng thái rảnh/bận của người dùng đã xác thực.

Yêu cầu xác thực người dùng với phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

rpc MoveSectionItem(MoveSectionItemRequest) returns (MoveSectionItemResponse)

Di chuyển một mục từ phần này sang phần khác. Ví dụ: nếu một mục chứa các không gian, bạn có thể sử dụng phương thức này để di chuyển một không gian sang một mục khác. Để biết thông tin chi tiết, hãy xem bài viết Tạo và sắp xếp các mục trong Google Chat.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

rpc PositionSection(PositionSectionRequest) returns (PositionSectionResponse)

Thay đổi thứ tự sắp xếp của một mục. Để biết thông tin chi tiết, hãy xem bài viết Tạo và sắp xếp các mục trong Google Chat.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse)

Thay thế các thẻ có trong một tin nhắn.

Ứng dụng Chat chỉ có thể thay thế thẻ trên tin nhắn do con người tạo nếu tin nhắn đó đã chứa thẻ và thẻ đó do ứng dụng tạo.

Nếu ứng dụng thay thế các thẻ bằng một danh sách trống, thì các thẻ đó sẽ bị xoá. Sau khi xoá thẻ, ứng dụng không thể thêm thẻ trở lại tin nhắn.

Yêu cầu xác thực ứng dụng với phạm vi uỷ quyền: – https://www.googleapis.com/auth/chat.bot

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.

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse)

Tìm kiếm tin nhắn trong Google Chat mà người dùng gọi có quyền truy cập. Trả về danh sách thư khớp với tiêu chí tìm kiếm.

Để tìm kiếm trên tất cả không gian mà người dùng có quyền truy cập, hãy đặt parent thành spaces/-. Nếu bạn sử dụng bất kỳ giá trị nào khác cho parent, thì lỗi INVALID_ARGUMENT sẽ xảy ra. Các thông báo được trả về có trường name được điền tên tài nguyên đầy đủ, bao gồm cả space cụ thể chứa thông báo.

API này không trả về tất cả các loại thông báo. Các loại thông báo được liệt kê dưới đây không có trong phản hồi. Sử dụng ListMessages để liệt kê tất cả tin nhắn.

• Tin nhắn riêng tư mà người dùng đã xác thực có thể xem.
• Tin nhắn do ứng dụng Chat đăng trong không gian hoặc cuộc trò chuyện nhóm.
• Tin nhắn trong tin nhắn trực tiếp của ứng dụng Chat.
• Tin nhắn của người dùng bị chặn.
• Tin nhắn trong các không gian mà người gọi đã tắt tiếng.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

• https://www.googleapis.com/auth/chat.messages.readonly
• https://www.googleapis.com/auth/chat.messages

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

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

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Trả về danh sách không gian trong một tổ chức trên Google Workspace. Để biết ví dụ, hãy xem bài viết Tìm và quản lý không gian.

Khi use_admin_access được đặt thành false, kết quả sẽ chỉ bao gồm những không gian mà người dùng gọi là thành viên đã tham gia. Để tìm kiếm bằng đặc quyền của quản trị viên, hãy đặt use_admin_access thành true.

Hỗ trợ các loại xác thực sau:

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

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

• Xác thực người dùng có đặc quyền của quản trị viên và một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces

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

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

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

Để chỉ định các nhóm trên Google Groups cần thêm, hãy thêm tư cách 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ừ Cloud Identity Groups API. Ví dụ: bạn có thể sử dụng Cloud Identity Groups lookup API để truy xuất mã nhận dạng 123456789 cho email nhóm group@example.com, sau đó bạn có thể 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 không gian có tên.

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

Để tạo tin nhắn trực tiếp (DM) giữa người dùng gọi và một người dùng 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 dùng kia, thì yêu cầu sẽ không thành công và tin nhắn trực tiếp sẽ không được tạo.

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

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

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

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

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

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.

rpc UpdateAvailability(UpdateAvailabilityRequest) returns (Availability)

Cập nhật thông tin về tình trạng rảnh/bận cho người dùng. Bạn chỉ có thể cập nhật trường custom_status thông qua phương thức này.

Phương thức này chỉ cập nhật trạng thái rảnh/bận của người dùng đã xác thực.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

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

Phạm vi uỷ quyền

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

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

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

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Cập nhật một gói thành viên. Để xem ví dụ, hãy xem bài viết Cập nhật tư cách thành viên của người dùng trong không gian.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng có sự phê duyệt của quản trị viên và phạm vi uỷ quyền:

  • https://www.googleapis.com/auth/chat.app.memberships (chỉ trong không gian do ứng dụng tạo)

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)
  • Quy trình xác thực người dùng sẽ cấp đặc quyền của quản trị viên khi tài khoản quản trị viên xác thực, use_admin_access là true và phạm vi uỷ quyền sau đây được sử dụng:
    • https://www.googleapis.com/auth/chat.admin.memberships

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.app.memberships
• 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.

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 thông báo.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng bằng phạm vi uỷ quyền:

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

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)

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 Chat gọi 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.

rpc UpdateSection(UpdateSectionRequest) returns (Section)

Cập nhật một mục. Bạn chỉ có thể cập nhật các phần thuộc loại CUSTOM_SECTION. Để biết thông tin chi tiết, hãy xem bài viết Tạo và sắp xếp các mục trong Google Chat.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Cập nhật một không gian. Để biết ví dụ, hãy xem bài viết 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ử một tên hiển thị khác. Một không gian hiện có trong tổ chức Google Workspace có thể đã sử dụng tên hiển thị này.

Hỗ trợ các loại xác thực sau:

• Xác thực ứng dụng có sự phê duyệt của quản trị viên và một trong các phạm vi uỷ quyền sau:

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

• Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.import (chỉ dành cho không gian ở chế độ nhập)
  • Quy trình xác thực người dùng sẽ cấp đặc quyền của quản trị viên khi tài khoản quản trị viên xác thực, use_admin_access là true và phạm vi uỷ quyền sau đây được sử dụng:
    • https://www.googleapis.com/auth/chat.admin.spaces

Tính năng xác thực ứng dụng có các hạn chế sau:

• Để cập nhật space.predefined_permission_settings hoặc space.permission_settings, ứng dụng phải là người tạo không gian.
• Không hỗ trợ cập nhật space.access_settings.audience để 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.app.spaces
• 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.

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Cập nhật chế độ cài đặt thông báo của không gian. Để xem ví dụ, hãy xem phần Cập nhật chế độ cài đặt thông báo về không gian của người gọi.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

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

Phạm vi uỷ quyền

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

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

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

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. Để xem ví dụ, hãy 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 bằng phạm vi uỷ quyền:

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

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.