Chỉ mục
ChatService
(giao diện)AccessoryWidget
(thông báo)ActionResponse
(thông báo)ActionResponse.ResponseType
(enum)ActionResponse.SelectionItems
(thông báo)ActionResponse.UpdatedWidget
(thông báo)ActionStatus
(thông báo)Annotation
(thông báo)AnnotationType
(enum)AttachedGif
(thông báo)Attachment
(thông báo)Attachment.Source
(enum)AttachmentDataRef
(thông báo)CardWithId
(thông báo)ChatSpaceLinkData
(thông báo)CompleteImportSpaceRequest
(thông báo)CompleteImportSpaceResponse
(thông báo)ContextualAddOnMarkup
(thông báo)ContextualAddOnMarkup.Card
(thông báo)ContextualAddOnMarkup.Card.CardAction
(thông báo)ContextualAddOnMarkup.Card.CardHeader
(thông báo)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(enum)ContextualAddOnMarkup.Card.Section
(thông báo)CreateCustomEmojiRequest
(thông báo)CreateMembershipRequest
(thông báo)CreateMessageRequest
(thông báo)CreateMessageRequest.MessageReplyOption
(enum)CreateReactionRequest
(thông báo)CreateSpaceRequest
(thông báo)CustomEmoji
(thông báo)CustomEmoji.CustomEmojiPayload
(thông báo)DeleteCustomEmojiRequest
(thông báo)DeleteMembershipRequest
(thông báo)DeleteMessageRequest
(thông báo)DeleteReactionRequest
(thông báo)DeleteSpaceRequest
(thông báo)DeletionMetadata
(thông báo)DeletionMetadata.DeletionType
(enum)Dialog
(thông báo)DialogAction
(thông báo)DriveDataRef
(thông báo)DriveLinkData
(thông báo)Emoji
(thông báo)EmojiReactionSummary
(thông báo)FindDirectMessageRequest
(thông báo)GetAttachmentRequest
(thông báo)GetCustomEmojiRequest
(thông báo)GetMembershipRequest
(thông báo)GetMessageRequest
(thông báo)GetSpaceEventRequest
(thông báo)GetSpaceNotificationSettingRequest
(thông báo)GetSpaceReadStateRequest
(thông báo)GetSpaceRequest
(thông báo)GetThreadReadStateRequest
(thông báo)Group
(thông báo)HistoryState
(enum)ListCustomEmojisRequest
(thông báo)ListCustomEmojisResponse
(thông báo)ListMembershipsRequest
(thông báo)ListMembershipsResponse
(thông báo)ListMessagesRequest
(thông báo)ListMessagesResponse
(thông báo)ListReactionsRequest
(thông báo)ListReactionsResponse
(thông báo)ListSpaceEventsRequest
(thông báo)ListSpaceEventsResponse
(thông báo)ListSpacesRequest
(thông báo)ListSpacesResponse
(thông báo)MatchedUrl
(thông báo)Membership
(thông báo)Membership.MembershipRole
(enum)Membership.MembershipState
(enum)MembershipBatchCreatedEventData
(thông báo)MembershipBatchDeletedEventData
(thông báo)MembershipBatchUpdatedEventData
(thông báo)MembershipCreatedEventData
(thông báo)MembershipDeletedEventData
(thông báo)MembershipUpdatedEventData
(thông báo)Message
(thông báo)MessageBatchCreatedEventData
(thông báo)MessageBatchDeletedEventData
(thông báo)MessageBatchUpdatedEventData
(thông báo)MessageCreatedEventData
(thông báo)MessageDeletedEventData
(thông báo)MessageUpdatedEventData
(thông báo)QuotedMessageMetadata
(thông báo)Reaction
(thông báo)ReactionBatchCreatedEventData
(thông báo)ReactionBatchDeletedEventData
(thông báo)ReactionCreatedEventData
(thông báo)ReactionDeletedEventData
(thông báo)RichLinkMetadata
(thông báo)RichLinkMetadata.RichLinkType
(enum)SearchSpacesRequest
(thông báo)SearchSpacesResponse
(thông báo)SetUpSpaceRequest
(thông báo)SlashCommand
(thông báo)SlashCommandMetadata
(thông báo)SlashCommandMetadata.Type
(enum)Space
(thông báo)Space.AccessSettings
(thông báo)Space.AccessSettings.AccessState
(enum)Space.MembershipCount
(thông báo)Space.PermissionSetting
(thông báo)Space.PermissionSettings
(thông báo)Space.PredefinedPermissionSettings
(enum)Space.SpaceDetails
(thông báo)Space.SpaceThreadingState
(enum)Space.SpaceType
(enum)Space.Type
(enum)SpaceBatchUpdatedEventData
(thông báo)SpaceEvent
(thông báo)SpaceNotificationSetting
(thông báo)SpaceNotificationSetting.MuteSetting
(enum)SpaceNotificationSetting.NotificationSetting
(enum)SpaceReadState
(thông báo)SpaceUpdatedEventData
(thông báo)Thread
(thông báo)ThreadReadState
(thông báo)UpdateMembershipRequest
(thông báo)UpdateMessageRequest
(thông báo)UpdateSpaceNotificationSettingRequest
(thông báo)UpdateSpaceReadStateRequest
(thông báo)UpdateSpaceRequest
(thông báo)User
(thông báo)User.Type
(enum)UserMentionMetadata
(thông báo)UserMentionMetadata.Type
(enum)WidgetMarkup
(thông báo)WidgetMarkup.Button
(thông báo)WidgetMarkup.FormAction
(thông báo)WidgetMarkup.FormAction.ActionParameter
(thông báo)WidgetMarkup.Icon
(enum)WidgetMarkup.Image
(thông báo)WidgetMarkup.ImageButton
(thông báo)WidgetMarkup.KeyValue
(thông báo)WidgetMarkup.OnClick
(thông báo)WidgetMarkup.OpenLink
(thông báo)WidgetMarkup.TextButton
(thông báo)WidgetMarkup.TextParagraph
(thông báo)
ChatService
Cho phép nhà phát triển tạo ứng dụng và công cụ tích hợp Chat trên Nền tảng Google Chat.
CompleteImportSpace |
---|
Hoàn tất quy trình nhập cho không gian đã 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 Uỷ quyền cho ứng dụng Google Chat nhập dữ liệu.
|
CreateCustomEmoji |
---|
Yêu cầu xác thực người dùng.
|
CreateMembership |
---|
Tạo tư cách thành viên cho ứng dụng Chat đang gọi, người dùng hoặc Nhóm trên Google. Không hỗ trợ tạo gói thành viên cho các ứng dụng Chat khác. Khi bạn tạo gói 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 gói thành viên sẽ trực tiếp thêm thành viên vào không gian đã chỉ định. Hỗ trợ các loại xác thực sau:
Để biết ví dụ về cách sử dụng, hãy xem:
|
CreateMessage |
---|
Tạo tin nhắn trong không gian trên Google Chat. Để biết ví dụ, hãy xem phần Gửi tin nhắn. Phương thức Hình ảnh sau đây cho thấy cách Chat phân bổ tin nhắn khi bạn sử dụng tính năng xác thực ứng dụng. Chat hiển thị ứng dụng Chat dưới dạng người gửi tin nhắn. Nội dung của thông báo có thể chứa văn bản ( Hình ảnh sau đây cho thấy cách Chat phân bổ tin nhắn khi bạn sử dụng tính năng 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à phân bổ ứng dụng Chat cho tin nhắn đó bằng cách hiển thị tên ứng dụng. Nội dung của thông báo chỉ có thể chứa văn bản ( Kích thước tối đa của thư, bao gồm cả nội dung thư, là 32.000 byte.
|
CreateReaction |
---|
Tạo một biểu tượng cảm xúc và thêm biểu tượng đó vào 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 Thêm lượt thể hiện cảm xúc vào tin nhắn. Yêu cầu xác thực người dùng.
|
CreateSpace |
---|
Tạo không gian. Có thể dùng để tạo không gian có tên hoặc cuộc trò chuyện nhóm trong Hỗ trợ các loại xác thực sau: Khi xác thực dưới dạng ứng dụng, bạn phải đặt trường Quyền 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
Nếu bạn nhận được thông báo lỗi
|
DeleteCustomEmoji |
---|
Yêu cầu xác thực người dùng.
|
DeleteMembership |
---|
Xoá gói thành viên. Ví dụ: hãy xem bài viết Xoá người dùng hoặc ứng dụng Google Chat khỏi một không gian. Hỗ trợ các loại xác thực sau:
|
DeleteMessage |
---|
Xoá một 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: Khi sử dụng tính năng 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.
|
DeleteReaction |
---|
Xoá một biểu tượng cảm xúc dành cho 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 bày tỏ cảm xúc. Yêu cầu xác thực người dùng.
|
DeleteSpace |
---|
Xoá không gian được đặt tên. Luôn thực hiện thao tác xoá lồng nhau, tức là các 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à gói thành viên trong không gian) cũng sẽ bị xoá. Để biết ví dụ, hãy xem bài viết Xoá không gian. Hỗ trợ các loại xác thực sau:
|
FindDirectMessage |
---|
Trả về tin nhắn trực tiếp hiện có với người dùng đã chỉ định. Nếu không tìm thấy không gian tin nhắn trực tiếp, hãy trả về lỗi Với quy trình xác thực ứng dụng, 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. Với quy trình xác thực người dùng, 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:
|
GetAttachment |
---|
Lấy siêu dữ liệu của tệp đính kèm 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 Nhận siêu dữ liệu về tệp đính kèm trong thư. Yêu cầu xác thực ứng dụng.
|
GetCustomEmoji |
---|
Yêu cầu xác thực người dùng.
|
GetMembership |
---|
Trả về thông tin chi tiết về một gói thành viên. Để biết ví dụ, hãy xem phần Nhận thông tin chi tiết về gói 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:
|
GetMessage |
---|
Trả về thông tin chi tiết về một thông báo. Để biết ví dụ, hãy xem phần Nhận thông tin chi tiết về một thông báo. Hỗ trợ các loại xác thực sau: 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.
|
GetSpace |
---|
Trả về thông tin chi tiết về một không gian. Để biết ví dụ, hãy xem bài viết Xem thông tin chi tiết về không gian. Hỗ trợ các loại xác thực sau:
|
GetSpaceEvent |
---|
Trả về một sự kiện từ không gian Google Chat. Gói dữ liệu 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ề một tin nhắn mới nhưng sau đó tin nhắn đó được cập nhật, thì máy chủ sẽ trả về tài nguyên Lưu ý: Trường Yêu cầu xác thực người dùng. Để nhận được 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. Để biết ví dụ, hãy xem bài viết Nhận thông tin chi tiết về một sự kiện trong không gian trên Google Chat.
|
GetSpaceNotificationSetting |
---|
Yêu cầu xác thực người dùng.
|
GetSpaceReadState |
---|
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. Để biết ví dụ, hãy 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.
|
GetThreadReadState |
---|
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 thư, dùng để xác định thư đã đọc và chưa đọc. Để biết ví dụ, hãy xem phần Nhận thông tin chi tiết về trạng thái đọc luồng của người dùng. Yêu cầu xác thực người dùng.
|
ListCustomEmojis |
---|
Yêu cầu xác thực người dùng.
|
ListMemberships |
---|
Liệt kê các gói 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. Tính năng liệt kê gói thành viên bằng quy trình xác thực ứng dụng sẽ liệt kê các gói thành viên trong những không gian mà ứng dụng Chat có quyền truy cập, nhưng loại trừ các gói thành viên của ứng dụng Chat, bao gồm cả gói thành viên của chính ứng dụng đó. Liệt kê gói thành viên bằng tính năng Xác thực người dùng sẽ liệt kê các gói thành viên trong 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:
|
ListMessages |
---|
Liệt kê các tin nhắn trong một không gian mà phương thức gọi là thành viên, bao gồm cả tin nhắn từ các thành viên và không gian bị chặn. Nếu bạn liệt kê các 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, Yêu cầu xác thực người dùng.
|
ListReactions |
---|
Liệt kê các lượt bày tỏ cảm xúc đối với 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.
|
ListSpaceEvents |
---|
Liệt kê các sự kiện trong một không gian 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 Chat. Ví dụ: nếu bạn liệt kê các sự kiện về thành viên mới của không gian, thì máy chủ sẽ trả về các tài nguyên Yêu cầu xác thực người dùng. Để liệt kê sự kiện, người dùng đã xác thực phải là thành viên của không gian. Để biết ví dụ, hãy xem bài viết Liệt kê sự kiện trong không gian trên Google Chat.
|
ListSpaces |
---|
Liệt kê các không gian mà phương thức gọi là thành viên. 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 bạn gửi tin nhắn đầu tiên. Để 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: Để 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
|
SearchSpaces |
---|
Trả về danh sách không gian trong một tổ chức Google Workspace dựa trên nội dung tìm kiếm của quản trị viên. Yêu cầu xác thực người dùng bằng đặc quyền quản trị viên. Trong yêu cầu, hãy đặt
|
SetUpSpace |
---|
Tạo không gian và thêm những người dùng đã chỉ định vào không gian đó. Người dùng gọi sẽ tự động được thêm vào không gian và không được chỉ định là thành viên trong yêu cầu. Để biết ví dụ, hãy xem bài viết Thiết lập không gian có các thành viên ban đầu. Để chỉ định thành viên là người dùng cần thêm, hãy thêm gói thành viên bằng Để chỉ định các nhóm Google cần thêm, hãy thêm gói thành viên bằng Đối với không gian có tên hoặc cuộc trò chuyện nhóm, nếu người gọi chặn hoặc bị một số thành viên chặn hoặc không có quyền thêm một số thành viên, thì những thành viên đó sẽ không được thêm vào không gian đã tạo. Để tạo tin nhắn trực tiếp (DM) giữa người dùng gọi và một người dùng thực khác, hãy chỉ định chính xác một gói thành viên để đại diện cho người dùng thực. Nếu một người dùng chặn người dùng khác, thì yêu cầu sẽ không thành công và tin nhắn trực tiếp sẽ không được tạo. Để tạo tin nhắn trực tiếp giữa người dùng gọi và ứng dụng gọi, hãy đặt Nếu một cuộc trò chuyện riêng tư đã tồn tại giữa hai người dùng, ngay cả khi một người dùng chặn người dùng kia tại thời điểm yêu cầu được thực hiện, thì cuộc trò chuyện riêng tư hiện có sẽ được trả về. Không hỗ trợ không gian có câu trả lời theo chuỗi. Nếu bạn nhận được thông báo lỗi Yêu cầu xác thực người dùng.
|
UpdateMembership |
---|
Cập nhật gói thành viên. Để biết ví dụ, hãy xem bài viết Cập nhật trạng thái thành viên của người dùng trong một không gian. Hỗ trợ các loại xác thực sau:
|
UpdateMessage |
---|
Cập nhật tin nhắn. Có sự khác biệt giữa phương thức Hỗ trợ các loại xác thực sau: Khi sử dụng tính năng 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.
|
UpdateSpace |
---|
Cập nhậ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 Hỗ trợ các loại xác thực sau:
|
UpdateSpaceNotificationSetting |
---|
Yêu cầu xác thực người dùng.
|
UpdateSpaceReadState |
---|
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. Để biết 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.
|
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 hợp hợp nhất action . Loại hành động. action chỉ có thể là một trong những loại sau: |
|
button_ |
Danh sách các nút. |
ActionResponse
Các thông số mà ứng dụng Chat có thể sử dụng để định cấu hình cách đăng phản hồi.
Trường | |
---|---|
type |
Chỉ nhập. Loại phản hồi của ứng dụng Chat. |
url |
Chỉ nhập. URL để người dùng xác thực hoặc định cấu hình. (Chỉ dành cho các loại phản hồi |
dialog_ |
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 đi kèm với |
updated_ |
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 Chat.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Loại mặc định được xử lý dưới dạng 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 , trong đó loại trình gửi thông báo là BOT . |
UPDATE_USER_MESSAGE_CARDS |
Cập nhật thẻ trên tin nhắn của người dùng. Điều này chỉ được phép khi phản hồi một sự kiện MESSAGE có URL phù hợp hoặc một sự kiện CARD_CLICKED trong đó loại trình gửi thông báo là HUMAN . Văn bản sẽ bị bỏ qua. |
REQUEST_CONFIG |
Yêu cầu người dùng xác thực hoặc định cấu hình thêm một cách riêng tư. |
DIALOG |
Trình bày một hộp thoại. |
UPDATE_WIDGET |
Truy vấn các tuỳ chọn tự động hoàn thành văn bản tiện ích. |
SelectionItems
Danh sách kết quả tự động hoàn thành tiện ích.
Trường | |
---|---|
items[] |
Một mảng 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 tuỳ chọn tự động hoàn thành cho một tiện ích.
Trường | |
---|---|
widget |
Mã của tiện ích đã cập nhật. Mã nhận dạng này phải khớp với mã nhận dạng của tiện ích đã kích hoạt yêu cầu cập nhật. |
Trường hợp hợp nhất updated_widget . Tiện ích được cập nhật để phản hồi một hành động của người dùng. updated_widget chỉ có thể là một trong những loại sau: |
|
suggestions |
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_ |
Mã trạng thái. |
user_ |
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 không đặt, hệ thống sẽ gửi một thông báo chung dựa trên |
Annotation
Chỉ có đầu ra. Chú giải liên kết với nội dung văn bản thuần tuý của thư. Để thêm định dạng cơ bản vào tin nhắn văn bản, hãy xem bài viết Định dạng tin nhắn văn bản.
Ví dụ về nội dung thư 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 |
Loại chú thích này. |
length |
Độ dài của chuỗi con trong nội dung thư văn bản thuần tuý mà chú thích này tương ứng. |
start_ |
Chỉ mục bắt đầu (dựa trên 0, bao gồm cả) trong nội dung thư văn bản thuần tuý mà chú thích này tương ứng. |
Trường hợp hợp nhất metadata . Siêu dữ liệu bổ sung về chú giải. metadata chỉ có thể là một trong những loại sau: |
|
user_ |
Siêu dữ liệu của nội dung đề cập đến người dùng. |
slash_ |
Siêu dữ liệu cho lệnh dấu gạch chéo. |
rich_ |
Siêu dữ liệu của đường liên kết đa dạng thức. |
AnnotationType
Loại chú thích.
Enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Giá trị mặc định cho 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. |
RICH_LINK |
Chú thích đường liên kết đa dạng thức. |
AttachedGif
Hình ảnh GIF được chỉ định bằng URL.
Trường | |
---|---|
uri |
Chỉ có đầu ra. URL lưu trữ hình ảnh GIF. |
Tệp đính kèm
Tệp đính kèm trong Google Chat.
Trường | |
---|---|
name |
Không bắt buộc. Tên tài nguyên của tệp đính kèm, ở dạng |
content_ |
Chỉ có đầu ra. Tên tệp gốc của nội dung, chứ không phải đường dẫn đầy đủ. |
content_ |
Chỉ có đầu ra. Loại nội dung (loại MIME) của tệp. |
thumbnail_ |
Chỉ có đầu ra. URL hình thu nhỏ sẽ được dùng để xem trước tệp đính kèm cho người dùng. Ứng dụng nhắn tin không được sử dụng URL này để tải nội dung tệp đính kèm xuống. |
download_ |
Chỉ có đầu ra. URL tải xuống cần được dùng để cho phép người dùng tải tệp đính kèm xuống. Ứng dụng nhắn tin không được sử dụng URL này để tải nội dung tệp đính kèm xuống. |
source |
Chỉ có đầu ra. Nguồn của tệp đính kèm. |
Trường hợp hợp nhất data_ref . Tham chiếu dữ liệu đến tệp đính kèm. data_ref chỉ có thể là một trong những loại sau: |
|
attachment_ |
Không bắt buộc. Tham chiếu đến dữ liệu tệp đính kèm. Trường này dùng để tạo hoặc cập nhật tin nhắn có tệp đính kèm hoặc dùng API nội dung nghe nhìn để tải dữ liệu tệp đính kèm xuống. |
drive_ |
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 là tệp trên Google Drive. |
UPLOADED_CONTENT |
Tệp sẽ được tải lên Chat. |
AttachmentDataRef
Tham chiếu đến dữ liệu tệp đính kèm.
Trường | |
---|---|
resource_ |
Không bắt buộc. 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_ |
Không bắt buộc. Mã thông báo mờ chứa tham chiếu đến 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 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 Chat mới có thể tạo thẻ. Nếu ứng dụng Chat xác thực dưới dạng 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_ |
Bắt buộc nếu thông báo có chứa nhiều thẻ. Giá trị nhận dạng duy nhất của một thẻ trong thư. |
card |
Thẻ. Kích thước tối đa là 32 KB. |
ChatSpaceLinkData
Dữ liệu về đường liên kết đến phòng Chat.
Trường | |
---|---|
space |
Không gian của tài nguyên phòng Chat được liên kết. Định dạng |
thread |
Luồng của tài nguyên phòng Chat được liên kết. Định dạng |
message |
Thông báo của tài nguyên phòng Chat được liên kết. Định dạng |
CompleteImportSpaceRequest
Tin nhắn yêu cầu hoàn tất quá trình nhập cho một không gian.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của không gian ở chế độ nhập. Định dạng |
CompleteImportSpaceResponse
Thông báo phản hồi khi hoàn tất quy trình nhập cho một không gian.
Trường | |
---|---|
space |
Không gian chế độ nhập. |
ContextualAddOnMarkup
Loại này không có trường nào.
Mã đánh dấu để nhà phát triển chỉ định nội dung của một AddOn 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 trên giao diện người dùng như văn bản và hình ảnh.
Trường | |
---|---|
header |
Tiêu đề của thẻ. Tiêu đề thường chứa một tiêu đề và một hình ảnh. |
sections[] |
Các phần được phân tách bằng một đường phân cách. |
card_ |
Các thao tác của thẻ này. |
name |
Tên thẻ. |
CardAction
Hành động trên thẻ là hành động được liên kết với 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.
Ứng dụng Google Chat không hỗ trợ tính năng này.
Trường | |
---|---|
action_ |
Nhãn này từng xuất hiện trong mục trình đơn thao tác. |
on_ |
Thao tác onclick cho mục hành động này. |
CardHeader
Trường | |
---|---|
title |
Bạn phải chỉ định tiêu đề. Tiêu đề có chiều cao cố định: nếu bạn chỉ định cả tiêu đề và phụ đề, thì mỗi tiêu đề sẽ chiếm một dòng. Nếu chỉ chỉ định tiêu đề, tiêu đề sẽ chiếm cả hai dòng. |
subtitle |
Phụ đề của tiêu đề thẻ. |
image_ |
Loại hình ảnh (ví dụ: đường viền hình vuông hoặc đường viền hình tròn). |
image_ |
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 hình tròn. |
Phần
Một phần chứa một tập hợp các tiện ích được kết xuất (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 đến các thuộc tính bố cục (ví dụ: float).
Trường | |
---|---|
header |
Tiêu đề của phần. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về cách định dạng văn bản, hãy xem bài viết Định dạng văn bản trong ứng dụng Google Chat và Định dạng văn bản trong tiện ích bổ sung của Google Workspace. |
widgets[] |
Một phần phải chứa ít nhất một tiện ích. |
CreateCustomEmojiRequest
Yêu cầu tạo biểu tượng cảm xúc tuỳ chỉnh.
Trường | |
---|---|
custom_ |
Bắt buộc. Biểu tượng cảm xúc tuỳ chỉnh cần tạo. |
CreateMembershipRequest
Thông báo yêu cầu tạo gói thành viên.
Trường | |
---|---|
parent |
Bắt buộc. Tên tài nguyên của không gian mà bạn muốn tạo gói thành viên. Định dạng: spaces/{space} |
membership |
Bắt buộc. Mối quan hệ thành viên cần tạo. Trường Khi tạo mối quan hệ thành viên cho người dùng, ứng dụng Chat phải sử dụng một số phạm vi uỷ quyền nhất định và đặt giá trị cụ thể cho một số trường nhất định:
Để mời người dùng bên ngoài tổ chức Workspace sở hữu không gian, bạn phải xác thực người dùng. Khi tạo mối quan hệ thành viên cho chính mình, ứng dụng Chat phải xác thực dưới dạng người dùng và sử dụng phạm vi |
use_ |
Không bắt buộc. Khi 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à cuộc trò chuyện trong không gian. Yêu cầu phạm vi OAuth 2.0 Bạn không thể tạo gói thành viên ứng dụng hoặc tạo gói 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 bằng quyền quản trị. |
CreateMessageRequest
Tạo một thông báo.
Trường | |
---|---|
parent |
Bắt buộc. Tên tài nguyên của không gian để tạo thông báo. Định dạng |
message |
Bắt buộc. Nội dung thư. |
thread_key |
Không bắt buộc. Không dùng nữa: Hãy sử dụng |
request_ |
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ã yêu cầu hiện có sẽ trả về thông báo được tạo bằng mã đó thay vì tạo thông báo mới. |
message_ |
Không bắt buộc. Chỉ định liệu một tin nhắn có bắt đầu một chuỗi tin nhắn hay trả lời một chuỗi tin nhắn. Chỉ hỗ trợ trong không gian có tên. Khi phản hồi các hoạt động tương tác của người dùng, trường này sẽ bị bỏ qua. Đối với các lượt tương tác trong một chuỗi tin nhắn, tin nhắn trả lời sẽ được tạo trong cùng một chuỗi tin nhắn. Nếu không, tin nhắn trả lời sẽ được tạo dưới dạng một chuỗi tin nhắn mới. |
message_ |
Không bắt buộc. Mã nhận dạng tuỳ chỉnh cho một thông báo. Cho phép ứng dụng 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 Giá trị của trường này phải đáp ứng các yêu cầu sau:
Để biết thông tin chi tiết, hãy xem phần Gán tên cho thư. |
MessageReplyOption
Chỉ định cách trả lời tin nhắn. Chúng tôi có thể 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 luồng mới. Khi sử dụng tuỳ chọn này, mọi thread ID hoặc có trong đó đều bị bỏ qua. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Tạo thư dưới dạng thư trả lời cho chuỗi tin nhắn do thread ID hoặc chỉ định. Nếu không thành công, thông báo sẽ bắt đầu một luồng mới. |
REPLY_MESSAGE_OR_FAIL |
Tạo thư dưới dạng thư trả lời cho chuỗi tin nhắn do thread ID hoặc chỉ định. Nếu bạn sử dụng thread_key mới, một luồng mới sẽ được tạo. Nếu không tạo được thông báo, lỗi NOT_FOUND sẽ được trả về. |
CreateReactionRequest
Tạo biểu tượng cảm xúc cho một tin nhắn.
Trường | |
---|---|
parent |
Bắt buộc. Tin nhắn nơi tạo phản ứng. Định dạng |
reaction |
Bắt buộc. Phản ứng cần tạo. |
CreateSpaceRequest
Yêu cầu tạo một không gian có tên nhưng không có thành viên.
Trường | |
---|---|
space |
Bắt buộc. Bạn phải điền các trường Nếu bạn nhận được thông báo lỗi Không gian |
request_ |
Không bắt buộc. Giá trị nhận dạng duy nhất cho yêu cầu này. Bạn nên dùng UUID ngẫu nhiên. Việc chỉ định mã yêu cầu hiện có sẽ trả về không gian được tạo bằng mã đó thay vì tạo không gian mới. Việc chỉ định mã yêu cầu hiện có từ cùng một ứng dụng Chat với một người dùng đã xác thực khác sẽ trả về lỗi. |
CustomEmoji
Biểu thị một biểu tượng cảm xúc tuỳ chỉnh.
Trường | |
---|---|
name |
Giá trị nhận dạng. Tên tài nguyên của biểu tượng cảm xúc tuỳ chỉnh do máy chủ chỉ định. Định dạng |
uid |
Chỉ có đầu ra. Khoá duy nhất cho tài nguyên biểu tượng cảm xúc tuỳ chỉnh. |
emoji_ |
Không bắt buộc. Không thể thay đổi. Tên do người dùng cung cấp cho biểu tượng cảm xúc tuỳ chỉnh, tên này phải là duy nhất trong tổ chức. Bắt buộc khi tạo biểu tượng cảm xúc tuỳ chỉnh, nếu không thì chỉ xuất. Tên biểu tượng cảm xúc phải bắt đầu và kết thúc bằng dấu hai chấm, phải viết thường và chỉ được chứa các ký tự chữ và số, dấu gạch ngang và dấu gạch dưới. Bạn nên dùng dấu gạch ngang và dấu gạch dưới để phân tách các từ, nhưng không được dùng liên tiếp. Ví dụ: |
temporary_ |
Chỉ có đầu ra. URL hình ảnh của biểu tượng cảm xúc tuỳ chỉnh, có hiệu lực ít nhất 10 phút. Xin lưu ý rằng giá trị này không được điền vào nội dung phản hồi khi tạo biểu tượng cảm xúc tuỳ chỉnh. |
payload |
Không bắt buộc. Chỉ nhập. Dữ liệu tải trọng. Bắt buộc khi tạo biểu tượng cảm xúc tuỳ chỉnh. |
CustomEmojiPayload
Dữ liệu tải trọng cho biểu tượng cảm xúc tuỳ chỉnh.
Trường | |
---|---|
file_ |
Bắt buộc. Chỉ nhập. Hình ảnh dùng cho biểu tượng cảm xúc tuỳ chỉnh. Trọng tải phải dưới 256 KB và kích thước hình ảnh phải từ 64 đến 500 pixel. Các quy định hạn chế này có thể thay đổi. |
filename |
Bắt buộc. Chỉ nhập. Tên tệp hình ảnh. Đuôi tệp được hỗ trợ: |
DeleteCustomEmojiRequest
Yêu cầu xoá biểu tượng cảm xúc tuỳ chỉnh.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của biểu tượng cảm xúc tuỳ chỉnh cần xoá. Định dạng Bạn có thể sử dụng tên biểu tượng cảm xúc làm bí danh cho |
DeleteMembershipRequest
Yêu cầu xoá gói thành viên trong một không gian.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của gói thành viên cần xoá. Ứng dụng trò chuyện có thể xoá gói thành viên của người dùng hoặc của chính ứng dụng. Ứng dụng trò chuyện không thể xoá gói thành viên của các ứng dụng khác. Khi xoá gói thành viên của người dùng, bạn phải sử dụng phạm vi Khi xoá gói thành viên của ứng dụng, bạn phải có phạm vi Định dạng: |
use_ |
Không bắt buộc. Khi 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à cuộc trò chuyện trong không gian. Yêu cầu phạm vi OAuth 2.0 Bạn không thể xoá gói thành viên của ứng dụng trong một không gian bằng quyền quản trị. |
DeleteMessageRequest
Yêu cầu xoá thư.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của thông báo. Định dạng Nếu đã đặt mã nhận dạng tuỳ chỉnh cho thông báo, bạn có thể sử dụng giá trị trong trường |
force |
Không bắt buộc. Khi Chỉ áp dụng khi xác thực dưới dạng người dùng. Không có hiệu lực khi xác thực dưới dạng ứng dụng Chat. |
DeleteReactionRequest
Xoá một biểu tượng cảm xúc dành cho tin nhắn.
Trường | |
---|---|
name |
Bắt buộc. Tên của lượt thể hiện cảm xúc cần xoá. Định dạng |
DeleteSpaceRequest
Yêu cầu xoá không gian.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của không gian cần xoá. Định dạng |
use_ |
Không bắt buộc. Khi 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à cuộc trò chuyện trong không gian. Yêu cầu phạm vi OAuth 2.0 |
DeletionMetadata
Thông tin về một thư đã xoá. Tin nhắn sẽ bị xoá khi bạn đặt delete_time
.
Trường | |
---|---|
deletion_ |
Cho biết người đã xoá thư. |
DeletionType
Người đã xoá tin nhắn và cách xoá tin nhắn. Các giá trị khác có thể được thêm vào trong tương lai.
Enum | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Giá trị này không đượ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 đó. |
ADMIN |
Một quản trị viên Google Workspace đã xoá thư đó. |
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 |
Ứng dụng Chat đã xoá tin nhắn thay mặt cho người dùng. |
SPACE_OWNER_VIA_APP |
Một ứng dụng Chat đã thay mặt chủ sở hữu không gian xoá tin nhắn. |
Hộp thoại
Trình bao bọc xung quanh phần nội dung của thẻ trong hộp thoại.
Trường | |
---|---|
body |
Chỉ nhập. Nội dung của hộp thoại, được hiển thị ở chế độ phương thức. Ứng dụng Google Chat không hỗ trợ các thực thể thẻ sau: |
DialogAction
Chứa hộp thoại và mã trạng thái yêu cầu.
Trường | |
---|---|
action_ |
Chỉ nhập. Trạng thái của yêu cầu gọi hoặc gửi hộp thoại. Hiển thị 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 xảy ra lỗi hoặc thành công. |
Trường hợp hợp nhất action . Hành động cần thực hiện. action chỉ có thể là một trong những loại sau: |
|
dialog |
Chỉ nhập. Hộp thoại cho yêu cầu. |
DriveDataRef
Tham chiếu đến dữ liệu của tệp đính kèm trên Drive.
Trường | |
---|---|
drive_ |
Mã nhận dạng của tệp trên Drive. Sử dụng với API Drive. |
DriveLinkData
Dữ liệu cho các đường liên kết đến Google Drive.
Trường | |
---|---|
drive_ |
DriveDataRef tham chiếu đến một tệp trên Google Drive. |
mime_ |
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 dùng để thể hiện cảm xúc về một tin nhắn.
Trường | |
---|---|
Trường hợp hợp nhất content . Bắt buộc. Nội dung của biểu tượng cảm xúc. content chỉ có thể là một trong những loại sau: |
|
unicode |
Không bắt buộc. Biểu tượng cảm xúc cơ bản được biểu thị bằng một chuỗi unicode. |
custom_ |
Chỉ có đầu ra. Biểu tượng cảm xúc tuỳ chỉnh. |
EmojiReactionSummary
Số người đã thể hiện cảm xúc bằng một biểu tượng cảm xúc cụ thể đối với một tin nhắn.
Trường | |
---|---|
emoji |
Chỉ có đầu ra. Biểu tượng cảm xúc được liên kết với các lượt thể hiện cảm xúc. |
reaction_ |
Chỉ có đầu ra. 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 |
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: |
GetAttachmentRequest
Yêu cầu nhận tệp đính kèm.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của tệp đính kèm, ở dạng |
GetCustomEmojiRequest
Yêu cầu trả về một biểu tượng cảm xúc tuỳ chỉnh.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của biểu tượng cảm xúc tuỳ chỉnh. Định dạng Bạn có thể sử dụng tên biểu tượng cảm xúc làm bí danh cho |
GetMembershipRequest
Yêu cầu mua gói thành viên của một không gian.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của gói thành viên cần truy xuất. Để có gói thành viên của riêng ứng dụng bằng cách sử dụng tính năng xác thực người dùng, bạn có thể tuỳ ý sử dụng Định dạng: Bạn có thể sử dụng email của người dùng làm bí danh cho |
use_ |
Không bắt buộc. Khi 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à cuộc trò chuyện trong không gian. Yêu cầu phạm vi OAuth 2.0 Bạn không thể mua gói thành viên ứng dụng trong không gian khi sử dụng quyền quản trị. |
GetMessageRequest
Yêu cầu nhận tin nhắn.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của thông báo. Định dạng Nếu đã đặt mã nhận dạng tuỳ chỉnh cho thông báo, bạn có thể sử dụng giá trị trong trường |
GetSpaceEventRequest
Yêu cầu tin nhắn để nhận sự kiện trong không gian.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của sự kiện không gian. Định dạng |
GetSpaceNotificationSettingRequest
Yêu cầu thông báo để nhận chế độ cài đặt thông báo về không gian. Chỉ hỗ trợ nhận chế độ cài đặt thông báo cho người dùng gọi.
Trường | |
---|---|
name |
Bắt buộc. Định dạng: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
Thông báo yêu cầu cho API GetSpaceReadState.
Trường | |
---|---|
name |
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 đặt một trong những giá trị sau:
Định dạng: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Yêu cầu trả về một không gian.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của không gian, ở dạng Định dạng |
use_ |
Không bắt buộc. Khi 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à cuộc trò chuyện trong không gian. Yêu cầu phạm vi OAuth 2.0 |
GetThreadReadStateRequest
Thông báo yêu cầu cho API GetThreadReadStateRequest.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của trạng thái đọc luồng để 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 đặt một trong những giá trị sau:
Đị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 |
Tên tài nguyên cho một Google Group. Biểu thị một nhóm trong Cloud Identity Groups API. Định dạng: groups/{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ữ thư và chuỗi cuộc trò chuyện sau khi tạo.
Enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Giá trị mặc định. Không được dùng. |
HISTORY_OFF |
Nhật ký trò chuyện đang tắt. 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 sẽ chỉ định thời gian lưu giữ thư và chuỗi thư. |
ListCustomEmojisRequest
Yêu cầu trả về danh sách biểu tượng cảm xúc tuỳ chỉnh.
Trường | |
---|---|
page_ |
Không bắt buộc. Số lượng biểu tượng cảm xúc tuỳ chỉnh tối đa được trả về. Dịch vụ có thể trả về ít biểu tượng cảm xúc tuỳ chỉnh hơn giá trị này. Nếu không được 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_ |
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ừ lệnh gọi biểu tượng cảm xúc tuỳ chỉnh trong danh sách trước đó. Cung cấp giá trị 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 truyền một giá trị khác có thể dẫn đến kết quả không mong muốn. |
filter |
Không bắt buộc. Bộ lọc truy vấn. Hỗ trợ lọc theo nhà sáng tạo. Để lọc theo nhà sáng tạo, bạn phải chỉ định một giá trị hợp lệ. Hiện tại, chỉ Ví dụ: truy vấn sau đây trả về biểu tượng cảm xúc tuỳ chỉnh do phương thức gọi tạo:
Các truy vấn không hợp lệ sẽ bị máy chủ từ chối bằng lỗi |
ListCustomEmojisResponse
Phản hồi cho danh sách biểu tượng cảm xúc tuỳ chỉnh.
Trường | |
---|---|
custom_ |
Danh sách không theo thứ tự. Danh sách biểu tượng cảm xúc tuỳ chỉnh trong trang được yêu cầu (hoặc trang đầu tiên). |
next_ |
Một mã thông báo mà bạn có thể gửi dưới dạng |
ListMembershipsRequest
Thông báo yêu cầu đăng gói thành viên.
Trường | |
---|---|
parent |
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: spaces/{space} |
page_ |
Không bắt buộc. Số lượng gói thành viên tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu không chỉ định, hệ thống sẽ trả về 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ị đó sẽ tự động thay đổi thành 1000. Giá trị âm sẽ trả về lỗi |
page_ |
Không bắt buộc. Mã thông báo trang, nhận được từ lệnh gọi trước đó để liệt kê các gói thành viên. Cung cấp thông số này để truy xuất trang tiếp theo. Khi phân trang, tất cả các tham 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 truyền các giá trị khác nhau đến các tham số khác có thể dẫn đến kết quả không mong muốn. |
filter |
Không bắt buộc. Bộ lọc truy vấn. Bạn có thể lọc gói thành viên theo vai trò của thành viên ( Để lọc theo vai trò, hãy đặt Để lọc theo loại, hãy đặt Để lọc theo cả vai trò và loại, hãy sử dụng toán tử Bạn bắt buộc phải sử dụng Ví dụ: các truy vấn sau đây là hợp lệ:
Các cụm từ tìm kiếm sau đây không hợp lệ:
Các truy vấn không hợp lệ sẽ bị máy chủ từ chối bằng lỗi |
show_ |
Không bắt buộc. Khi |
show_ |
Không bắt buộc. Khi Hiện yêu cầu xác thực người dùng. |
use_ |
Không bắt buộc. Khi 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à cuộc trò chuyện trong không gian. Yêu cầu phạm vi OAuth 2.0 Bạn không thể đăng danh sách gói thành viên ứng dụng trong không gian khi sử dụng quyền quản trị. |
ListMembershipsResponse
Phản hồi để liệt kê các gói thành viên của không gian.
Trường | |
---|---|
memberships[] |
Danh sách không theo thứ tự. Danh sách gói thành viên trong trang được yêu cầu (hoặc trang đầu tiên). |
next_ |
Một mã thông báo mà bạn có thể gửi dưới dạng |
ListMessagesRequest
Liệt kê các tin nhắn trong không gian được chỉ định mà người dùng là thành viên.
Trường | |
---|---|
parent |
Bắt buộc. Tên tài nguyên của không gian để liệt kê tin nhắn. Định dạng |
page_ |
Không bắt buộc. Số lượng thư tối đa được trả về. Dịch vụ có thể trả về ít thông báo hơn giá trị này. Nếu không chỉ định, hệ thống sẽ trả về tối đa 25. Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị đó sẽ tự động thay đổi thành 1000. Giá trị âm sẽ trả về lỗi |
page_ |
Không bắt buộc. Mã thông báo trang nhận được từ lệnh gọi danh sách tin nhắn trước đó. Cung cấp thông số này để truy xuất trang tiếp theo. Khi phân trang, tất cả các tham 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 truyền các giá trị khác nhau đến các tham số khác có thể dẫn đến kết quả không mong muốn. |
filter |
Không bắt buộc. Bộ lọc truy vấn. Bạn có thể lọc tin nhắn theo ngày ( Để lọc thư theo ngày tạo, hãy chỉ định Để lọc theo chuỗi tin nhắn, hãy chỉ định Để lọc theo cả chuỗi tin nhắn và ngày, hãy sử dụng toán tử Ví dụ: các truy vấn sau đây là hợp lệ:
Các truy vấn không hợp lệ sẽ bị máy chủ từ chối bằng lỗi |
order_ |
Không bắt buộc. Cách sắp xếp danh sách thư. Chỉ định một giá trị để sắp xếp theo một toán tử sắp xếp. Sau đây là các giá trị hợp lệ cho toán tử sắp xếp:
Thứ tự mặc định là |
show_ |
Không bắt buộc. Liệu có bao gồm thư đã xoá hay không. Tin nhắn đã xoá bao gồm thời gian xoá và siêu dữ liệu về việc xoá, nhưng không có nội dung tin nhắn. |
ListMessagesResponse
Tin nhắn phản hồi cho tin nhắn đăng.
Trường | |
---|---|
messages[] |
Danh sách tin nhắn. |
next_ |
Bạn có thể gửi mã thông báo dưới dạng |
ListReactionsRequest
Liệt kê các lượt bày tỏ cảm xúc đối với một tin nhắn.
Trường | |
---|---|
parent |
Bắt buộc. Tin nhắn mà người dùng đã phản ứng. Định dạng |
page_ |
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 lượt bày tỏ cảm xúc hơn giá trị này. Nếu không được 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_ |
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ừ lệnh gọi phản ứng danh sách trước đó. Cung cấp giá trị 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 truyền một giá trị khác có thể dẫn đến kết quả không mong muốn. |
filter |
Không bắt buộc. Bộ lọc truy vấn. Bạn có thể lọc lượt thể hiện cảm xúc theo biểu tượng cảm xúc ( Để lọc các biểu tượng 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ử Để lọc các lượt phản ứng theo biểu tượng cảm xúc và người dùng, hãy sử dụng toán tử Nếu truy vấn của bạn sử dụng cả Ví dụ: các truy vấn sau đây là hợp lệ:
Các cụm từ tìm kiếm sau đây không hợp lệ:
Các truy vấn không hợp lệ sẽ bị máy chủ từ chối bằng lỗi |
ListReactionsResponse
Phản hồi cho yêu cầu danh sách lượt thể hiện cảm xúc.
Trường | |
---|---|
reactions[] |
Danh sách các lượt phản ứng trong trang được yêu cầu (hoặc trang đầu tiên). |
next_ |
Mã thông báo tiếp tục để truy xuất trang kết quả tiếp theo. Trường này sẽ trống đối với trang kết quả cuối cùng. |
ListSpaceEventsRequest
Thông báo yêu cầu đăng sự kiện trong không gian.
Trường | |
---|---|
parent |
Bắt buộc. Tên tài nguyên của phòng Google Chat nơi xảy ra sự kiện. Định dạng: |
page_ |
Không bắt buộc. Số lượng sự kiện không gian tối đa được trả về. Dịch vụ có thể trả về ít hơn giá trị này. Giá trị âm sẽ trả về lỗi |
page_ |
Không bắt buộc. 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 giá trị 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ê các sự kiện không gian phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc truyền các giá trị khác nhau đến các tham số khác có thể dẫn đến kết quả không mong muốn. |
filter |
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 ( Bạn cũng có thể lọc theo thời gian bắt đầ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í dụ: các truy vấn sau đây là hợp lệ:
Các cụm từ tìm kiếm sau đây không hợp lệ:
Các truy vấn không hợp lệ sẽ bị máy chủ từ chối bằng lỗi |
ListSpaceEventsResponse
Thông báo phản hồi để liệt kê các sự kiện trong không gian.
Trường | |
---|---|
space_ |
Kết quả được trả về theo thứ tự thời gian (sự kiện cũ nhất trước). Lưu ý: Trường |
next_ |
Mã thông báo tiếp tục dùng để tìm nạp thêm sự kiện. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo. |
ListSpacesRequest
Yêu cầu liệt kê các không gian mà phương thức gọi là thành viên.
Trường | |
---|---|
page_ |
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 không chỉ định, 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ị đó sẽ tự động thay đổi thành 1000. Giá trị âm sẽ trả về lỗi |
page_ |
Không bắt buộc. Mã thông báo trang, nhận được từ lệnh gọi danh sách không gian trước đó. Cung cấp thông 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 truyền một giá trị khác có thể dẫn đến kết quả không mong muốn. |
filter |
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 ( Để 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ư Ví dụ: các truy vấn sau đây là hợp lệ:
Các truy vấn không hợp lệ sẽ bị máy chủ từ chối bằng lỗi |
ListSpacesResponse
Phản hồi cho yêu cầu danh sách không gian.
Trường | |
---|---|
spaces[] |
Danh sách không gian trong trang được yêu cầu (hoặc trang đầu tiên). Lưu ý: Trường |
next_ |
Bạn có thể gửi mã thông báo dưới dạng |
MatchedUrl
URL được so khớp trong tin nhắn Chat. Ứng dụng trò chuyện có thể xem trước các URL được so khớp. Để biết thêm thông tin, hãy xem phần Xem trước đường liên kết.
Trường | |
---|---|
url |
Chỉ có đầu ra. URL đã được so khớp. |
Gói thành viên
Biểu thị mối quan hệ thành viên trong Google Chat, chẳng hạn như liệu người dùng hoặc ứng dụng Chat có được mời tham gia, có tham gia hay không tham gia không gian hay không.
Trường | |
---|---|
name |
Giá trị nhận dạng. Tên tài nguyên của gói thành viên do máy chủ chỉ định. Định dạng |
state |
Chỉ có đầu ra. Trạng thái của gói thành viên. |
role |
Không bắt buộc. Vai trò của người dùng trong một phòng Chat, vai trò này xác định những hành động mà người dùng được phép thực hiện trong phòng. Bạn chỉ có thể sử dụng trường này làm dữ liệu đầu vào trong |
create_ |
Không bắt buộc. Không thể thay đổi. Thời gian tạo gói thành viên, chẳng hạn như thời điểm một thành viên tham gia hoặc được mời tham gia không gian. Trường này chỉ xuất, ngoại trừ khi được dùng để nhập gói thành viên trước đây trong các không gian ở chế độ nhập. |
delete_ |
Không bắt buộc. Không thể thay đổi. Thời điểm xoá tư cách 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ỉ xuất, ngoại trừ khi được dùng để nhập gói thành viên trước đây trong các không gian ở chế độ nhập. |
Trường hợp hợp nhất memberType . Thành viên được 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ể được hỗ trợ trong tương lai. memberType chỉ có thể là một trong những loại sau: |
|
member |
Không bắt buộc. 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 dưới dạng người dùng, thì kết quả sẽ điền sẵn |
group_ |
Không bắt buộc. Nhóm Google tương ứng với gói thành viên. Bạn cần xác thực người dùng để đọc hoặc thay đổi thông tin thành viên của Google Groups. |
MembershipRole
Biểu thị các hành động được phép của người dùng trong một không gian Chat. Các giá trị enum khác có thể được thêm vào trong tương lai.
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 : các giá trị này 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 cuộc trò chuyện 1:1 và cuộc trò chuyện nhóm 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 các 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 tiểu bang 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 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 tham gia không gian đang chờ xử lý. |
MembershipBatchCreatedEventData
Trọng tải 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[] |
Danh sách các gói thành viên mới. |
MembershipBatchDeletedEventData
Trọng tải sự kiện cho nhiều gói thành viên đã bị xoá.
Loại sự kiện: google.workspace.chat.membership.v1.batchDeleted
Trường | |
---|---|
memberships[] |
Danh sách các gói thành viên đã bị xoá. |
MembershipBatchUpdatedEventData
Trọng tải 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[] |
Danh sách các gói thành viên đã cập nhật. |
MembershipCreatedEventData
Trọng tải sự kiện cho gói thành viên mới.
Loại sự kiện: google.workspace.chat.membership.v1.created
.
Trường | |
---|---|
membership |
Gói thành viên mới. |
MembershipDeletedEventData
Trọng tải sự kiện cho gói thành viên đã xoá.
Loại sự kiện: google.workspace.chat.membership.v1.deleted
Trường | |
---|---|
membership |
Gói thành viên đã bị xoá. Chỉ điền các trường |
MembershipUpdatedEventData
Trọng tải sự kiện cho gói thành viên đã cập nhật.
Loại sự kiện: google.workspace.chat.membership.v1.updated
Trường | |
---|---|
membership |
Gói thành viên đã cập nhật. |
Thông điệp
Tin nhắn trong phòng Google Chat.
Trường | |
---|---|
name |
Giá trị nhận dạng. Tên tài nguyên của thông báo. Định dạng Trong đó, Nếu đặt mã nhận dạng tuỳ chỉnh khi tạo thông báo, bạn có thể sử dụng mã nhận dạng này để chỉ định thông báo trong yêu cầu bằng cách thay thế |
sender |
Chỉ có đầu ra. Người dùng đã tạo thư. Nếu ứng dụng Chat xác thực dưới dạng người dùng, thì kết quả sẽ điền sẵn |
create_ |
Không bắt buộc. Không thể thay đổi. Đối với các không gian được tạo trong Chat, thời gian tạo tin nhắn. Trường này chỉ xuất, ngoại trừ khi được sử 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 trong quá khứ tại thời điểm tạo thông báo trong nguồn để giữ nguyên thời gian tạo ban đầu. |
last_ |
Chỉ có đầu ra. Thời gian người dùng chỉnh sửa thông báo gần đây nhất. Nếu chưa từng chỉnh sửa thư, trường này sẽ trống. |
delete_ |
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á, trường này sẽ trống. |
text |
Không bắt buộc. Nội dung thư ở dạng văn bản thuần tuý. Đường liên kết đầu tiên đến 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ể @thao tác nhắc đến một người dùng Google Chat hoặc mọi người trong không gian. Để tìm hiểu cách tạo tin nhắn văn bản, hãy xem bài viết Gửi tin nhắn. |
formatted_ |
Chỉ có đầu ra. Chứa thông báo
Để biết thêm thông tin, hãy xem phần Xem định dạng văn bản được gửi trong một thư |
cards[] |
Không dùng nữa: Hãy sử dụng Thẻ đa dạng thức, đượ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, chẳng hạn 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_ |
Không bắt buộc. Một mảng thẻ. Chỉ các ứng dụng Chat mới có thể tạo thẻ. Nếu ứng dụng Chat của bạn xác thực dưới dạng người dùng, thì tin nhắn không được chứa thẻ. Để tìm hiểu cách tạo tin nhắn chứa thẻ, hãy xem bài viết Gửi tin nhắn. Thiết kế và xem trước thẻ bằng Trình tạo thẻ. Mở Trình tạo thẻ |
annotations[] |
Chỉ có đầu ra. Chú thích liên kết với |
thread |
Chuỗi tin nhắn mà thư thuộc về. Để biết ví dụ về cách sử dụng, hãy xem phần Bắt đầu hoặc trả lời chuỗi tin nhắn. |
space |
Chỉ có đầu ra. Nếu ứng dụng Chat xác thực dưới dạng người dùng, thì kết quả chỉ điền vào không gian |
fallback_ |
Không bắt buộc. Nội dung mô tả bằng văn bản thuần tuý về các thẻ của thông báo, được dùng khi không thể hiển thị các thẻ thực tế (ví dụ: thông báo trên thiết bị di động). |
action_ |
Chỉ nhập. Các thông số mà ứng dụng Chat có thể sử dụng để định cấu hình cách đăng phản hồi. |
argument_ |
Chỉ có đầu ra. Nội dung tin nhắn ở dạng văn bản thuần tuý, trong đó xoá tất cả nội dung đề cập đến ứng dụng Chat. |
slash_ |
Chỉ có đầu ra. Thông tin về lệnh dấu gạch chéo, nếu có. |
attachment[] |
Không bắt buộc. Tệp đính kèm do người dùng tải lên. |
matched_ |
Chỉ có đầu ra. URL trong |
thread_ |
Chỉ có đầu ra. Khi Nếu không gian không hỗ trợ tính năng trả lời trong chuỗi tin nhắn, thì trường này luôn là |
client_ |
Không bắt buộc. Mã nhận dạng tuỳ chỉnh cho thông báo. Bạn có thể sử dụng trường để xác định một thư hoặc để nhận, xoá hoặc cập nhật thư. Để đặt mã nhận dạng tuỳ chỉnh, hãy chỉ định trường |
emoji_ |
Chỉ có đầu ra. Danh sách tóm tắt các biểu tượng cảm xúc phản ứng trên tin nhắn. |
private_ |
Không bắt buộc. Không thể thay đổi. 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 được đặt, tin nhắn sẽ ở chế độ riêng tư và chỉ người dùng được chỉ định và ứng dụng Chat mới thấy được. Để đưa trường này vào yêu cầu, bạn phải gọi API Chat bằng cách xác thực ứng dụng và bỏ qua những thông tin sau: Để biết thông tin chi tiết, hãy xem bài viết Gửi tin nhắn riêng tư. |
deletion_ |
Chỉ có đầu ra. Thông tin về một thư đã xoá. Tin nhắn sẽ bị xoá khi bạn đặt |
quoted_ |
Chỉ có đầu ra. Thông tin về một tin nhắn mà người dùng Google Chat trích dẫn trong phòng. Người dùng Google Chat có thể trích dẫn một tin nhắn để trả lời tin nhắn đó. |
attached_ |
Chỉ có đầu ra. Hình ảnh GIF được đính kèm vào thư. |
accessory_ |
Không bắt buộc. 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 thông báo 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 tin nhắn. Để tạo một tin nhắn có tiện ích phụ kiện, bạn cần xác thực ứng dụng. |
MessageBatchCreatedEventData
Trọng tải sự kiện cho nhiều thông báo mới.
Loại sự kiện: google.workspace.chat.message.v1.batchCreated
Trường | |
---|---|
messages[] |
Danh sách tin nhắn mới. |
MessageBatchDeletedEventData
Trọng tải sự kiện cho nhiều thư đã xoá.
Loại sự kiện: google.workspace.chat.message.v1.batchDeleted
Trường | |
---|---|
messages[] |
Danh sách thư đã xoá. |
MessageBatchUpdatedEventData
Trọng tải sự kiện cho nhiều thông báo đã cập nhật.
Loại sự kiện: google.workspace.chat.message.v1.batchUpdated
Trường | |
---|---|
messages[] |
Danh sách thông báo đã cập nhật. |
MessageCreatedEventData
Trọng tải sự kiện cho một thông báo mới.
Loại sự kiện: google.workspace.chat.message.v1.created
Trường | |
---|---|
message |
Tin nhắn mới. |
MessageDeletedEventData
Trọng tải sự kiện cho một thư đã xoá.
Loại sự kiện: google.workspace.chat.message.v1.deleted
Trường | |
---|---|
message |
Tin nhắn đã xoá. Chỉ điền sẵn các trường |
MessageUpdatedEventData
Trọng tải sự kiện cho thông báo đã cập nhật.
Loại sự kiện: google.workspace.chat.message.v1.updated
Trường | |
---|---|
message |
Tin nhắn đã cập nhật. |
QuotedMessageMetadata
Thông tin về một tin nhắn được trích dẫn.
Trường | |
---|---|
name |
Chỉ có đầu ra. Tên tài nguyên của thư được trích dẫn. Định dạng |
last_ |
Chỉ có đầu ra. Dấu thời gian khi thư được trích dẫn được tạo hoặc khi thư được trích dẫn được cập nhật gần đây nhất. |
Video phản ứng
Biểu tượng cảm xúc dành cho tin nhắn.
Trường | |
---|---|
name |
Giá trị nhận dạng. Tên tài nguyên của phản ứng. Định dạng |
user |
Chỉ có đầu ra. Người dùng đã tạo biểu tượng cảm xúc. |
emoji |
Bắt buộc. Biểu tượng cảm xúc được dùng trong lượt phản ứng. |
ReactionBatchCreatedEventData
Trọng tải sự kiện cho nhiều lượt bày tỏ cảm xúc mới.
Loại sự kiện: google.workspace.chat.reaction.v1.batchCreated
Trường | |
---|---|
reactions[] |
Danh sách các biểu tượng bày tỏ cảm xúc mới. |
ReactionBatchDeletedEventData
Trọng tải sự kiện cho nhiều lượt thể hiện cảm xúc đã xoá.
Loại sự kiện: google.workspace.chat.reaction.v1.batchDeleted
Trường | |
---|---|
reactions[] |
Danh sách các lượt bày tỏ cảm xúc đã xoá. |
ReactionCreatedEventData
Trọng tải sự kiện cho một lượt bày tỏ cảm xúc mới.
Loại sự kiện: google.workspace.chat.reaction.v1.created
Trường | |
---|---|
reaction |
Phản ứng mới. |
ReactionDeletedEventData
Trọng tải sự kiện cho một lượt thể hiện cảm xúc đã bị xoá.
Loại: google.workspace.chat.reaction.v1.deleted
Trường | |
---|---|
reaction |
Phản ứng đã bị xoá. |
RichLinkMetadata
Đường liên kết đa dạng thức đến một tài nguyên.
Trường | |
---|---|
uri |
URI của đường liên kết này. |
rich_ |
Loại đường liên kết đa dạng thức. |
Trường hợp hợp nhất data . Dữ liệu cho tài nguyên được liên kết. data chỉ có thể là một trong những loại sau: |
|
drive_ |
Dữ liệu cho đường liên kết đến Drive. |
chat_ |
Dữ liệu về đường liên kết đến phòng Chat. |
RichLinkType
Loại đường liên kết đa dạng thức. Các loại khác có thể được thêm vào trong tương lai.
Enum | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Giá trị mặc định cho enum. Không sử dụng. |
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 trong phòng Chat. Ví dụ: khối thông minh cho không gian. |
SearchSpacesRequest
Yêu cầu tìm kiếm danh sách không gian dựa trên một truy vấn.
Trường | |
---|---|
use_ |
Khi 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à cuộc trò chuyện trong không gian. Yêu cầu phạm vi OAuth 2.0 Phương thức này hiện chỉ hỗ trợ quyền quản trị, do đó, chỉ |
page_ |
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 không chỉ định, 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ị đó sẽ tự động thay đổi thành 1000. |
page_ |
Một 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 thông số này để truy xuất trang tiếp theo. Khi phân trang, tất cả các tham 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 truyền các giá trị khác nhau đến các tham số khác có thể dẫn đến kết quả không mong muốn. |
query |
Bắt buộc. Cụm từ tìm kiếm. Bạn có thể tìm kiếm bằng các tham số sau:
Trên các trường khác nhau, chỉ toán tử Trong cùng một trường, Các truy vấn mẫu sau đây là hợp lệ:
|
order_ |
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:
Các giá trị hợp lệ của toán tử sắp xếp là:
Cú pháp được hỗ trợ là:
|
SearchSpacesResponse
Phản hồi bằng danh sách không gian tương ứng với yêu cầu tìm kiếm không gian.
Trường | |
---|---|
spaces[] |
Trang của các không gian được yêu cầu. |
next_ |
Mã thông báo có thể 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_ |
Tổng số không gian khớp với cụm từ tìm kiếm trên tất cả các trang. Nếu kết quả là hơn 10.000 khoảng trắng, thì giá trị này là giá trị ước tính. |
SetUpSpaceRequest
Yêu cầu tạo không gian và thêm những người dùng được chỉ định vào không gian đó.
Trường | |
---|---|
space |
Bắt buộc. Trường Để tạo một không gian, hãy đặt Để tạo cuộc trò chuyện nhóm, hãy đặt Để tạo cuộc trò chuyện 1:1 giữa con người, hãy đặt Để tạo cuộc trò chuyện 1:1 giữa người dùng và ứng dụng Chat đang gọi, hãy đặt Nếu không gian |
request_ |
Không bắt buộc. Giá trị nhận dạng duy nhất cho yêu cầu này. Bạn nên dùng UUID ngẫu nhiên. Việc chỉ định mã yêu cầu hiện có sẽ trả về không gian được tạo bằng mã đó thay vì tạo không gian mới. Việc chỉ định mã yêu cầu hiện có từ cùng một ứng dụng Chat với một người dùng đã xác thực khác sẽ trả về lỗi. |
memberships[] |
Không bắt buộc. Người dùng hoặc nhóm trên Google Chat mà bạn muốn mời tham gia không gian. Bỏ qua người dùng gọi vì họ được thêm tự động. Tập hợp này hiện cho phép tối đa 20 gói thành viên (ngoài người gọi). Đối với gói thành viên dành cho con người, trường Đối với tư cách thành viên nhóm trên Google, trường Không bắt buộc khi đặt Bắt buộc khi đặt Bắt buộc khi đặt Phải để trống khi tạo cuộc trò chuyện 1:1 giữa người dùng và ứng dụng Chat gọi (khi đặt |
SlashCommand
Lệnh dấu gạch chéo trong Google Chat.
Trường | |
---|---|
command_ |
Mã của lệnh gạch chéo được gọi. |
SlashCommandMetadata
Siêu dữ liệu chú thích cho lệnh dấu gạch chéo (/).
Trường | |
---|---|
bot |
Ứng dụng Chat có lệnh được gọi. |
type |
Loại lệnh dấu gạch chéo. |
command_ |
Tên của lệnh dấu gạch chéo đã gọi. |
command_ |
Mã lệnh của lệnh dấu gạch chéo đã gọi. |
triggers_ |
Cho biết liệu 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 cho 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à 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à ứng dụng Chat.
Trường | |
---|---|
name |
Giá trị nhận dạng. Tên tài nguyên của không gian. Định dạng Trong đó |
type |
Chỉ có đầu ra. Không dùng nữa: Hãy sử dụng |
space_ |
Không bắt buộc. 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. Chỉ có đầu ra cho các mục đích sử dụng khác. |
single_ |
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 dùng hay không. |
threaded |
Chỉ có đầu ra. Không dùng nữa: Hãy sử dụng |
display_ |
Không bắt buộc. Tên hiển thị của không gian. Bắt buộc khi tạo không gian với Đố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_ |
Không bắt buộc. Không thể thay đổi. Không gian này có cho phép người dùng Google Chat nào làm thành viên hay không. Thông tin đầu vào khi tạo không gian trong một tổ chức Google Workspace. Bỏ qua trường này khi tạo không gian trong các điều kiện sau:
Đối với các không gian hiện có, trường này chỉ có đầu ra. |
space_ |
Chỉ có đầu ra. Trạng thái tạo chuỗi tin nhắn trong không gian Chat. |
space_ |
Không bắt buộc. Thông tin chi tiết về không gian, bao gồm nội dung mô tả và quy tắc. |
space_ |
Không bắt buộc. Trạng thái nhật ký tin nhắn cho các tin nhắn và chuỗi tin nhắn trong không gian này. |
import_ |
Không bắt buộc. Liệu không gian này có được tạo trong Bạn cần xác thực người dùng để tạo không gian trong |
create_ |
Không bắt buộc. Không thể thay đổi. Đối với những không gian được tạo trong Chat, thời gian tạo không gian. Trường này chỉ xuất, ngoại trừ khi được sử dụng trong các 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 tại thời điểm không gian được tạo trong nguồn để giữ nguyên thời gian tạo ban đầu. Chỉ được điền sẵn trong kết quả khi |
last_ |
Chỉ có đầu ra. Dấu thời gian của tin nhắn gần đây nhất trong không gian. |
admin_ |
Chỉ có đầu ra. Đối với không gian tin nhắn trực tiếp (DM) có ứng dụng Chat, liệu 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 tính năng tin nhắn trực tiếp bằng một ứng dụng Chat. Để hỗ trợ tính năng cài đặt cho 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_ |
Chỉ có đầu ra. Số lượng gói thành viên đã tham gia được nhóm theo loại thành viên. Được điền khi |
access_ |
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 sẵn khi |
space_ |
Chỉ có đầu ra. URI để người dùng truy cập vào không gian. |
import_ |
Chỉ có đầu ra. Thời điểm hệ thống tự động xoá không gian nếu không gian đó vẫn ở chế độ nhập. Mỗi không gian được tạo ở chế độ nhập phải thoát khỏi chế độ này trước thời gian hết hạn bằng cách sử dụng Trường này chỉ được điền sẵn cho những không gian được tạo bằng chế độ nhập. |
customer |
Không bắt buộc. Không thể thay đổi. Mã khách hàng của miền của không gian. Chỉ bắt buộc khi tạo không gian có xác thực ứng dụng và Ở định dạng Đối với tin nhắn trực tiếp, trường này không được điền sẵn. |
Trường hợp hợp nhất Yêu cầu xác thực người dùng. |
|
predefined_ |
Không bắt buộc. Chỉ nhập. Chế độ cài đặt quyền cho không gian được xác định trước, chỉ nhập khi tạo không gian. Nếu bạn không đặt trường này, hệ thống sẽ tạo một không gian cộng tác. Sau khi bạn tạo không gian, các chế độ cài đặt sẽ được điền sẵn trong trường |
permission_ |
Không bắt buộc. Chế độ cài đặt quyền đối với không gian cho các không gian hiện có. Dữ liệu đầu vào để cập nhật chế độ cài đặt quyền chính xác cho không gian, trong đó chế độ cài đặt quyền hiện tại sẽ được thay thế. Kết quả sẽ liệt kê các chế độ cài đặt quyền hiện tại. |
AccessSettings
Biểu thị chế độ cài đặt quyền truy cập của không gian.
Trường | |
---|---|
access_ |
Chỉ có đầu ra. Cho biết trạng thái truy cập của không gian. |
audience |
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ế độ này, thì chỉ những người dùng hoặc Nhóm Google được mời riêng lẻ hoặc được thêm 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 Để đối tượng mục tiêu tìm thấy không gian. Định dạng Để sử dụng đối tượng mục tiêu mặc định cho tổ chức Google Workspace, hãy đặt thành Việc đọc đối tượng mục tiêu hỗ trợ:
Trường này không được điền khi sử dụng phạm vi Bạn cần xác thực người dùng để thiết lập đối tượng mục tiêu. |
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 Google mà người dùng khác hoặc quản trị viên Google Workspace đã thêm hoặc mời riêng lẻ 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 đố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 Google đã được thêm hoặc mời vào không gian theo từng cá nhân 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 Để người dùng cụ thể tìm thấy không gian. Bạn cần xác thực người dùng để tạo không gian mở. |
MembershipCount
Biểu thị số lượng gói thành viên của một không gian, được nhóm thành các danh mục.
Trường | |
---|---|
joined_ |
Chỉ có đầu ra. Số người dùng đã trực tiếp tham gia không gian, không tính những người dùng tham gia bằng cách có tư cách thành viên trong một nhóm đã tham gia. |
joined_ |
Chỉ có đầu ra. Số lượng tất cả các nhóm đã trực tiếp tham gia không gian. |
PermissionSetting
Biểu thị chế độ cài đặt quyền trong không gian.
Trường | |
---|---|
managers_ |
Không bắt buộc. Liệu người quản lý không gian có quyền này hay không. |
members_ |
Không bắt buộc. Liệu các thành viên không phải người quản lý có quyền này hay không. |
PermissionSettings
Chế độ cài đặt quyền mà bạn có thể chỉ định khi cập nhật một không gian có tên hiện có.
Để đặt 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_ |
Không bắt buộc. Chế độ cài đặt để quản lý thành viên và nhóm trong một không gian. |
modify_ |
Không bắt buộc. 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_ |
Không bắt buộc. Chế độ cài đặt để bật và tắt nhật ký của không gian. |
use_ |
Không bắt buộc. Chế độ cài đặt để sử dụng @tất_cả trong không gian. |
manage_ |
Không bắt buộc. Chế độ cài đặt để quản lý ứng dụng trong một không gian. |
manage_ |
Không bắt buộc. Chế độ cài đặt để quản lý webhook trong không gian. |
post_ |
Chỉ có đầu ra. Chế độ cài đặt để đăng tin nhắn trong không gian. |
reply_ |
Không bắt buộc. Chế độ cài đặt để trả lời tin nhắn trong không gian. |
PredefinedPermissionSettings
Chế độ cài đặt quyền được xác định trước mà bạn chỉ có thể chỉ định khi tạo không gian có tên. Các chế độ cài đặt khác có thể sẽ được thêm vào trong tương lai. Để biết thông tin chi tiết về chế độ cài đặt quyền cho không gian có 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, nơi tất cả thành viên đều có thể đăng tin nhắn. |
ANNOUNCEMENT_SPACE |
Chế độ cài đặt để biế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 nội dung mô tả và quy tắc.
Trường | |
---|---|
description |
Không bắt buộc. Nội dung mô tả về không gian. Ví dụ: mô tả chủ đề thảo luận, mục đích chức năng hoặc người tham gia của không gian. Hỗ trợ tối đa 150 ký tự. |
guidelines |
Không bắt buộc. Quy tắc, kỳ vọng và quy tắc ứng xử của không gian. Hỗ trợ tối đa 5.000 ký tự. |
SpaceThreadingState
Chỉ định loại trạng thái tạo chuỗi tin nhắn trong không gian Chat.
Enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Đã đặt trước. |
THREADED_MESSAGES |
Không gian được đặt tên hỗ trợ chuỗi tin nhắn. Khi phản hồi một tin nhắn, người dùng có thể trả lời trong chuỗi tin nhắn để phản hồi của họ nằm trong ngữ cảnh của tin nhắn ban đầu. |
GROUPED_MESSAGES |
Không gian có 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 chủ đề được nhóm lại với nhau. |
UNTHREADED_MESSAGES |
Tin nhắn trực tiếp (DM) giữa hai 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 các 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 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 Chat. |
DIRECT_MESSAGE |
Tin nhắn 1:1 giữa hai người hoặc giữa một người và ứng dụng Chat. |
Loại
Không dùng nữa: Hãy sử 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 phẳng. 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
Trọng tải sự kiện cho nhiều nội dung cập nhật đối với một không gian.
Loại sự kiện: google.workspace.chat.space.v1.batchUpdated
Trường | |
---|---|
spaces[] |
Danh sách các không gian đã cập nhật. |
SpaceEvent
Một sự kiện đại diện cho một thay đổi hoặc hoạt động trong không gian trên 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 |
Tên tài nguyên của sự kiện không gian. Định dạng |
event_ |
Thời gian xảy ra sự kiện. |
event_ |
Loại sự kiện trong không gian. Mỗi loại sự kiện đều có một phiên bản theo lô, đại diện cho nhiều thực thể 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 Các loại sự kiện được hỗ trợ cho tin nhắn:
Các loại sự kiện được hỗ trợ cho gói thành viên:
Các loại sự kiện được hỗ trợ cho biểu tượng cảm xúc:
Các loại sự kiện được hỗ trợ về không gian:
|
Trường hợp hợp nhất
|
|
message_ |
Trọng tải sự kiện cho một thông báo mới. Loại sự kiện: |
message_ |
Trọng tải sự kiện cho thông báo đã cập nhật. Loại sự kiện: |
message_ |
Trọng tải sự kiện cho một thư đã xoá. Loại sự kiện: |
message_ |
Trọng tải sự kiện cho nhiều thông báo mới. Loại sự kiện: |
message_ |
Trọng tải sự kiện cho nhiều thông báo đã cập nhật. Loại sự kiện: |
message_ |
Trọng tải sự kiện cho nhiều thư đã xoá. Loại sự kiện: |
space_ |
Trọng tải sự kiện cho nội dung cập nhật không gian. Loại sự kiện: |
space_ |
Trọng tải sự kiện cho nhiều nội dung cập nhật đối với một không gian. Loại sự kiện: |
membership_ |
Trọng tải sự kiện cho gói thành viên mới. Loại sự kiện: |
membership_ |
Trọng tải sự kiện cho gói thành viên đã cập nhật. Loại sự kiện: |
membership_ |
Trọng tải sự kiện cho gói thành viên đã xoá. Loại sự kiện: |
membership_ |
Trọng tải sự kiện cho nhiều gói thành viên mới. Loại sự kiện: |
membership_ |
Trọng tải sự kiện cho nhiều gói thành viên đã cập nhật. Loại sự kiện: |
membership_ |
Trọng tải sự kiện cho nhiều gói thành viên đã bị xoá. Loại sự kiện: |
reaction_ |
Trọng tải sự kiện cho một lượt bày tỏ cảm xúc mới. Loại sự kiện: |
reaction_ |
Trọng tải sự kiện cho một lượt thể hiện cảm xúc đã bị xoá. Loại sự kiện: |
reaction_ |
Trọng tải sự kiện cho nhiều lượt bày tỏ cảm xúc mới. Loại sự kiện: |
reaction_ |
Trọng tải sự kiện cho nhiều lượt thể hiện cảm xúc đã xoá. Loại sự kiện: |
SpaceNotificationSetting
Chế độ cài đặt thông báo của một người dùng trong không gian.
Trường | |
---|---|
name |
Giá trị nhận dạng. Tên tài nguyên của chế độ cài đặt thông báo của không gian. Định dạng: |
notification_ |
Chế độ cài đặt thông báo. |
mute_ |
Chế độ cài đặt tắt thông báo của không gian. |
MuteSetting
Các loại chế độ cài đặt tắt thông báo của không gian.
Enum | |
---|---|
MUTE_SETTING_UNSPECIFIED |
Đã đặt trước. |
UNMUTED |
Người dùng sẽ nhận được thông báo về không gian dựa trên chế độ cài đặt thông báo. |
MUTED |
Người dùng sẽ không nhận được thông báo nào về không gian đó, bất kể chế độ cài đặt thông báo. |
NotificationSetting
Các loại chế độ cài đặt thông báo.
Enum | |
---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
Đã đặt trước. |
ALL |
Thông báo được kích hoạt bằng lượt đề cập bằng @, chuỗi tin nhắn bạn theo dõi, tin nhắn đầu tiên của chuỗi tin nhắn mới. Tất cả chuỗi tin nhắn mới đều được tự động theo dõi, trừ phi người dùng bỏ theo dõi theo cách thủ công. |
MAIN_CONVERSATIONS |
Thông báo này được kích hoạt bởi các lượt đề cập bằng @, chuỗi tin nhắn bạn theo dõi, tin nhắn đầu tiên của chuỗi tin nhắn mới. Không áp dụng cho tin nhắn trực tiếp 1:1. |
FOR_YOU |
Thông báo này được kích hoạt bởi lượt đề cập bằng @và chuỗi tin nhắn bạn theo dõi. Không áp dụng cho tin nhắn trực tiếp 1:1. |
OFF |
Thông báo đang tắt. |
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 |
Tên tài nguyên của trạng thái đọc không gian. Định dạng |
last_ |
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 thư đã đọ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
Trọng tải 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 |
Không gian đã cập nhật. |
Chuỗi hội thoại
Một chuỗi tin nhắn trong không gian trên 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 chuỗi tin nhắn.
Nếu chỉ định một chuỗi tin nhắn khi tạo thư, bạn có thể đặt trường messageReplyOption
để xác định điều gì sẽ xảy ra nếu không tìm thấy chuỗi tin nhắn nào khớp.
Trường | |
---|---|
name |
Giá trị nhận dạng. Tên tài nguyên của luồng. Ví dụ: |
thread_ |
Không bắt buộc. Dữ liệu đầu vào để tạo hoặc cập nhật luồng. Nếu không, chỉ có đầu ra. Mã nhận dạng của luồng. Hỗ trợ tối đa 4.000 ký tự. Mã này là duy nhất đối với ứng dụng Chat đã đặt mã đó. Ví dụ: nếu nhiều ứng dụng Chat tạo một tin nhắn bằng cùng một khoá chuỗi, thì các tin nhắn đó sẽ được đăng trong các chuỗi khác nhau. Để trả lời trong một chuỗi tin nhắn do một người hoặc một ứng dụng Chat khác tạo, hãy chỉ định trường |
ThreadReadState
Trạng thái đọc của người dùng trong một chuỗi tin nhắn, dùng để xác định thư đã đọc và chưa đọc.
Trường | |
---|---|
name |
Tên tài nguyên của trạng thái đọc luồng. Định dạng |
last_ |
Thời gian cập nhật trạng thái đọc luồng 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 trong một chuỗi tin nhắn. |
UpdateMembershipRequest
Thông báo yêu cầu cập nhật gói thành viên.
Trường | |
---|---|
membership |
Bắt buộc. Gói thành viên cần cập nhật. Chỉ những trường do |
update_ |
Bắt buộc. Đường dẫn trường cần cập nhật. Phân tách nhiều giá trị bằng dấu phẩy hoặc sử dụng Các đường dẫn trường hiện được hỗ trợ:
|
use_ |
Không bắt buộc. Khi 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à cuộc trò chuyện trong không gian. Yêu cầu phạm vi OAuth 2.0 |
UpdateMessageRequest
Yêu cầu cập nhật thông báo.
Trường | |
---|---|
message |
Bắt buộc. Tin nhắn có các trường đã cập nhật. |
update_ |
Bắt buộc. Đường dẫn trường cần cập nhật. Phân tách nhiều giá trị bằng dấu phẩy hoặc sử dụng Các đường dẫn trường hiện được hỗ trợ:
|
allow_ |
Không bắt buộc. Nếu không tìm thấy |
UpdateSpaceNotificationSettingRequest
Yêu cầu cập nhật chế độ cài đặt thông báo về không gian. Chỉ hỗ trợ cập nhật chế độ cài đặt thông báo cho người dùng gọi.
Trường | |
---|---|
space_ |
Bắt buộc. Bạn phải điền tên tài nguyên cho chế độ cài đặt thông báo của không gian ở dạng |
update_ |
Bắt buộc. Đường dẫn trường được hỗ trợ: – |
UpdateSpaceReadStateRequest
Thông báo yêu cầu cho API UpdateSpaceReadState.
Trường | |
---|---|
space_ |
Bắt buộc. Trạng thái đọc không gian 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 đặt một trong những giá trị sau:
Định dạng: users/{user}/spaces/{space}/spaceReadState |
update_ |
Bắt buộc. Đường dẫn trường cần cập nhật. Các đường dẫn trường hiện được hỗ trợ:
Khi Để đánh dấu không gian là đã đọc, hãy đặt |
UpdateSpaceRequest
Yêu cầu cập nhật một không gian.
Trường | |
---|---|
space |
Bắt buộc. Không gian có các trường cần cập nhật. |
update_ |
Bắt buộ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:
|
use_ |
Không bắt buộc. Khi 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à cuộc trò chuyện trong không gian. Yêu cầu phạm vi OAuth 2.0 Một số giá trị |
Người dùng
Một người dùng trong Google Chat. Khi được trả về dưới dạng đầu ra của một yêu cầu, nếu ứng dụng Chat xác thực dưới dạng người dùng, thì đầu ra cho tài nguyên User
sẽ chỉ điền sẵn name
và type
của người dùng.
Trường | |
---|---|
name |
Tên tài nguyên cho Định dạng: Đối với
|
display_ |
Chỉ có đầu ra. Tên hiển thị của người dùng. |
domain_ |
Giá trị nhận dạng duy nhất của miền Google Workspace của người dùng. |
type |
Loại người dùng. |
is_ |
Chỉ có đầu ra. Khi |
Loại
Enum | |
---|---|
TYPE_UNSPECIFIED |
Giá trị mặc định cho enum. KHÔNG SỬ DỤNG. |
HUMAN |
Người dùng là con người. |
BOT |
Người dùng ứng dụng Chat. |
UserMentionMetadata
Siêu dữ liệu chú thích cho các lượt đề cập đến người dùng (@).
Trường | |
---|---|
user |
Người dùng được đề cập. |
type |
Loại lượt đề cập đến người dùng. |
Loại
Enum | |
---|---|
TYPE_UNSPECIFIED |
Giá trị mặc định cho 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 hiển thị văn bản và hình ảnh.
Trường | |
---|---|
buttons[] |
Danh sách các nút. Nút cũng là |
Trường hợp hợp nhất data . WidgetMarkup chỉ có thể có một trong các mục sau. Bạn có thể sử dụng nhiều trường WidgetMarkup để hiển thị thêm các mục. data chỉ có thể là một trong những giá trị sau: |
|
text_ |
Hiển thị một đoạn văn bản trong tiện ích này. |
image |
Hiển thị hình ảnh trong tiện ích này. |
key_ |
Hiển thị một mục giá trị khoá 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 hợp hợp nhất
|
|
text_ |
Một nút có văn bản và thao tác |
image_ |
Một nút có hình ảnh và thao tác |
FormAction
Hành động trong 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_ |
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 phản hồi lại cho ứng dụng Chat trong sự kiện nhấp vào 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 một hành vi phổ biến. |
parameters[] |
Danh sách tham số hành động. |
ActionParameter
Danh sách 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 hẹn giờ: hẹn giờ ngay, hẹn giờ 1 ngày, hẹn giờ vào tuần tới. Bạn có thể sử dụng action method = snooze()
, truyền loại báo thức và thời gian báo thức trong danh sách tham số chuỗi.
Trường | |
---|---|
key |
Tên của thông số cho tập lệnh hành động. |
value |
Giá trị của tham số. |
Biểu tượng
Tập hợp các 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 |
Hình ảnh
Hình ảnh được chỉ định bằng URL và có thể có thao tác onclick
.
Trường | |
---|---|
image_ |
URL của hình ảnh. |
on_ |
Thao tác |
aspect_ |
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ờ hình ảnh tải. Tỷ lệ khung hình này không được ghi đè tỷ lệ khung hình tích hợp sẵn của hình ảnh. Nếu bạn không đặt, máy chủ sẽ điền giá trị này bằng cách tìm nạp trước hình ảnh. |
ImageButton
Nút hình ảnh có thao tác onclick
.
Trường | |
---|---|
on_ |
Thao tác |
name |
Tên của |
Trường hợp hợp nhất icons . Bạn có thể chỉ định biểu tượng bằng Icon enum hoặc URL. icons chỉ có thể là một trong những giá trị sau: |
|
icon |
Biểu tượng do |
icon_ |
Biểu tượng được chỉ định bằng một URL. |
KeyValue
Một thành phần trên giao diện người dùng chứa một khoá (nhãn) và một 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_ |
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ề cách định dạng văn bản, hãy xem bài viết Định dạng văn bản trong ứng dụng Google Chat và Định dạng văn bản trong tiện ích bổ sung của Google Workspace. |
content |
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ề cách định dạng văn bản, hãy xem bài viết Định dạng văn bản trong ứng dụng Google Chat và Định dạng văn bản trong tiện ích bổ sung của Google Workspace. |
content_ |
Nội dung có phải là nhiều dòng hay không. |
bottom_ |
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ề cách định dạng văn bản, hãy xem bài viết Định dạng văn bản trong ứng dụng Google Chat và Định dạng văn bản trong tiện ích bổ sung của Google Workspace. |
on_ |
Thao tác |
Trường hợp hợp nhất 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 loại sau: |
|
icon |
Giá trị enum được Chat API thay thế bằng hình ảnh biểu tượng tương ứng. |
icon_ |
Biểu tượng được chỉ định bằng một URL. |
Trường hợp hợp nhất control . Một tiện ích điều khiển. Bạn có thể đặt button hoặc switch_widget , nhưng không được đặt cả hai. control chỉ có thể là một trong những loại sau: |
|
button |
Một nút 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ở đường liên kết).
Trường | |
---|---|
Trường hợp hợp nhất
|
|
action |
Hành động |
open_ |
Thao tác |
OpenLink
Đường liên kết mở ra một cửa sổ mới.
Trường | |
---|---|
url |
URL cần mở. |
TextButton
Một nút có văn bản và thao tác onclick
.
Trường | |
---|---|
text |
Văn bản của nút. |
on_ |
Thao tác |
TextParagraph
Một đoạn văn bản. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về cách định dạng văn bản, hãy xem bài viết Định dạng văn bản trong ứng dụng Google Chat và Định dạng văn bản trong tiện ích bổ sung của Google Workspace.
Trường | |
---|---|
text |
|