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)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)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)GetMembershipRequest
(thông báo)GetMessageRequest
(thông báo)GetSpaceEventRequest
(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)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)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)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 xây dựng các ứng dụng và dịch vụ tích hợp trong Chat trên Nền tảng Google Chat.
CompleteImportSpace |
---|
Hoàn tất quy trình nhập không gian được chỉ định và hiển thị không gian đó cho người dùng. Yêu cầu xác thực ứng dụng và uỷ quyền trên toàn miền. Để biết thêm thông tin, hãy xem bài viết Cho phép ứng dụng Google Chat nhập dữ liệu.
|
CreateMembership |
---|
Tạo một gói thành viên cho ứng dụng gọi điện trong Chat, một người dùng hoặc một nhóm trên Google Groups. Không hỗ trợ tạo gói thành viên cho các ứng dụng khác trong Chat. Khi tạo thành viên, nếu thành viên được chỉ định đã tắt chính sách tự động chấp nhận, thì họ sẽ được mời và phải chấp nhận lời mời tham gia không gian. Nếu không, khi tạo một thành viên, thành viên đó sẽ được thêm trực tiếp vào không gian được chỉ định. Yêu cầu xác thực người dùng. Để biết ví dụ về cách sử dụng, hãy xem:
|
CreateMessage |
---|
Tạo tin nhắn trong phòng 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ổ một tin nhắn khi bạn 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 tin nhắn có thể chứa văn bản ( Hình ảnh sau đây cho thấy cách Chat phân bổ 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 tin nhắn là ứng dụng Chat bằng cách cho thấy tên của ứng dụng. Nội dung tin nhắn 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 lượt thể hiện cảm xúc rồi thêm vào một tin nhắn. Chỉ hỗ trợ biểu tượng cảm xúc Unicode. Để xem ví dụ, hãy xem bài viết Thêm biểu tượng cảm xúc vào tin nhắn. Yêu cầu xác thực người dùng.
|
CreateSpace |
---|
Tạo một không gian được đặt tên. Không hỗ trợ không gian được nhóm theo chủ đề. Để biết ví dụ, hãy xem phần Tạo không gian. Nếu bạn nhận được thông báo lỗi Yêu cầu xác thực người dùng.
|
DeleteMembership |
---|
Xoá gói thành viên. Ví dụ: xem phần Xoá người dùng hoặc ứng dụng Google Chat khỏi một không gian. Yêu cầu xác thực người dùng.
|
DeleteMessage |
---|
Xoá tin nhắn. Để xem ví dụ, hãy xem phần Xoá thư. Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng. Khi sử dụng phương thức xác thực ứng dụng, các yêu cầu chỉ có thể xoá tin nhắn do ứng dụng gọi điện tạo trong Chat.
|
DeleteReaction |
---|
Xoá lượt thể hiện cảm xúc với một tin nhắn. Chỉ hỗ trợ biểu tượng cảm xúc Unicode. Để biết ví dụ, hãy xem bài viết Xoá một lượt thể hiện cảm xúc. Yêu cầu xác thực người dùng.
|
DeleteSpace |
---|
Xoá một không gian đã đặt tên. Luôn xoá theo tầng, tức là tài nguyên con của không gian (chẳng hạn như tin nhắn được đăng trong không gian và thành viên trong không gian) cũng sẽ bị xoá. Ví dụ: hãy xem phần Xoá không gian. Yêu cầu xác thực người dùng của người dùng có quyền xoá không gian.
|
FindDirectMessage |
---|
Trả về tin nhắn trực tiếp hiện có với người dùng được chỉ định. Nếu không tìm thấy không gian tin nhắn trực tiếp, hàm sẽ trả về lỗi Với xác thực người dùng, hàm sẽ trả về không gian tin nhắn trực tiếp giữa người dùng đã chỉ định và người dùng được xác thực. Với chế độ xác thực ứng dụng, hãy trả về không gian tin nhắn trực tiếp giữa người dùng đã chỉ định và ứng dụng gọi trong Chat. Cần phải xác thực người dùng hoặc xác thực ứng dụng.
|
GetAttachment |
---|
Lấy siêu dữ liệu của tệp đính kèm tin nhắn. Dữ liệu tệp đính kèm được tìm nạp bằng API nội dung nghe nhìn. Để biết ví dụ, hãy xem phần Lấy siêu dữ liệu về tệp đính kèm tin nhắn. Yêu cầu xác thực ứng dụng.
|
GetMembership |
---|
Trả về thông tin chi tiết về một gói thành viên. Ví dụ: xem bài viết Xem thông tin chi tiết về gói thành viên của người dùng hoặc gói thành viên của ứng dụng Google Chat. Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng.
|
GetMessage |
---|
Trả về thông tin chi tiết về một tin nhắn. Để xem ví dụ, hãy xem phần Xem thông tin chi tiết về một tin nhắn. Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng. Lưu ý: Có thể trả về tin nhắn của một thành viên hoặc không gian bị chặn.
|
GetSpace |
---|
Trả về thông tin chi tiết về một không gian. Để xem ví dụ, hãy xem phần Xem thông tin chi tiết về một không gian. Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng.
|
GetSpaceEvent |
---|
Trả về một sự kiện từ phòng Google Chat. Tải trọng sự kiện chứa phiên bản gần đây nhất của tài nguyên đã thay đổi. Ví dụ: nếu bạn yêu cầu một sự kiện về một thông báo mới nhưng sau đó thông báo đó được cập nhật, thì máy chủ sẽ trả về tài nguyên Yêu cầu xác thực người dùng. Để nhận một sự kiện, người dùng đã xác thực phải là thành viên của không gian. Ví dụ: xem phần Xem thông tin chi tiết về một sự kiện từ một phòng Google Chat.
|
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. Ví dụ: xem phần Nhận thông tin chi tiết về trạng thái đọc không gian của người dùng. Yêu cầu xác thực người dùng.
|
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, dùng để xác định thư đã đọc và chưa đọc. Ví dụ: hãy xem phần Xem thông tin chi tiết về trạng thái đọc chuỗi của người dùng. Yêu cầu xác thực người dùng.
|
ListMemberships |
---|
Liệt kê thành viên trong một không gian. Ví dụ: hãy xem bài viết Liệt kê người dùng và ứng dụng Google Chat trong một không gian. Thành viên của trang thông tin có phương thức xác thực ứng dụng liệt kê tư cách thành viên trong những không gian mà ứng dụng Chat có quyền truy cập, nhưng không bao gồm tư cách thành viên của ứng dụng Chat, kể cả không gian của chính ứng dụng đó. Thành viên của trang thông tin có chế độ Xác thực người dùng liệt kê thành viên trong những không gian mà người dùng đã xác thực có quyền truy cập. Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng.
|
ListMessages |
---|
Liệt kê tin nhắn trong một không gian mà người gọi là thành viên, bao gồm cả tin nhắn của các thành viên và không gian bị chặn. Nếu bạn liệt kê tin nhắn từ một không gian không có tin nhắn nào, thì phản hồi sẽ là đối tượng trống. Khi sử dụng giao diện REST/HTTP, phản hồi chứa đối tượng JSON trống là
|
ListReactions |
---|
Liệt kê các lượt bày tỏ cảm xúc với một tin nhắn. Để xem ví dụ, hãy xem bài viết Liệt kê các lượt thể hiện cảm xúc cho một tin nhắn. Yêu cầu xác thực người dùng.
|
ListSpaceEvents |
---|
Liệt kê các sự kiện từ một phòng Google Chat. Đối với mỗi sự kiện, tải trọng chứa phiên bản mới nhất của tài nguyên trong Chat. Ví dụ: nếu bạn liệt kê sự kiện về thành viên mới của không gian, máy chủ sẽ trả về các tài nguyên Yêu cầu xác thực người dùng. Để liệt kê các sự kiện, người dùng đã xác thực phải là thành viên của không gian. Ví dụ: hãy xem bài viết Liệt kê các sự kiện từ một phòng Google Chat.
|
ListSpaces |
---|
Liệt kê các không gian mà phương thức gọi là thành viên. Các cuộc trò chuyện nhóm và tin nhắn trực tiếp không được liệt kê cho đến khi tin nhắn đầu tiên được gửi. Để biết ví dụ, hãy xem phần Liệt kê không gian. Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng. Liệt kê các không gian hiển thị cho người gọi hoặc người dùng đã xác thực. Các cuộc trò chuyện nhóm và tin nhắn trực tiếp không được liệt kê cho đến khi tin nhắn đầu tiên được gửi. Để liệt kê tất cả không gian có tên theo tổ chức trên Google Workspace, hãy sử dụng phương thức
|
SearchSpaces |
---|
use_admin_access thành true .
|
SetUpSpace |
---|
Tạo một không gian và thêm những người dùng được chỉ định vào không gian đó. Người dùng gọi sẽ tự động được thêm vào không gian và không được chỉ định làm thành viên trong yêu cầu. Để biết ví dụ, hãy xem Thiết lập không gian có những thành viên đầu tiên. Để chỉ định những thành viên mà bạn muốn thêm, hãy thêm gói thành viên có Để chỉ định các nhóm Google cần thêm, hãy thêm các thành viên bằng Đối với không gian hoặc cuộc trò chuyện nhóm có tên, nếu người gọi chặn hoặc bị một số thành viên chặn hoặc không có quyền thêm một số thành viên, thì những thành viên đó sẽ không được thêm vào không gian đã tạo. Để tạo tin nhắn trực tiếp (DM) giữa người dùng đang gọi và một người dùng khác, hãy chỉ định chính xác một gói thành viên để đại diện cho người dùng đó. Nếu một người dùng chặn người kia, thì yêu cầu sẽ không thành công và tin nhắn trực tiếp không được tạo. Để tạo tin nhắn trực tiếp giữa người dùng gọi và ứng dụng gọi, hãy đặt Nếu một tin nhắn trực tiếp đã tồn tại giữa hai người dùng, ngay cả khi một người dùng chặn người dùng còn lại vào thời điểm có yêu cầu, thì tin nhắn trực tiếp hiện có sẽ được trả về. Không hỗ trợ không gian có câu trả lời theo chuỗi. Nếu bạn nhận được thông báo lỗi Yêu cầu xác thực người dùng.
|
UpdateMembership |
---|
Cập nhật một gói thành viên. Ví dụ: xem phần Cập nhật gói thành viên của người dùng trong một không gian. Yêu cầu xác thực người dùng.
|
UpdateMessage |
---|
Cập nhật tin nhắn. Có sự khác biệt giữa phương thức Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng. Khi sử dụng phương thức xác thực ứng dụng, các yêu cầu chỉ có thể cập nhật tin nhắn do ứng dụng gọi Chat tạo.
|
UpdateSpace |
---|
Cập nhật một không gian. Để biết ví dụ, hãy xem phần Cập nhật không gian. Nếu bạn đang cập nhật trường 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. Ví dụ: xem phần Cập nhật trạng thái đọc không gian của người dùng. Yêu cầu xác thực người dùng.
|
AccessoryWidget
Một hoặc nhiều tiện ích tương tác xuất hiện ở cuối thư. Để biết thông tin chi tiết, hãy xem phần Thêm tiện ích tương tác ở cuối thư.
Trường | |
---|---|
Trường kết hợp action . Loại hành động. action chỉ có thể là một trong những trạng thái sau đây: |
|
button_list |
Danh sách các nút. |
ActionResponse
Các thông số mà ứng dụng Chat có thể dùng để định cấu hình cách đăng câu trả lời.
Trường | |
---|---|
type |
Chỉ nhập. Loại phản hồi của ứng dụng trong 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 |
dialog_action |
Chỉ nhập. Phản hồi cho một sự kiện tương tác liên quan đến hộp thoại. Phải kèm theo |
updated_widget |
Chỉ nhập. Phản hồi của tiện ích đã cập nhật. |
ResponseType
Loại phản hồi của ứng dụng trong Chat.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Loại mặc định được xử lý là NEW_MESSAGE . |
NEW_MESSAGE |
Đăng dưới dạng tin nhắn mới trong chủ đề. |
UPDATE_MESSAGE |
Cập nhật tin nhắn của ứng dụng Chat. Điều này chỉ được phép trên sự kiện CARD_CLICKED khi loại người gửi thư là BOT . |
UPDATE_USER_MESSAGE_CARDS |
Cập nhật các thẻ trên tin nhắn của người dùng. Điều này chỉ được phép dùng làm phản hồi cho sự kiện MESSAGE có URL khớp hoặc sự kiện CARD_CLICKED trong đó loại người gửi thư là HUMAN . Bỏ qua văn bản. |
REQUEST_CONFIG |
Yêu cầu riêng tư người dùng xác thực hoặc định cấu hình bổ sung. |
DIALOG |
Trình bày một hộp thoại. |
UPDATE_WIDGET |
Truy vấn các lựa chọn tự động hoàn thành văn bản trong tiện ích. |
SelectionItems
Danh sách kết quả tự động hoàn thành tiện ích.
Trường | |
---|---|
items[] |
Một mảng gồm các đối tượng SelectionItem. |
UpdatedWidget
Phản hồi của tiện ích đã cập nhật. Dùng để cung cấp các lựa chọn tự động hoàn thành cho một tiện ích.
Trường | |
---|---|
widget |
Mã của tiện ích đã cập nhật. Mã này phải khớp với mã của tiện ích đã kích hoạt yêu cầu cập nhật. |
Trường kết hợp updated_widget . Tiện ích này đã được cập nhật theo hành động của người dùng. updated_widget chỉ có thể là một trong những trạng thái sau đây: |
|
suggestions |
Danh sách kết quả tự động hoàn thành tiện ích |
ActionStatus
Biểu thị trạng thái của một yêu cầu gọi hoặc gửi hộp thoại.
Trường | |
---|---|
status_code |
Mã trạng thái. |
user_facing_message |
Thông báo gửi cho người dùng về trạng thái yêu cầu của họ. Nếu bạn không đặt chính sách này, một thông báo chung dựa trên |
Annotation
Chỉ có đầu ra. Các chú thích liên kết với nội dung văn bản thuần tuý của thông báo. Để thêm định dạng cơ bản cho tin nhắn văn bản, hãy xem phần Định dạng tin nhắn văn bản.
Ví dụ về nội dung thư dưới dạng văn bản thuần tuý:
Hello @FooBot how are you!"
Siêu dữ liệu chú thích tương ứng:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
Trường | |
---|---|
type |
Loại của chú thích này. |
length |
Độ dài của chuỗi con trong nội dung thông báo dạng văn bản thuần tuý tương ứng với chú thích này. |
start_index |
Chỉ mục bắt đầu (dựa trên 0, bao gồm cả 0) trong nội dung thông báo văn bản thuần tuý tương ứng với chú thích này. |
Trường kết hợp metadata . Siêu dữ liệu bổ sung về chú thích. metadata chỉ có thể là một trong những trạng thái sau đây: |
|
user_mention |
Siêu dữ liệu về lượt đề cập người dùng. |
slash_command |
Siêu dữ liệu cho lệnh dấu gạch chéo. |
rich_link_metadata |
Siêu dữ liệu cho đườ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 của enum. Không sử dụng. |
USER_MENTION |
Một người dùng được đề cập. |
SLASH_COMMAND |
Lệnh dấu gạch chéo được gọi. |
RICH_LINK |
Chú thích về đường liên kết đa dạng thức. |
AttachedGif
Hình ảnh GIF do URL chỉ định.
Trường | |
---|---|
uri |
Chỉ có đầu ra. URL lưu trữ hình ảnh GIF. |
Tệp đính kèm
Một tệp đính kèm trong Google Chat.
Trường | |
---|---|
name |
Tên tài nguyên của tệp đính kèm, ở dạng |
content_name |
Chỉ có đầu ra. Tên tệp gốc cho nội dung, không phải đường dẫn đầy đủ. |
content_type |
Chỉ có đầu ra. Loại nội dung (loại MIME) của tệp. |
thumbnail_uri |
Chỉ có đầu ra. URL hình thu nhỏ nên được sử dụng để xem trước tệp đính kèm cho người dùng thực. Các ứng dụng nhắn tin không nên dùng URL này để tải nội dung tệp đính kèm xuống. |
download_uri |
Chỉ có đầu ra. URL tải xuống nên được sử dụng để cho phép người dùng thực tải xuống tệp đính kèm. Các ứng dụng nhắn tin không nên dùng URL này để tải nội dung tệp đính kèm xuống. |
source |
Chỉ có đầu ra. Nguồn của tệp đính kèm. |
Trường kết hợp data_ref . Dữ liệu tham chiếu đến tệp đính kèm. data_ref chỉ có thể là một trong những trạng thái sau đây: |
|
attachment_data_ref |
Tham chiếu đến dữ liệu tệp đính kèm. Trường này được dùng với API nội dung nghe nhìn để tải dữ liệu tệp đính kèm xuống. |
drive_data_ref |
Chỉ có đầu ra. Tham chiếu đến tệp đính kèm trên Google Drive. Trường này được dùng với API Google Drive. |
Nguồn
Nguồn của tệp đính kèm.
Enum | |
---|---|
SOURCE_UNSPECIFIED |
Đã đặt trước. |
DRIVE_FILE |
Tệp này là một tệp trên Google Drive. |
UPLOADED_CONTENT |
Tệp đã được tải lên Chat. |
AttachmentDataRef
Tham chiếu đến dữ liệu tệp đính kèm.
Trường | |
---|---|
resource_name |
Tên tài nguyên của dữ liệu tệp đính kèm. Trường này được dùng với API nội dung nghe nhìn để tải dữ liệu tệp đính kèm xuống. |
attachment_upload_token |
Mã thông báo mờ chứa thông tin tham chiếu đến một tệp đính kèm đã tải lên. Được ứng dụng coi là một chuỗi mờ và dùng để tạo hoặc cập nhật tin nhắn trong Chat có tệp đính kèm. |
CardWithId
Một thẻ trong tin nhắn trên Google Chat.
Chỉ các ứng dụng trong Chat mới có thể tạo thẻ. Nếu ứng dụng Chat của bạn xác thực với tư cách là một người dùng, thì tin nhắn không được chứa thẻ.
Thiết kế và xem trước thẻ bằng Trình tạo thẻ.
Mở Trình tạo thẻTrường | |
---|---|
card_id |
Bắt buộc nếu thư chứa nhiều thẻ. Giá trị nhận dạng duy nhất của thẻ trong thông báo. |
card |
Thẻ. Kích thước tối đa là 32 KB. |
ChatSpaceLinkData
Dữ liệu của các đường liên kết đến phòng Chat.
Trường | |
---|---|
space |
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 |
Tin nhắn của tài nguyên trong phòng Chat được liên kết. Định dạng |
CompleteImportSpaceRequest
Thông báo yêu cầu hoàn tất quy trình nhập một không gian.
Trường | |
---|---|
name |
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 để yêu cầu hoàn tất quy trình nhập một không gian.
Trường | |
---|---|
space |
Không gian cho chế độ nhập. |
ContextualAddOnMarkup
Loại này không có trường nào.
Mã đánh dấu dành cho nhà phát triển để chỉ định nội dung của Tiện ích bổ sung theo ngữ cảnh.
Thẻ
Thẻ là một thành phần trên giao diện người dùng có thể chứa các tiện ích giao diện người dùng như văn bản và hình ảnh.
Trường | |
---|---|
header |
Tiêu đề thẻ. Tiêu đề thường chứa tiêu đề và hình ảnh. |
sections[] |
Các phần được phân tách bằng đường phân cách. |
card_actions[] |
Thao tác của thẻ này. |
name |
Tên thẻ. |
CardAction
Hành động đối với thẻ là hành động liên quan đến thẻ. Đối với thẻ hoá đơn, thao tác thông thường sẽ là: xoá hoá đơn, gửi hoá đơn qua email hoặc mở hoá đơn trong trình duyệt.
Không được các ứng dụng Google Chat hỗ trợ.
Trường | |
---|---|
action_label |
Nhãn từng xuất hiện trong mục trong trình đơn thao tác. |
on_click |
Hành động nhấp 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 cả tiêu đề và phụ đề được chỉ định thì mỗi tiêu đề sẽ chiếm một dòng. Nếu chỉ có tiêu đề được chỉ định, thì tiêu đề sẽ chiếm cả hai dòng. |
subtitle |
Phụ đề của tiêu đề thẻ. |
image_style |
Loại hình ảnh (ví dụ: đường viền vuông hoặc đường viền tròn). |
image_url |
URL của hình ảnh trong tiêu đề thẻ. |
ImageStyle
Enum | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
Đường viền hình vuông. |
AVATAR |
Đường viền tròn. |
Phần
Phần chứa một tập hợp các tiện ích được hiển thị (theo chiều dọc) theo thứ tự được chỉ định. Trên tất cả các nền tảng, thẻ có chiều rộng cố định hẹp, vì vậy hiện không cần thuộc tính bố cục (ví dụ: độ chính xác đơn).
Trường | |
---|---|
header |
Tiêu đề của phần. Văn bản được định dạng được hỗ trợ. Để biết thêm thông tin về việc định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace. |
widgets[] |
Mỗi mục phải chứa ít nhất một tiện ích. |
CreateMembershipRequest
Yêu cầu tin nhắn để tạo gói thành viên.
Trường | |
---|---|
parent |
Bắt buộc. Tên tài nguyên của không gian để tạo thành viên. Định dạng: dấu cách/{space} |
membership |
Bắt buộc. Mối quan hệ thành viên cần tạo. Trường |
use_admin_access |
true , phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat. Yêu cầu Quyền quản trị không hỗ trợ tính năng tạo thành viên trong ứng dụng hoặc tạo thành viên cho người dùng bên ngoài tổ chức Google Workspace của quản trị viên. |
CreateMessageRequest
Tạo một thông báo.
Trường | |
---|---|
parent |
Bắt buộc. Tên tài nguyên của không gian nơi tạo thông báo. Định dạng |
message |
Bắt buộc. Nội dung thư. |
thread_key |
Không bắt buộc. Không dùng nữa: Chuyển sang dùng |
request_id |
Không bắt buộc. Mã yêu cầu duy nhất cho thông báo này. Việc chỉ định mã nhận dạng yêu cầu hiện có sẽ trả về thông báo được tạo bằng mã nhận dạng đó thay vì tạo một thông báo mới. |
message_reply_option |
Không bắt buộc. Chỉ định xem một tin nhắn sẽ bắt đầu một chuỗi tin nhắn hay trả lời một chuỗi tin nhắn. Chỉ được hỗ trợ trong không gian được đặt tên. |
message_id |
Không bắt buộc. Mã tuỳ chỉnh của một thư. Cho phép các ứng dụng trong Chat nhận, cập nhật hoặc xoá tin nhắn mà không cần lưu trữ mã nhận dạng do hệ thống chỉ định trong tên tài nguyên của tin nhắn (được biểu thị trong trường Giá trị cho 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 Đặt tên cho thông báo. |
MessageReplyOption
Chỉ định cách trả lời một tin nhắn. Chúng tôi có thể sẽ thêm các tiểu bang khác trong tương lai.
Enum | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
Mặc định. Bắt đầu một chuỗi mới. Khi sử dụng tuỳ chọn này, bạn sẽ bỏ qua mọi thread ID hoặc có trong tuỳ chọn này. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Tạo tin nhắn dưới dạng tin nhắn trả lời cho chuỗi do thread ID hoặc chỉ định. Nếu không thành công, tin nhắn sẽ bắt đầu một chuỗi tin nhắn mới. |
REPLY_MESSAGE_OR_FAIL |
Tạo tin nhắn dưới dạng tin nhắn trả lời cho chuỗi do thread ID hoặc chỉ định. Nếu bạn sử dụng thread_key mới, thì một luồng mới sẽ được tạo. Nếu không tạo được thông báo, hệ thống sẽ trả về lỗi NOT_FOUND . |
CreateReactionRequest
Tạo lượt thể hiện cảm xúc với một tin nhắn.
Trường | |
---|---|
parent |
Bắt buộc. Thông báo nơi tạo lượt thể hiện cảm xúc. Định dạng |
reaction |
Bắt buộc. Phản ứng muốn tạo. |
CreateSpaceRequest
Yêu cầu tạo một không gian được đặt tên.
Trường | |
---|---|
space |
Bắt buộc. Bạn phải điền vào các trường Nếu bạn nhận được thông báo lỗi Không gian |
request_id |
Không bắt buộc. Giá trị nhận dạng duy nhất cho yêu cầu này. Bạn nên dùng mã nhận dạng duy nhất (UUID) ngẫu nhiên. Việc chỉ định mã nhận dạng yêu cầu hiện có sẽ trả về không gian được tạo bằng mã nhận dạng đó thay vì tạo không gian mới. Việc chỉ định mã yêu cầu hiện có từ cùng một ứng dụng Chat với một người dùng đã xác thực khác sẽ trả về lỗi. |
CustomEmoji
Đại diện cho một biểu tượng cảm xúc tuỳ chỉnh.
Trường | |
---|---|
uid |
Chỉ có đầu ra. Khoá duy nhất cho tài nguyên biểu tượng cảm xúc tuỳ chỉnh. |
DeleteMembershipRequest
Yêu cầu xoá thành viên trong một không gian.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của gói thành viên cần xoá. Các ứng dụng trong Chat có thể xoá dữ liệu của người dùng hoặc gói hội viên của chính họ. Ứng dụng Chat không thể xoá các ứng dụng khác gói hội viên. Khi xoá gói thành viên do con người thực hiện, bạn phải có phạm vi Khi xoá một gói thành viên của ứng dụng, bạn phải có phạm vi Định dạng: |
use_admin_access |
true , phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat. Yêu cầu Không thể xoá thành viên của ứng dụng trong một không gian khi sử dụng quyền quản trị. |
DeleteMessageRequest
Yêu cầu xoá tin nhắn.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của thông báo. Định dạng Nếu đã đặt mã tuỳ chỉnh cho thông báo của mình thì bạn có thể sử dụng giá trị từ trường |
force |
Khi Chỉ áp dụng khi xác thực với tư cách là người dùng. Không có hiệu lực khi xác thực dưới dạng một ứng dụng Chat. |
DeleteReactionRequest
Xoá lượt thể hiện cảm xúc với một tin nhắn.
Trường | |
---|---|
name |
Bắt buộc. Tên của phản ứng muố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_admin_access |
true , phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat. Yêu cầu |
DeletionMetadata
Thông tin về một thư đã xoá. Một tin nhắn sẽ bị xoá khi bạn đặt delete_time
.
Trường | |
---|---|
deletion_type |
Cho biết ai đã xoá tin nhắn. |
DeletionType
Ai đã xoá tin nhắn và cách tin nhắn bị xoá.
Enum | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Giá trị này chưa được sử dụng. |
CREATOR |
Người dùng đã xoá tin nhắn của chính họ. |
SPACE_OWNER |
Chủ sở hữu không gian đã xoá tin nhắn này. |
ADMIN |
Một quản trị viên Google Workspace đã xoá tin nhắn này. |
APP_MESSAGE_EXPIRY |
Một ứng dụng Chat đã xoá tin nhắn của chính mình khi tin nhắn đó hết hạn. |
CREATOR_VIA_APP |
Một ứng dụng Chat đã thay mặt người dùng xoá tin nhắn. |
SPACE_OWNER_VIA_APP |
Một ứng dụng Chat đã xoá tin nhắn này thay mặt cho chủ sở hữu không gian. |
Hộp thoại
Xuống dòng bao quanh phần thân thẻ của hộp thoại.
Trường | |
---|---|
body |
Chỉ nhập. Nội dung của hộp thoại, được hiển thị theo phương thức. Ứng dụng Google Chat không hỗ trợ các thực thể thẻ sau: |
DialogAction
Chứa hộp thoại và yêu cầu mã trạng thái.
Trường | |
---|---|
action_status |
Chỉ nhập. Trạng thái của một yêu cầu gọi hoặc gửi hộp thoại. Hiện trạng thái và thông báo cho người dùng nếu cần. Ví dụ: trong trường hợp lỗi hoặc thành công. |
Trường kết hợp action . Hành động cần thực hiện. action chỉ có thể là một trong những trạng thái sau đây: |
|
dialog |
Chỉ nhập. Hộp thoại cho yêu cầu. |
DriveDataRef
Một tham chiếu đến dữ liệu của một tệp đính kèm trên Drive.
Trường | |
---|---|
drive_file_id |
Mã nhận dạng của tệp trên Drive. Dùng với API Drive. |
DriveLinkData
Dữ liệu cho các đường liên kết đến Google Drive.
Trường | |
---|---|
drive_data_ref |
DriveDataRef tham chiếu đến một tệp trên Google Drive. |
mime_type |
Loại mime của tài nguyên Google Drive được liên kết. |
Biểu tượng cảm xúc
Biểu tượng cảm xúc được dùng để thể hiện cảm xúc với một tin nhắn.
Trường | |
---|---|
Trường kết hợp content . Nội dung của biểu tượng cảm xúc. content chỉ có thể là một trong những trạng thái sau đây: |
|
unicode |
Một biểu tượng cảm xúc cơ bản được biểu thị bằng một chuỗi Unicode. |
custom_emoji |
Chỉ có đầu ra. Một biểu tượng cảm xúc tuỳ chỉnh. |
EmojiReactionSummary
Số người đã thể hiện cảm xúc với một tin nhắn bằng một biểu tượng cảm xúc cụ thể.
Trường | |
---|---|
emoji |
Biểu tượng cảm xúc liên kết với các lượt bày tỏ cảm xúc. |
reaction_count |
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 tải 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 |
GetMembershipRequest
Yêu cầu đăng ký làm 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. Để nhận tư cách thành viên riêng trong ứng dụng bằng cách sử dụng xác thực người dùng, bạn có thể tuỳ ý sử dụng Định dạng: Khi được xác thực là người dùng, bạn có thể sử dụng email của người dùng đó làm bí danh cho |
use_admin_access |
true , phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat. Yêu cầu các phạm vi OAuth 2.0 Khi sử dụng quyền quản trị, tính năng thành viên của ứng dụng trong một không gian không được hỗ trợ. |
GetMessageRequest
Yêu cầu nhận tin nhắn.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của thông báo. Định dạng Nếu đã đặt mã tuỳ chỉnh cho thông báo của mình thì bạn có thể sử dụng giá trị từ trường |
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 trong không gian. Định dạng |
GetSpaceReadStateRequest
Thông báo yêu cầu đối với 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 thiết lập một trong các tuỳ chọn 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_admin_access |
true , phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat. Yêu cầu các phạm vi OAuth 2.0 |
GetThreadReadStateRequest
Thông báo yêu cầu đối với API GetThreadReadStateRequest.
Trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của trạng thái đọc luồng cần truy xuất. Chỉ hỗ trợ nhận trạng thái đọc cho người dùng gọi. Để tham chiếu đến người dùng gọi, hãy thiết lập một trong các tuỳ chọn sau:
Đị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 của một nhóm trên Google Groups. Đại diện cho một nhóm trong Cloud Identity Groups API. Định dạng: nhóm/{group} |
HistoryState
Trạng thái nhật ký của tin nhắn và không gian. Chỉ định khoảng thời gian lưu giữ các tin nhắn và chuỗi trò chuyện sau khi tạo.
Enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Giá trị mặc định. Không được dùng. |
HISTORY_OFF |
Đã tắt nhật ký. Tin nhắn và chuỗi tin nhắn được lưu giữ trong 24 giờ. |
HISTORY_ON |
Đã bật nhật ký. Quy tắc lưu giữ của Vault của tổ chức chỉ định khoảng thời gian lưu giữ thư và chuỗi. |
ListMembershipsRequest
Yêu cầu tin nhắn để đăng ký thành viên của trang thông tin.
Trường | |
---|---|
parent |
Bắt buộc. Tên tài nguyên của không gian cần tìm nạp danh sách thành viên. Định dạng: dấu cách/{space} |
page_size |
Không bắt buộc. Số lượng gói hội viên tối đa cần trả lại. Dịch vụ có thể trả về ít hơn giá trị này. Nếu bạn không xác định, hệ thống sẽ trả lại tối đa 100 gói hội viên. Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000. Giá trị âm trả về lỗi |
page_token |
Không bắt buộc. Mã thông báo trang, nhận được từ một cuộc gọi trước đó để liệt kê thành viên. Cung cấp tham số này để truy xuất trang tiếp theo. Khi phân trang, tất cả các thông số khác được cung cấp phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn. |
filter |
Không bắt buộc. Bộ lọc truy vấn. Bạn có thể lọc tư cách thành viên theo vai trò ( Để 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 phải nhập Ví dụ: các truy vấn sau đây là hợp lệ:
Các truy vấn sau không hợp lệ:
Máy chủ có lỗi |
show_groups |
Không bắt buộc. Khi |
show_invited |
Không bắt buộc. Khi Hiện yêu cầu xác thực người dùng. |
use_admin_access |
true , phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat. Yêu cầu phạm vi OAuth 2.0 Không hỗ trợ việc liệt kê tư cách thành viên của ứng dụng trong một không gian khi sử dụng quyền quản trị. |
ListMembershipsResponse
Phản hồi danh sách thành viên của không gian.
Trường | |
---|---|
memberships[] |
Danh sách không theo thứ tự. Danh sách thành viên trên trang yêu cầu (hoặc trang đầu tiên). |
next_page_token |
Mã thông báo mà bạn có thể gửi dưới dạng |
ListMessagesRequest
Liệt kê tin nhắn trong không gian chỉ định mà người dùng là thành viên.
Trường | |
---|---|
parent |
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_size |
Số lượng tin nhắn tối đa được trả về. Dịch vụ có thể trả về ít tin nhắn hơn giá trị này. Nếu không chỉ định, hàm trả về tối đa 25 trường. Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000. Giá trị âm trả về lỗi |
page_token |
Không bắt buộc, nếu tiếp tục từ một truy vấn trước đó. Đã nhận được mã thông báo trang từ một lệnh gọi tin nhắn danh sách trước đó. Cung cấp tham số này để truy xuất trang tiếp theo. Khi phân trang, tất cả các thông số khác được cung cấp phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn. |
filter |
Bộ lọc truy vấn. Bạn có thể lọc thư theo ngày ( Để lọc thư theo ngày tạo, hãy chỉ định Để lọc theo chuỗi, hãy chỉ định Để lọc theo cả chuỗi và ngày, hãy sử dụng toán tử Ví dụ: các truy vấn sau đây là hợp lệ:
Máy chủ có lỗi |
order_by |
Không bắt buộc, nếu tiếp tục từ một truy vấn trước đó. Cách sắp xếp danh sách tin nhắn. Chỉ định giá trị cho đơn đặt hàng bằng một thao tác đặt hàng. Sau đây là các giá trị toán tử có thứ tự hợp lệ:
Thứ tự mặc định là |
show_deleted |
Liệu có bao gồm thư đã xoá hay không. Tin nhắn bị xoá bao gồm cả thời gian đã xoá và siêu dữ liệu về việc xoá tin nhắn, nhưng không có nội dung tin nhắn. |
ListMessagesResponse
Tin nhắn phản hồi cho tin nhắn danh sách.
Trường | |
---|---|
messages[] |
Danh sách tin nhắn. |
next_page_token |
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 với một tin nhắn.
Trường | |
---|---|
parent |
Bắt buộc. Tin nhắn mà người dùng đã thể hiện cảm xúc. Định dạng |
page_size |
Không bắt buộc. Số lượt thể hiện cảm xúc tối đa được trả về. Dịch vụ có thể trả về ít phản ứng hơn giá trị này. Nếu bạn không chỉ định, giá trị mặc định sẽ là 25. Giá trị tối đa là 200; các giá trị trên 200 sẽ được thay đổi thành 200. |
page_token |
Không bắt buộc. (Nếu tiếp tục từ một truy vấn trước đó.) Mã thông báo trang nhận được từ một lệnh gọi thể hiện cảm xúc danh sách trước đó. Cung cấp mã này để truy xuất trang tiếp theo. Khi phân trang, giá trị bộ lọc phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển một giá trị khác có thể dẫn đến kết quả không mong muốn. |
filter |
Không bắt buộc. Bộ lọc truy vấn. Bạn có thể lọc lượt bày tỏ cảm xúc theo biểu tượng cảm xúc ( Để lọc lượt thể hiện cảm xúc cho nhiều biểu tượng cảm xúc hoặc người dùng, hãy kết hợp các trường tương tự bằng toán tử Để lọc lượt thể hiện cảm xúc theo biểu tượng cảm xúc và người dùng, hãy sử dụng toán tử 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 truy vấn sau không hợp lệ:
Máy chủ có lỗi |
ListReactionsResponse
Phản hồi lời mời bày tỏ cảm xúc dành cho danh sách.
Trường | |
---|---|
reactions[] |
Danh sách lượt thể hiện cảm xúc trên trang được yêu cầu (hoặc trang đầu tiên). |
next_page_token |
Mã thông báo tiếp tục để truy xuất trang kết quả tiếp theo. Trang kết quả cuối cùng vẫn trống. |
ListSpaceEventsRequest
Yêu cầu gửi tin nhắn cho các sự kiện trong không gian liệt kê.
Trường | |
---|---|
parent |
Bắt buộc. Tên tài nguyên của phòng Google Chat nơi diễn ra sự kiện. Định dạng: |
page_size |
Không bắt buộc. Số lượng tối đa các sự kiện trong không gian được trả về. Dịch vụ có thể trả về ít hơn giá trị này. Giá trị âm trả về lỗi |
page_token |
Mã thông báo trang, nhận được từ lệnh gọi sự kiện không gian danh sách trước đó. Cung cấp mã này để truy xuất trang tiếp theo. Khi phân trang, tất cả các thông số khác được cung cấp để liệt kê sự kiện của không gian phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn. |
filter |
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 ( Nếu muố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 truy vấn sau không hợp lệ:
Máy chủ có lỗi |
ListSpaceEventsResponse
Tin nhắn phản hồi cho các sự kiện trong không gian liệt kê.
Trường | |
---|---|
space_events[] |
Kết quả được trả về theo thứ tự thời gian (sự kiện cũ nhất được xếp trước). |
next_page_token |
Mã thông báo tiếp tục được dùng để tìm nạp thêm sự kiện. Nếu trường này bị bỏ qua thì sẽ không có trang tiếp theo. |
ListSpacesRequest
Yêu cầu liệt kê những không gian mà phương thức gọi là thành viên.
Trường | |
---|---|
page_size |
Không bắt buộc. Số lượng dấu cách tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu bạn không chỉ định thì hệ thống sẽ trả về tối đa 100 dấu cách. Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000. Giá trị âm trả về lỗi |
page_token |
Không bắt buộc. Mã thông báo trang, nhận được từ một lệnh gọi không gian danh sách trước đó. Cung cấp tham số này để truy xuất trang tiếp theo. Khi phân trang, giá trị bộ lọc phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển một giá trị khác có thể dẫn đến kết quả không mong muốn. |
filter |
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ệ:
Máy chủ có lỗi |
ListSpacesResponse
Phản hồi cho yêu cầu về không gian danh sách.
Trường | |
---|---|
spaces[] |
Danh sách các không gian trong trang được yêu cầu (hoặc trang đầu tiên). |
next_page_token |
Bạn có thể gửi mã thông báo dưới dạng |
MatchedUrl
URL trùng khớp trong một tin nhắn trên Chat. Các ứng dụng nhắn tin có thể xem trước URL đã khớp. Để biết thêm thông tin, hãy xem bài viết Xem trước đường liên kết.
Trường | |
---|---|
url |
Chỉ có đầu ra. URL được so khớp. |
Gói thành viên
Thể hiện mối quan hệ thành viên trong Google Chat, chẳng hạn như người dùng hoặc ứng dụng trong Chat được mời tham gia, là một phần hay vắng mặt trong không gian.
Trường | |
---|---|
name |
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 phòng Chat. Vai trò này xác định những hành động được phép họ thực hiện trong không gian đó. Bạn chỉ có thể dùng trường này làm dữ liệu đầu vào trong |
create_time |
Không bắt buộc. Bất biến. Thời gian tạo thành viên, chẳng hạn như thời điểm thành viên tham gia hoặc được mời tham gia không gian. Trường này chỉ được cung cấp cho kết quả đầu ra, trừ phi trường này được dùng để nhập tư cách thành viên trước đây vào không gian ở chế độ nhập. |
delete_time |
Không bắt buộc. Bất biến. Thời gian xoá thành viên, chẳng hạn như khi một thành viên rời khỏi hoặc bị xoá khỏi không gian. Trường này chỉ được cung cấp cho kết quả đầu ra, trừ phi trường này được dùng để nhập tư cách thành viên trước đây vào không gian ở chế độ nhập. |
Trường kết hợp memberType . Thành viên liên kết với gói thành viên này. Các loại thành viên khác có thể sẽ được hỗ trợ trong tương lai. memberType chỉ có thể là một trong những trạng thái sau đây: |
|
member |
Người dùng hoặc ứng dụng Google Chat tương ứng với gói thành viên. Nếu ứng dụng Chat xác thực với tư cách là một người dùng, thì dữ liệu đầu ra sẽ được điền cho người dùng |
group_member |
Nhóm Google tương ứng với tư cách thành viên. |
MembershipRole
Biểu thị các hành động được phép của người dùng trong phòng Chat. Trong tương lai, có thể sẽ thêm các giá trị enum khác.
Enum | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
Giá trị mặc định. Đối với users : họ không phải là thành viên của không gian nhưng có thể được mời. Đối với Google Groups : họ luôn được chỉ định vai trò này (các giá trị enum khác có thể được sử dụng trong tương lai). |
ROLE_MEMBER |
Một thành viên của không gian. Người dùng có các quyền cơ bản, chẳng hạn như gửi tin nhắn đến không gian. Trong các cuộc trò chuyện nhóm 1:1 và chưa đặt tên, mọi người đều có vai trò này. |
ROLE_MANAGER |
Người quản lý không gian. Người dùng có tất cả các quyền cơ bản cùng với những quyền quản trị cho phép họ quản lý không gian, chẳng hạn như thêm hoặc xoá thành viên. Chỉ được hỗ trợ trong SpaceType.SPACE . |
MembershipState
Chỉ định mối quan hệ của thành viên với một không gian. Các trạng thái thành viên khác có thể được hỗ trợ trong tương lai.
Enum | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
Giá trị mặc định. Không sử dụng. |
JOINED |
Người dùng được thêm vào không gian và có thể tham gia vào không gian. |
INVITED |
Người dùng được mời tham gia không gian nhưng chưa tham gia. |
NOT_A_MEMBER |
Người dùng không thuộc không gian và không có lời mời đang chờ xử lý để tham gia không gian. |
MembershipBatchCreatedEventData
Tải trọng sự kiện cho nhiều gói thành viên mới.
Loại sự kiện: google.workspace.chat.membership.v1.batchCreated
Trường | |
---|---|
memberships[] |
Danh sách gói hội viên mới. |
MembershipBatchDeletedEventData
Tải trọng sự kiện cho nhiều gói thành viên đã xoá.
Loại sự kiện: google.workspace.chat.membership.v1.batchDeleted
Trường | |
---|---|
memberships[] |
Danh sách những gói hội viên đã xoá. |
MembershipBatchUpdatedEventData
Tải trọng sự kiện cho nhiều gói thành viên đã cập nhật.
Loại sự kiện: google.workspace.chat.membership.v1.batchUpdated
Trường | |
---|---|
memberships[] |
Danh sách những gói hội viên mới cập nhật. |
MembershipCreatedEventData
Tải trọng sự kiện cho một gói thành viên mới.
Loại sự kiện: google.workspace.chat.membership.v1.created
.
Trường | |
---|---|
membership |
Gói thành viên mới. |
MembershipDeletedEventData
Tải trọng sự kiện cho một gói thành viên đã xoá.
Loại sự kiện: google.workspace.chat.membership.v1.deleted
Trường | |
---|---|
membership |
Gói thành viên đã xoá. Chỉ có các trường |
MembershipUpdatedEventData
Tải trọng sự kiện cho một gói thành viên đã cập nhật.
Loại sự kiện: google.workspace.chat.membership.v1.updated
Trường | |
---|---|
membership |
Gói thành viên mới cập nhật. |
Thông điệp
Một tin nhắn trong phòng Google Chat.
Trường | |
---|---|
name |
Tên tài nguyên của thông báo. Định dạng Trong đó Nếu đặt mã tuỳ chỉnh khi tạo thông báo, bạn có thể sử dụng mã này để chỉ định thông báo trong yêu cầu bằng cách thay thế |
sender |
Chỉ có đầu ra. Người dùng đã tạo thông báo. Nếu ứng dụng Chat xác thực với tư cách là một người dùng, thì dữ liệu đầu ra sẽ được điền cho người dùng |
create_time |
Không bắt buộc. Bất biến. Đối với những không gian được tạo trong Chat, đó là thời điểm tin nhắn được tạo. Trường này chỉ dành cho kết quả đầu ra, trừ phi được dùng trong không gian ở chế độ nhập. Đối với không gian ở chế độ nhập, hãy đặt trường này thành dấu thời gian trước đây khi thông báo được tạo trong nguồn để duy trì thời gian tạo ban đầu. |
last_update_time |
Chỉ có đầu ra. Thời điểm người dùng chỉnh sửa thư gần đây nhất. Nếu thư chưa từng được chỉnh sửa, thì trường này trống. |
delete_time |
Chỉ có đầu ra. Thời điểm tin nhắn bị xoá trong Google Chat. Nếu thông báo đó không bị xoá, thì trường này sẽ trống. |
text |
Nội dung thư bằng văn bản thuần tuý. Đường liên kết đầu tiên đến một hình ảnh, video hoặc trang web sẽ tạo ra một khối xem trước. Bạn cũng có thể đề cập đến một người dùng Google Chat bằng@ hoặc mọi người trong không gian. Để tìm hiểu về cách tạo tin nhắn văn bản, hãy xem phần Gửi tin nhắn. |
formatted_text |
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 thư |
cards[] |
Không dùng nữa: Chuyển sang dùng Các thẻ có định dạng, có định dạng và có tính tương tác mà bạn có thể dùng để hiển thị các thành phần trên giao diện người dùng như: văn bản được định dạng, nút và hình ảnh có thể nhấp vào. Thẻ thường xuất hiện bên dưới nội dung văn bản thuần tuý của thư. |
cards_v2[] |
Một mảng thẻ. Chỉ các ứng dụng trong Chat mới có thể tạo thẻ. Nếu ứng dụng Chat của bạn xác thực với tư cách là người dùng, thì tin nhắn không được chứa thẻ. Để tìm hiểu cách tạo tin nhắn chứa thẻ, hãy xem phần 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 thư chứa thư. Để biết ví dụ về cách sử dụng, hãy xem phần Bắt đầu hoặc trả lời một chuỗi tin nhắn. |
space |
Nếu ứng dụng Chat xác thực với tư cách một người dùng, thì dữ liệu đầu ra sẽ được điền vào không gian |
fallback_text |
Nội dung mô tả dưới dạng văn bản thuần tuý về các thẻ của thông báo, được sử dụng khi không thể hiển thị thẻ thực tế (ví dụ: thông báo trên thiết bị di động). |
action_response |
Chỉ nhập. Các thông số mà ứng dụng Chat có thể dùng để định cấu hình cách đăng câu trả lời. |
argument_text |
Chỉ có đầu ra. Nội dung tin nhắn ở dạng văn bản thuần tuý, trong đó tất cả nội dung đề cập trong ứng dụng Chat đều bị loại bỏ. |
slash_command |
Chỉ có đầu ra. Thông tin về lệnh dấu gạch chéo, nếu có. |
attachment[] |
Tệp đính kèm do người dùng tải lên. |
matched_url |
Chỉ có đầu ra. URL trong |
thread_reply |
Chỉ có đầu ra. Khi Nếu không gian không hỗ trợ trả lời trong chuỗi tin nhắn, thì trường này luôn là |
client_assigned_message_id |
Không bắt buộc. Mã tuỳ chỉnh của thư. Bạn có thể sử dụng trường để xác định tin nhắn, hoặc để nhận, xoá hay cập nhật tin nhắn. Để đặt mã tuỳ chỉnh, hãy chỉ định trường |
emoji_reaction_summaries[] |
Chỉ có đầu ra. Danh sách bản tóm tắt lượt thể hiện cảm xúc bằng biểu tượng trong tin nhắn. |
private_message_viewer |
Bất biến. Dữ liệu đầu vào để tạo thông báo, nếu không thì chỉ có dữ liệu đầu ra. Người dùng có thể xem thông báo. Khi bạn đặt chính sách này, tin nhắn sẽ ở chế độ riêng tư và chỉ hiển thị với người dùng được chỉ định cũng như ứng dụng Chat. Không hỗ trợ bản xem trước đường liên kết và tệp đính kèm đối với tin nhắn riêng tư. Chỉ các ứng dụng trong Chat mới có thể gửi tin nhắn riêng tư. Nếu ứng dụng Chat xác thực tư cách người dùng để gửi tin nhắn, thì tin nhắn không thể ở chế độ riêng tư và phải bỏ qua trường này. Để biết thông tin chi tiết, hãy xem phần Gửi thư ở chế độ riêng tư. |
deletion_metadata |
Chỉ có đầu ra. Thông tin về một thư đã xoá. Một tin nhắn sẽ bị xoá khi bạn đặt |
quoted_message_metadata |
Chỉ có đầu ra. Thông tin về một tin nhắn do một người dùng Google Chat trích dẫn trong một không gian. Người dùng Google Chat có thể trích dẫn một tin nhắn để trả lời. |
attached_gifs[] |
Chỉ có đầu ra. Hình ảnh GIF được đính kèm vào thư. |
accessory_widgets[] |
Một hoặc nhiều tiện ích tương tác xuất hiện ở cuối thư. Bạn có thể thêm tiện ích phụ kiện vào những tin nhắn chứa văn bản, thẻ hoặc cả văn bản và thẻ. Không hỗ trợ cho các tin nhắn chứa hộp thoại. Để biết thông tin chi tiết, hãy xem phần Thêm tiện ích tương tác ở cuối thư. Để tạo tin nhắn bằng các tiện ích phụ kiện, bạn cần xác thực ứng dụng. |
MessageBatchCreatedEventData
Tải trọng sự kiện cho nhiều tin nhắn mới.
Loại sự kiện: google.workspace.chat.message.v1.batchCreated
Trường | |
---|---|
messages[] |
Danh sách tin nhắn mới. |
MessageBatchDeletedEventData
Tải trọng sự kiện cho nhiều thư đã xoá.
Loại sự kiện: google.workspace.chat.message.v1.batchDeleted
Trường | |
---|---|
messages[] |
Danh sách các thư đã xoá. |
MessageBatchUpdatedEventData
Tải trọng sự kiện cho nhiều thông báo được cập nhật.
Loại sự kiện: google.workspace.chat.message.v1.batchUpdated
Trường | |
---|---|
messages[] |
Danh sách tin nhắn đã cập nhật. |
MessageCreatedEventData
Tải trọng sự kiện cho một tin nhắn mới.
Loại sự kiện: google.workspace.chat.message.v1.created
Trường | |
---|---|
message |
Tin nhắn mới. |
MessageDeletedEventData
Tải trọng sự kiện cho một thư đã xoá.
Loại sự kiện: google.workspace.chat.message.v1.deleted
Trường | |
---|---|
message |
Tin nhắn đã xoá. Chỉ có các trường |
MessageUpdatedEventData
Tải trọng sự kiện cho một thông báo đã cập nhật.
Loại sự kiện: google.workspace.chat.message.v1.updated
Trường | |
---|---|
message |
Tin nhắn đã cập nhật. |
QuotedMessageMetadata
Thông tin về tin nhắn được trích dẫn.
Trường | |
---|---|
name |
Chỉ có đầu ra. Tên tài nguyên của tin nhắn được trích dẫn. Định dạng |
last_update_time |
Chỉ có đầu ra. Dấu thời gian khi tin nhắn được trích dẫn được tạo hoặc khi tin nhắn được trích dẫn được cập nhật lần gần đây nhất. |
Video phản ứng
Thể hiện cảm xúc với một tin nhắn.
Trường | |
---|---|
name |
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 lượt thể hiện cảm xúc. |
emoji |
Biểu tượng cảm xúc được dùng trong lượt thể hiện cảm xúc. |
ReactionBatchCreatedEventData
Tải trọng sự kiện cho nhiều lượt thể hiện cảm xúc mới.
Loại sự kiện: google.workspace.chat.reaction.v1.batchCreated
Trường | |
---|---|
reactions[] |
Danh sách các lượt bày tỏ cảm xúc mới. |
ReactionBatchDeletedEventData
Tải trọng sự kiện cho nhiều phản ứng đã xoá.
Loại sự kiện: google.workspace.chat.reaction.v1.batchDeleted
Trường | |
---|---|
reactions[] |
Danh sách các biểu tượng cảm xúc đã bị xoá. |
ReactionCreatedEventData
Tải trọng sự kiện cho một phản ứng mới.
Loại sự kiện: google.workspace.chat.reaction.v1.created
Trường | |
---|---|
reaction |
Lượt thể hiện cảm xúc mới. |
ReactionDeletedEventData
Tải trọng sự kiện cho một phản ứng đã xoá.
Loại: google.workspace.chat.reaction.v1.deleted
Trường | |
---|---|
reaction |
Biểu tượng cảm xúc đã xoá. |
RichLinkMetadata
Đường liên kết đa dạng thức đến một tài nguyên.
Trường | |
---|---|
uri |
URI của đường liên kết này. |
rich_link_type |
Loại đường liên kết đa dạng thức. |
Trường kết hợp data . Dữ liệu cho tài nguyên được liên kết. data chỉ có thể là một trong những trạng thái sau đây: |
|
drive_link_data |
Dữ liệu cho một đường liên kết đến Drive. |
chat_space_link_data |
Dữ liệu của một đường liên kết đến phòng trò chuyện. |
RichLinkType
Loại đường liên kết đa dạng thức. Trong tương lai, chúng tôi có thể sẽ thêm các loại khác.
Enum | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Giá trị mặc định của 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 của phòng Chat. Ví dụ: khối thông minh là không gian. |
SearchSpacesRequest
Yêu cầu tìm kiếm danh sách không gian dựa trên cụm từ tìm kiếm.
Trường | |
---|---|
use_admin_access |
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à không gian trên Chat. 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ỉ có |
page_size |
Số lượng dấu cách tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu bạn không chỉ định thì hệ thống sẽ trả về tối đa 100 dấu cách. Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000. |
page_token |
Mã thông báo, nhận được từ lệnh gọi không gian tìm kiếm trước đó. Cung cấp tham số này để truy xuất trang tiếp theo. Khi phân trang, tất cả các thông số khác được cung cấp phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn. |
query |
Bắt buộc. Cụm từ tìm kiếm. Bạn có thể tìm kiếm bằng cách sử dụng các tham số sau:
Trong các trường khác nhau, chỉ có toán tử Trong cùng một trường, Các truy vấn mẫu sau đây là hợp lệ:
|
order_by |
Không bắt buộc. Cách sắp xếp danh sách không gian. Sau đây là các thuộc tính được hỗ trợ để sắp xếp theo:
Các giá trị của toán tử theo thứ tự hợp lệ là:
Cú pháp được hỗ trợ là:
|
SearchSpacesResponse
Phản hồi có danh sách dấu cách tương ứng với yêu cầu tìm kiếm không gian.
Trường | |
---|---|
spaces[] |
Một trang chứa các không gian được yêu cầu. |
next_page_token |
Mã thông báo có thể được dùng để truy xuất trang tiếp theo. Nếu trường này trống thì sẽ không có trang tiếp theo. |
total_size |
Tổng số không gian phù hợp với cụm từ tìm kiếm trên tất cả các trang. Nếu kết quả có hơn 10.000 không gian, thì giá trị này chỉ là ước tính. |
SetUpSpaceRequest
Yêu cầu tạo một không gian và thêm những người dùng được chỉ định vào không gian đó.
Trường | |
---|---|
space |
Bắt buộc. Trường Để tạo 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 những người với nhau, hãy đặt Để tạo cuộc trò chuyện 1:1 giữa người dùng và ứng dụng gọi điện trong Chat, hãy đặt Nếu đã có một không gian |
request_id |
Không bắt buộc. Giá trị nhận dạng duy nhất cho yêu cầu này. Bạn nên dùng mã nhận dạng duy nhất (UUID) ngẫu nhiên. Việc chỉ định mã nhận dạng yêu cầu hiện có sẽ trả về không gian được tạo bằng mã nhận dạng đó thay vì tạo không gian mới. Việc chỉ định mã yêu cầu hiện có từ cùng một ứng dụng Chat với một người dùng đã xác thực khác sẽ trả về lỗi. |
memberships[] |
Không bắt buộc. Người dùng hoặc nhóm Google Chat mà bạn muốn mời tham gia không gian. Bỏ qua người dùng đang gọi vì họ được thêm tự động. Chế độ này hiện cho phép sử dụng tối đa 20 thành viên (ngoài người gọi). Đối với tư cách thành viên do con người thực hiện, trường Đối với tư cách thành viên trong 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 nhắn tin đang gọi (khi đặt |
SlashCommand
Lệnh gạch chéo trong Google Chat.
Trường | |
---|---|
command_id |
Mã của lệnh dấu gạch chéo đã được gọi ra. |
SlashCommandMetadata
Siêu dữ liệu chú thích cho lệnh dấu gạch chéo (/).
Trường | |
---|---|
bot |
Ứng dụng Chat có lệnh đã được gọi. |
type |
Loại lệnh dấu gạch chéo. |
command_name |
Tên của lệnh dấu gạch chéo được gọi. |
command_id |
Mã lệnh của lệnh dấu gạch chéo đã gọi. |
triggers_dialog |
Cho biết lệnh dấu gạch chéo có dành cho hộp thoại hay không. |
Loại
Enum | |
---|---|
TYPE_UNSPECIFIED |
Giá trị mặc định của enum. Không sử dụng. |
ADD |
Thêm ứng dụng Chat vào không gian. |
INVOKE |
Gọi lệnh dấu gạch chéo trong không gian. |
Không gian
Một không gian trong Google Chat. Không gian là các cuộc trò chuyện giữa hai hoặc nhiều người dùng hoặc tin nhắn 1:1 giữa một người dùng và một ứng dụng trong Chat.
Trường | |
---|---|
name |
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: Chuyển sang dùng |
space_type |
Loại không gian. Bắt buộc khi tạo không gian hoặc cập nhật loại không gian của không gian. Chỉ có đầu ra cho mục đích sử dụng khác. |
single_user_bot_dm |
Không bắt buộc. Liệu không gian có phải là tin nhắn trực tiếp giữa một ứng dụng Chat và một người hay không. |
threaded |
Chỉ có đầu ra. Không dùng nữa: Chuyển sang dùng |
display_name |
Tên hiển thị của không gian. Bắt buộc khi tạo không gian. Nếu bạn nhận được thông báo lỗi Đối với tin nhắn trực tiếp, trường này có thể trống. Hỗ trợ tối đa 128 ký tự. |
external_user_allowed |
Bất biến. Liệu không gian này có cho phép bất kỳ người dùng Google Chat nào làm thành viên hay không. Nhập dữ liệu khi tạo không gian trong một tổ chức trên Google Workspace. Bỏ qua trường này khi tạo khoảng trắng trong các điều kiện sau:
Đối với không gian hiện có, trường này chỉ là dữ liệu đầu ra. |
space_threading_state |
Chỉ có đầu ra. Trạng thái của chuỗi tin nhắn trong phòng Chat. |
space_details |
Thông tin chi tiết về không gian, bao gồm cả nội dung mô tả và quy tắc. |
space_history_state |
Trạng thái nhật ký tin nhắn của tin nhắn và chuỗi tin nhắn trong không gian này. |
import_mode |
Không bắt buộc. Liệu không gian này có được tạo trong |
create_time |
Không bắt buộc. Bất biến. Thời gian tạo không gian đối với các không gian được tạo trong Chat. Trường này chỉ dành cho kết quả đầu ra, trừ phi được dùng trong không gian ở chế độ nhập. Đối với không gian ở chế độ nhập, hãy đặt trường này thành dấu thời gian trước đây khi không gian được tạo trong nguồn để duy trì thời gian tạo ban đầu. Chỉ được điền sẵn vào kết quả khi |
last_active_time |
Chỉ có đầu ra. Dấu thời gian của tin nhắn cuối cùng trong không gian. |
admin_installed |
Chỉ có đầu ra. Đối với những không gian nhắn tin trực tiếp (DM) có ứng dụng Chat, thông tin cho biết không gian đó có phải do quản trị viên Google Workspace tạo hay không. Quản trị viên có thể thay mặt người dùng trong tổ chức cài đặt và thiết lập tin nhắn trực tiếp bằng ứng dụng Chat. Để hỗ trợ việc cài đặt ứng dụng quản trị viên, ứng dụng Chat của bạn phải có tính năng nhắn tin trực tiếp. |
membership_count |
Chỉ có đầu ra. Số lượng hội viên đã tham gia được nhóm theo loại thành viên. Được điền sẵn khi |
access_settings |
Không bắt buộc. Chỉ định chế độ cài đặt quyền truy cập của không gian. Chỉ được điền khi |
space_uri |
Chỉ có đầu ra. URI để người dùng truy cập vào không gian. |
Trường kết hợp space_permission_settings . Đại diện cho các chế độ cài đặt quyền của một không gian. Chỉ được điền khi space_type là SPACE . space_permission_settings chỉ có thể là một trong những trạng thái sau đây: |
|
predefined_permission_settings |
Không bắt buộc. Chỉ nhập. Cài đặt quyền đối với không gian. Dữ liệu đầu vào để tạo không gian, không gian cộng tác sẽ được tạo nếu bạn không đặt trường này. Sau khi bạn tạo không gian, các chế độ cài đặt sẽ được điền sẵn vào trường |
permission_settings |
Không bắt buộc. Có thể đặt đúng chế độ cài đặt quyền để cập nhật không gian. Mục nhập để cập nhật một không gian. Nếu không, chỉ có thể xuất đầu ra. Để tạo không gian, hãy sử dụng |
AccessSettings
Đại diện cho chế độ cài đặt quyền truy cập của không gian.
Trường | |
---|---|
access_state |
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ính sách này, thì chỉ những người dùng hoặc nhóm trên Google Groups đã được mời hoặc thêm riêng vào không gian mới có thể truy cập vào không gian. Để biết thông tin chi tiết, hãy xem bài viết Giúp đối tượng mục tiêu có thể tìm thấy không gian. Định dạng Để sử dụng đối tượng mục tiêu mặc định cho tổ chức Google Workspace, hãy đặt thành |
AccessState
Biểu thị trạng thái truy cập của không gian.
Enum | |
---|---|
ACCESS_STATE_UNSPECIFIED |
Trạng thái truy cập không xác định hoặc không được hỗ trợ trong API này. |
PRIVATE |
Chỉ những người dùng hoặc nhóm trên Google Groups mà quản trị viên Google Workspace hoặc người dùng khác thêm hoặc mời riêng mới có thể khám phá và truy cập vào không gian. |
DISCOVERABLE |
Người quản lý không gian đã cấp cho một đối tượng mục tiêu quyền truy cập vào không gian. Những người dùng hoặc nhóm trên Google Groups được thêm hoặc mời riêng vào không gian cũng có thể khám phá và truy cập vào không gian. Để tìm hiểu thêm, hãy xem bài viết Đặt không gian có thể tìm thấy cho những người dùng cụ thể. |
MembershipCount
Trường | |
---|---|
joined_direct_human_user_count |
Số người dùng đã trực tiếp tham gia không gian, không tính số người dùng tham gia khi là thành viên trong một nhóm đã tham gia. |
joined_group_count |
Số lượng tất cả các nhóm đã trực tiếp tham gia không gian. |
PermissionSetting
Đại diện cho một chế độ cài đặt quyền của không gian.
Trường | |
---|---|
managers_allowed |
Việc người quản lý không gian có quyền này hay không. |
members_allowed |
Liệu các thành viên không phải là người quản lý có quyền này hay không. |
PermissionSettings
Cài đặt quyền cho một không gian được đặt tên. Để thiết lập chế độ cài đặt quyền khi tạo không gian, hãy chỉ định trường PredefinedPermissionSettings
trong yêu cầu của bạn.
Trường | |
---|---|
manage_members_and_groups |
Chế độ cài đặt để quản lý thành viên và nhóm trong một không gian. |
modify_space_details |
Chế độ cài đặt để cập nhật tên, hình đại diện, nội dung mô tả và nguyên tắc của không gian. |
toggle_history |
Chế độ cài đặt để bật và tắt nhật ký của không gian. |
use_at_mention_all |
Chế độ cài đặt để sử dụng tính năng đề cập tất cả bằng @trong một không gian. |
manage_apps |
Chế độ cài đặt để quản lý ứng dụng trong một không gian. |
manage_webhooks |
Chế độ cài đặt để quản lý webhook trong không gian. |
post_messages |
Chỉ có đầu ra. Chế độ cài đặt để đăng tin nhắn trong không gian. |
reply_messages |
Chế độ cài đặt để trả lời tin nhắn trong một không gian. |
PredefinedPermissionSettings
Chế độ cài đặt quyền của không gian mà bạn có thể chỉ định khi tạo không gian được đặt tên. Trong tương lai, chúng tôi có thể sẽ thêm các chế độ cài đặt khác. Để biết thông tin chi tiết về các chế độ cài đặt quyền cho không gian được đặt tên, hãy xem bài viết Tìm hiểu về không gian.
Enum | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Không xác định. Không sử dụng. |
COLLABORATION_SPACE |
Chế độ cài đặt biến không gian thành không gian cộng tác mà tất cả thành viên đều có thể đăng tin nhắn. |
ANNOUNCEMENT_SPACE |
Chế độ cài đặt chuyển không gian thành không gian thông báo, nơi chỉ người quản lý không gian mới có thể đăng tin nhắn. |
SpaceDetails
Thông tin chi tiết về không gian, bao gồm cả nội dung mô tả và quy tắc.
Trường | |
---|---|
description |
Không bắt buộc. Nội dung mô tả không gian. Ví dụ: mô tả chủ đề thảo luận của không gian, mục đích chức năng hoặc người tham gia. Hỗ trợ tối đa 150 ký tự. |
guidelines |
Không bắt buộc. Quy tắc, yêu cầu và nghi thức của không gian. Hỗ trợ tối đa 5.000 ký tự. |
SpaceThreadingState
Chỉ định loại trạng thái của chuỗi tin nhắn trong phòng Chat.
Enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Đã đặt trước. |
THREADED_MESSAGES |
Không gian được đặt tên có hỗ trợ các chuỗi tin nhắn. Khi trả lời thư, người dùng có thể trả lời dưới dạng chuỗi, tức là câu trả lời của họ vẫn nằm trong ngữ cảnh của thư gốc. |
GROUPED_MESSAGES |
Không gian được đặt tên, trong đó cuộc trò chuyện được sắp xếp theo chủ đề. Các chủ đề và câu trả lời của các chủ đề đó sẽ được nhóm lại với nhau. |
UNTHREADED_MESSAGES |
Tin nhắn trực tiếp (DM) giữa 2 người và cuộc trò chuyện nhóm giữa 3 người trở lên. |
SpaceType
Loại không gian. Bắt buộc khi tạo hoặc cập nhật không gian. Chỉ có đầu ra cho mục đích sử dụng khác.
Enum | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Đã đặt trước. |
SPACE |
Một nơi để mọi người gửi tin nhắn, chia sẻ tệp và cộng tác. SPACE có thể bao gồm các ứng dụng trong Chat. |
GROUP_CHAT |
Cuộc trò chuyện nhóm giữa 3 người trở lên. GROUP_CHAT có thể bao gồm các ứng dụng trong Chat. |
DIRECT_MESSAGE |
Tin nhắn 1:1 giữa hai người hoặc giữa một người và một ứng dụng trong Chat. |
Loại
Không dùng nữa: Chuyển sang dùng SpaceType
.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Đã đặt trước. |
ROOM |
Cuộc trò chuyện giữa hai hoặc nhiều người. |
DM |
Tin nhắn trực tiếp 1:1 giữa người dùng và ứng dụng Chat, trong đó tất cả tin nhắn đều ở dạng cố định. Xin lưu ý rằng điều này không bao gồm tin nhắn trực tiếp giữa hai người. |
SpaceBatchUpdatedEventData
Tải trọng sự kiện cho nhiều nội dung cập nhật cho một không gian.
Loại sự kiện: google.workspace.chat.space.v1.batchUpdated
Trường | |
---|---|
spaces[] |
Danh sách các không gian đã cập nhật. |
SpaceEvent
Sự kiện đại diện cho một thay đổi hoặc một hoạt động trong phòng Google Chat. Để tìm hiểu thêm, hãy xem bài viết Làm việc với các sự kiện từ Google Chat.
Trường | |
---|---|
name |
Tên tài nguyên của sự kiện trong không gian. Định dạng |
event_time |
Thời gian khi sự kiện xảy ra. |
event_type |
Loại sự kiện trên không gian. Mỗi loại sự kiện có một phiên bản lô, đại diện cho nhiều lần diễn ra của loại sự kiện xảy ra trong một khoảng thời gian ngắn. Đối với các yêu cầu 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 chương trình hội viên:
Các loại sự kiện được hỗ trợ cho phản ứng:
Các loại sự kiện được hỗ trợ cho không gian:
|
Trường kết hợp
|
|
message_created_event_data |
Tải trọng sự kiện cho một tin nhắn mới. Loại sự kiện: |
message_updated_event_data |
Tải trọng sự kiện cho một thông báo đã cập nhật. Loại sự kiện: |
message_deleted_event_data |
Tải trọng sự kiện cho một thư đã xoá. Loại sự kiện: |
message_batch_created_event_data |
Tải trọng sự kiện cho nhiều tin nhắn mới. Loại sự kiện: |
message_batch_updated_event_data |
Tải trọng sự kiện cho nhiều thông báo được cập nhật. Loại sự kiện: |
message_batch_deleted_event_data |
Tải trọng sự kiện cho nhiều thư đã xoá. Loại sự kiện: |
space_updated_event_data |
Tải trọng sự kiện cho một lần cập nhật không gian. Loại sự kiện: |
space_batch_updated_event_data |
Tải trọng sự kiện cho nhiều nội dung cập nhật cho một không gian. Loại sự kiện: |
membership_created_event_data |
Tải trọng sự kiện cho một gói thành viên mới. Loại sự kiện: |
membership_updated_event_data |
Tải trọng sự kiện cho một gói thành viên đã cập nhật. Loại sự kiện: |
membership_deleted_event_data |
Tải trọng sự kiện cho một gói thành viên đã xoá. Loại sự kiện: |
membership_batch_created_event_data |
Tải trọng sự kiện cho nhiều gói thành viên mới. Loại sự kiện: |
membership_batch_updated_event_data |
Tải trọng sự kiện cho nhiều gói thành viên đã cập nhật. Loại sự kiện: |
membership_batch_deleted_event_data |
Tải trọng sự kiện cho nhiều gói thành viên đã xoá. Loại sự kiện: |
reaction_created_event_data |
Tải trọng sự kiện cho một phản ứng mới. Loại sự kiện: |
reaction_deleted_event_data |
Tải trọng sự kiện cho một phản ứng đã xoá. Loại sự kiện: |
reaction_batch_created_event_data |
Tải trọng sự kiện cho nhiều lượt thể hiện cảm xúc mới. Loại sự kiện: |
reaction_batch_deleted_event_data |
Tải trọng sự kiện cho nhiều phản ứng đã xoá. Loại sự kiện: |
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_read_time |
Không bắt buộc. Thời điểm cập nhật trạng thái đọc không gian của người dùng. Thông thường, giá trị này tương ứng với dấu thời gian của tin nhắn đọc gần đây nhất hoặc dấu thời gian do người dùng chỉ định để đánh dấu vị trí đọc gần đây nhất trong một không gian. |
SpaceUpdatedEventData
Tải trọng sự kiện cho một không gian đã cập nhật.
Loại sự kiện: google.workspace.chat.space.v1.updated
Trường | |
---|---|
space |
Không gian mới được cập nhật. |
Chuỗi hội thoại
Một chuỗi cuộc trò chuyện trong phòng Google Chat. Để biết ví dụ về cách sử dụng, hãy xem phần Bắt đầu hoặc trả lời một chuỗi tin nhắn.
Nếu chỉ định một chuỗi khi tạo thông báo, thì bạn có thể đặt trường messageReplyOption
để xác định điều gì sẽ xảy ra nếu không tìm thấy chuỗi nào trùng khớp.
Trường | |
---|---|
name |
Tên tài nguyên của luồng. Ví dụ: |
thread_key |
Không bắt buộc. Thông tin đầu vào để tạo hoặc cập nhật một chuỗi tin nhắn. Nếu không, chỉ có thể xuất đầu ra. Mã nhận dạng của chuỗi. Hỗ trợ lên đến 4.000 ký tự. Đây là mã nhận dạng duy nhất của ứng dụng Chat đặt ra mã này. Ví dụ: nếu nhiều ứng dụng trong Chat tạo tin nhắn bằng cùng một khoá chuỗi tin nhắn, thì tin nhắn đó sẽ được đăng trong nhiều chuỗi tin nhắn. Để trả lời trong chuỗi tin nhắn do người dùng hoặc một ứng dụng khác trong Chat 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, 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_read_time |
Thời điểm cập nhật trạng thái đọc chuỗi tin nhắn của người dùng. Thông thường, dấu thời gian này tương ứng với dấu thời gian của tin nhắn đọc lần gần đây nhất trong một chuỗi. |
UpdateMembershipRequest
Yêu cầu gửi tin nhắn để cập nhật gói thành viên.
Trường | |
---|---|
membership |
Bắt buộc. Gói thành viên cần cập nhật. Chỉ những trường do |
update_mask |
Bắt buộc. Các đường dẫn của trường cần cập nhật. Hãy phân tách nhiều giá trị bằng dấu phẩy hoặc sử dụng Đường dẫn trường hiện được hỗ trợ:
|
use_admin_access |
true , phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat. Yêu cầu |
UpdateMessageRequest
Yêu cầu cập nhật tin nhắn.
Trường | |
---|---|
message |
Bắt buộc. Đã cập nhật thông báo có các trường. |
update_mask |
Bắt buộc. Các đường dẫn của trường cần cập nhật. Hãy phân tách nhiều giá trị bằng dấu phẩy hoặc sử dụng Đường dẫn trường hiện được hỗ trợ:
|
allow_missing |
Không bắt buộc. Nếu không tìm thấy |
UpdateSpaceReadStateRequest
Thông báo yêu cầu cho UpdateSpaceReadState API.
Trường | |
---|---|
space_read_state |
Bắt buộc. Không gian sẽ đọc trạng thái và các trường cần cập nhật. Chỉ hỗ trợ cập nhật trạng thái đọc cho người dùng gọi. Để tham chiếu đến người dùng gọi, hãy thiết lập một trong các tuỳ chọn sau:
Định dạng: users/{user}/spaces/{space}/spaceReadState |
update_mask |
Bắt buộc. Các đường dẫn của trường cần cập nhật. Đường dẫn trường hiện được hỗ trợ:
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_mask |
Bắt buộc. Các đường dẫn trường đã cập nhật, được phân tách bằng dấu phẩy nếu có nhiều đường dẫn. Bạn có thể cập nhật các trường sau đây cho một không gian:
|
use_admin_access |
true , phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat. Yêu cầu 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 kết quả của một yêu cầu, nếu ứng dụng Chat xác thực với tư cách một người dùng, thì kết quả cho tài nguyên User
chỉ điền sẵn name
và type
của người dùng.
Trường | |
---|---|
name |
Tên tài nguyên của Google Chat Định dạng: Đối với
|
display_name |
Chỉ có đầu ra. Tên hiển thị của người dùng. |
domain_id |
Giá trị nhận dạng duy nhất của miền Google Workspace của người dùng. |
type |
Kiểu người dùng. |
is_anonymous |
Chỉ có đầu ra. Khi |
Loại
Enum | |
---|---|
TYPE_UNSPECIFIED |
Giá trị mặc định của enum. KHÔNG SỬ DỤNG. |
HUMAN |
Người dùng. |
BOT |
Người dùng ứng dụng Chat. |
UserMentionMetadata
Siêu dữ liệu chú thích cho lượt đề cập của người dùng (@).
Trường | |
---|---|
user |
Người dùng đề cập. |
type |
Loại nội dung đề cập đến người dùng. |
Loại
Enum | |
---|---|
TYPE_UNSPECIFIED |
Giá trị mặc định của enum. Không sử dụng. |
ADD |
Thêm người dùng vào không gian. |
MENTION |
Đề cập đến người dùng trong không gian. |
WidgetMarkup
Tiện ích là một thành phần trên giao diện người dùng trình bày văn bản và hình ảnh.
Trường | |
---|---|
buttons[] |
Danh sách các nút. Các nút cũng là |
Trường kết hợp data . WidgetMarkup chỉ có thể chứa một trong các mục sau. Bạn có thể sử dụng nhiều trường WidgetMarkup để hiển thị nhiều mặt hàng hơn. data chỉ có thể là một trong những trạng thái sau đây: |
|
text_paragraph |
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_value |
Hiển thị một mục khoá-giá trị trong tiện ích này. |
Nút
Một nút. Có thể là nút văn bản hoặc nút hình ảnh.
Trường | |
---|---|
Trường kết hợp
|
|
text_button |
Một nút có văn bản và hành động |
image_button |
Một nút có hình ảnh và hành động |
FormAction
Tác vụ biểu mẫu mô tả hành vi khi biểu mẫu được gửi. Ví dụ: bạn có thể gọi Apps Script để xử lý biểu mẫu.
Trường | |
---|---|
action_method_name |
Tên phương thức được dùng để xác định phần nào của biểu mẫu đã kích hoạt việc gửi biểu mẫu. Thông tin này được lặp lại ứng dụng Chat trong sự kiện nhấp thẻ. Bạn có thể sử dụng cùng một tên phương thức cho một số phần tử kích hoạt hành vi phổ biến. |
parameters[] |
Danh sách thông số hành động. |
ActionParameter
Danh sách các tham số chuỗi cần cung cấp khi phương thức hành động được gọi. Ví dụ: hãy xem xét 3 nút tạm ẩn: tạm hoãn ngay bây giờ, tạm hoãn một ngày, tạm hoãn vào tuần tiếp theo. Bạn có thể sử dụng action method = snooze()
để truyền loại tạm ẩn và thời gian tạm ẩn trong danh sách tham số chuỗi.
Trường | |
---|---|
key |
Tên của thông số cho tập lệnh hành động. |
value |
Giá trị của thông số. |
Biểu tượng
Bộ biểu tượng được hỗ trợ.
Enum | |
---|---|
ICON_UNSPECIFIED |
|
AIRPLANE |
|
BOOKMARK |
|
BUS |
|
CAR |
|
CLOCK |
|
CONFIRMATION_NUMBER_ICON |
|
DOLLAR |
|
DESCRIPTION |
|
EMAIL |
|
EVENT_PERFORMER |
|
EVENT_SEAT |
|
FLIGHT_ARRIVAL |
|
FLIGHT_DEPARTURE |
|
HOTEL |
|
HOTEL_ROOM_TYPE |
|
INVITE |
|
MAP_PIN |
|
MEMBERSHIP |
|
MULTIPLE_PEOPLE |
|
OFFER |
|
PERSON |
|
PHONE |
|
RESTAURANT_ICON |
|
SHOPPING_CART |
|
STAR |
|
STORE |
|
TICKET |
|
TRAIN |
|
VIDEO_CAMERA |
|
VIDEO_PLAY |
Bài đăng có hình ảnh
Hình ảnh do URL chỉ định và có thể có thao tác onclick
.
Trường | |
---|---|
image_url |
URL của hình ảnh. |
on_click |
Thao tác |
aspect_ratio |
Tỷ lệ khung hình của hình ảnh này (chiều rộng và chiều cao). Trường này cho phép bạn đặt trước chiều cao phù hợp cho hình ảnh trong khi chờ tải hình ảnh. Chế độ này không nhằm ghi đè tỷ lệ khung hình tích hợp sẵn của hình ảnh. Nếu bạn không đặt chính sách này, máy chủ sẽ điền giá trị bằng cách tìm nạp trước hình ảnh. |
ImageButton
Một nút hình ảnh có thao tác onclick
.
Trường | |
---|---|
on_click |
Thao tác |
name |
Tên của |
Trường kết hợp icons . Biểu tượng có thể được chỉ định bằng Icon enum hoặc URL. icons chỉ có thể là một trong những trạng thái sau đây: |
|
icon |
Biểu tượng do |
icon_url |
Biểu tượng do URL chỉ định. |
KeyValue
Phần tử trên giao diện người dùng chứa khoá (nhãn) và giá trị (nội dung). Phần tử này cũng có thể chứa một số thao tác như nút onclick
.
Trường | |
---|---|
top_label |
Văn bản của nhãn trên cùng. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về việc định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace. |
content |
Văn bản của nội dung. Văn bản được định dạng được hỗ trợ và luôn bắt buộc. Để biết thêm thông tin về việc định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace. |
content_multiline |
Nội dung phải có nhiều dòng hay không. |
bottom_label |
Văn bản của nhãn dưới cùng. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về việc định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace. |
on_click |
Thao tác |
Trường kết hợp icons . Bạn phải xác định ít nhất một trong các biểu tượng, top_label và bottom_label . icons chỉ có thể là một trong những trạng thái sau đây: |
|
icon |
Một giá trị enum được API Chat thay thế bằng hình ảnh biểu tượng tương ứng. |
icon_url |
Biểu tượng do URL chỉ định. |
Trường kết hợp control . Tiện ích điều khiển. Bạn có thể đặt button hoặc switch_widget , nhưng không thể đặt cả hai. control chỉ có thể là một trong những trạng thái sau đây: |
|
button |
Nút mà người dùng có thể nhấp vào để kích hoạt một hành động. |
OnClick
Một thao tác onclick
(ví dụ: mở một đường liên kết).
Trường | |
---|---|
Trường kết hợp
|
|
action |
Hành động |
open_link |
Thao tác |
OpenLink
Một đường liên kết sẽ 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à hành động onclick
.
Trường | |
---|---|
text |
Văn bản của nút. |
on_click |
Hành động |
TextParagraph
Đoạn văn bản. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về việc định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.
Trường | |
---|---|
text |
|