- Tài nguyên: Message
- Biểu diễn dưới dạng JSON
- Thẻ
- CardHeader
- ImageStyle
- Section
- WidgetMarkup
- TextParagraph
- Hình ảnh
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- Biểu tượng
- Nút
- TextButton
- ImageButton
- CardAction
- CardWithId
- Thẻ
- CardHeader
- ImageType
- Section
- Tiện ích
- TextParagraph
- TextSyntax
- Hình ảnh
- OnClick
- Hành động
- ActionParameter
- LoadIndicator
- Tương tác
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- Biểu tượng
- MaterialIcon
- DecoratedText
- VerticalAlignment
- Nút
- Màu sắc
- Loại
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Loại
- Đề xuất
- SuggestionItem
- Xác thực
- InputType
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- WorkflowDataSourceMarkup
- Loại
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- DataSourceConfig
- DateTimePicker
- DateTimePickerType
- Divider
- Lưới
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- Cột
- Cột
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Tiện ích
- ChipList
- Bố cục
- Khối
- Băng chuyền
- CarouselCard
- NestedWidget
- Chế độ hiển thị
- EventAction
- Điều kiện kích hoạt
- CommonWidgetAction
- UpdateVisibilityAction
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- ExpressionData
- Tình trạng
- ExpressionDataCondition
- ConditionType
- Chú thích
- AnnotationType
- UserMentionMetadata
- Loại
- SlashCommandMetadata
- Loại
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- MeetSpaceLinkData
- Loại
- HuddleStatus
- CalendarEventLinkData
- CustomEmojiMetadata
- Luồng
- ActionResponse
- ResponseType
- DialogAction
- Hộp thoại
- ActionStatus
- Mã
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- QuoteType
- QuotedMessageSnapshot
- ForwardedMetadata
- AttachedGif
- AccessoryWidget
- Phần tử
- CitedSource
- Đoạn trích
- ElementsImage
- Chân trang
- Trích dẫn
- MarkupSyntax
- Phương thức
Tài nguyên: Tin nhắn
Một tin nhắn trong phòng Google Chat.
| Biểu diễn dưới dạng JSON |
|---|
{ "name": string, "sender": { object ( |
| 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ột mã nhận dạng tuỳ chỉnh khi tạo thông báo, bạn có thể dùng mã nhận dạng này để chỉ định thông báo trong một yêu cầu bằng cách thay thế |
sender |
Chỉ có đầu ra. Người dùng đã tạo tin nhắn. 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ì đầu ra sẽ chỉ điền vào các trường user |
createTime |
Không bắt buộc. Không thể thay đổi. Đối với không gian được tạo trong Chat, đây là thời điểm tạo tin nhắn. Trường này chỉ có đầu ra, trừ trường hợp đượ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 trong quá khứ mà tại đó thông báo được tạo trong nguồn để giữ nguyên thời gian tạo ban đầu. |
lastUpdateTime |
Chỉ có đầu ra. Thời gian mà người dùng chỉnh sửa tin nhắn lần gần đây nhất. Nếu tin nhắn chưa từng được chỉnh sửa, trường này sẽ trống. |
deleteTime |
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ưới dạ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 hoặc tất 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. |
formattedText |
Chỉ có đầu ra. Chứa thông báo
Để biết thêm thông tin, hãy xem bài viết Xem định dạng văn bản được gửi trong tin nhắn |
cards[] |
Không dùng nữa: Thay vào đó, hãy sử dụng Các thẻ đa 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 phần tử 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 phần nội dung dạng văn bản thuần tuý của thư. |
cardsV2[] |
Không bắt buộc. Một mảng thẻ. Các ứng dụng nhắn tin có thể tạo thẻ bằng tính năng xác thực ứng dụng. Trong Chương trình dùng thử dành cho nhà phát triển, nếu ứng dụng Chat của bạn xác thực dưới dạng người dùng, thì ứng dụng đó có thể tạo thông báo dạng thẻ. Nếu ứng dụng Chat của bạn không thuộc Chương trình Bản dùng trước cho nhà phát triển, thì ứng dụng đó không thể tạo thẻ có xác thực người dùng. Để tìm hiểu cách tạo một tin nhắn có 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 có thể được liên kết với phần nội dung văn bản thuần tuý của thư hoặc với các khối liên kết đến các tài nguyên của Google Workspace như Google Tài liệu hoặc Trang tính có |
thread |
Chuỗi thư 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 một chuỗi tin nhắn. |
space |
Chỉ có đầu ra. Nếu ứng dụng Chat của bạn xác thực dưới dạng người dùng, thì đầu ra sẽ chỉ điền vào không gian |
fallbackText |
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ế, chẳng hạn như thông báo trên thiết bị di động. |
actionResponse |
Chỉ có đầu vào. Các tham số mà ứng dụng Chat có thể dùng để định cấu hình cách đăng câu trả lời. |
argumentText |
Chỉ có đầu ra. Nội dung tin nhắn ở dạng văn bản thuần tuý, không có nội dung đề cập đến ứng dụng Chat. |
slashCommand |
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. |
matchedUrl |
Chỉ có đầu ra. Một URL trong trường |
threadReply |
Chỉ có đầu ra. Khi Nếu không gian không hỗ trợ tính năng trả lời theo chuỗi, thì trường này luôn là |
silent |
Chỉ có đầu ra. Đây có phải là tin nhắn không có âm thanh hay không. Tin nhắn im lặng là những tin nhắn mà Chat sẽ chặn thông báo đẩy cho người nhận. |
clientAssignedMessageId |
Không bắt buộc. Mã nhận dạng tuỳ chỉnh cho thông báo. Bạn có thể dùng trường này để xác định một tin nhắn, hoặc để nhận, xoá hoặc cập nhật một tin nhắn. Để đặt một mã nhận dạng tuỳ chỉnh, hãy chỉ định trường |
emojiReactionSummaries[] |
Chỉ có đầu ra. Danh sách tóm tắt về lượt thể hiện cảm xúc bằng biểu tượng trên tin nhắn. |
privateMessageViewer |
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 tin nhắn. Khi được đặt, thông báo sẽ là 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 Chat API bằng cách sử dụng 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ư. |
deletionMetadata |
Chỉ có đầu ra. Thông tin về thư đã bị xoá. Một thông báo sẽ bị xoá khi |
quotedMessageMetadata |
Không bắt buộc. Thông tin về một thư mà một thư khác trích dẫn. Khi tạo tin nhắn, bạn có thể trích dẫn tin nhắn trong cùng một chuỗi hoặc trích dẫn tin nhắn gốc để tạo tin nhắn gốc mới. Tuy nhiên, bạn không thể trích dẫn một câu trả lời trong một chuỗi tin nhắn khác. Khi cập nhật một thông báo, bạn không thể thêm hoặc thay thế trường Để biết ví dụ về cách sử dụng, hãy xem phần Trích dẫn một tin nhắn khác. |
attachedGifs[] |
Chỉ có đầu ra. Ảnh GIF được đính kèm vào tin nhắn. |
accessoryWidgets[] |
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ông báo. Bạn có thể thêm các tiện ích bổ sung vào những tin nhắn có chứa văn bản, thẻ hoặc cả văn bản và thẻ. Không hỗ trợ những tin nhắn có chứa hộp thoại. Để biết chi tiết, hãy xem bài viết Thêm tiện ích tương tác ở cuối tin nhắn. Để tạo một thông báo có các tiện ích bổ sung, bạn cần xác thực ứng dụng. |
elements |
Không bắt buộc. Phần tử là các thành phần bổ sung được cung cấp trong quá trình tạo thông báo, có thể liên kết hoặc không liên kết với các phần cụ thể của văn bản thông báo. Những thông tin này khác với chú thích (chỉ có đầu ra và cung cấp thông tin bổ sung liên kết với các đoạn thông báo hoặc toàn bộ nội dung thông báo). |
markupSyntax |
Không bắt buộc. Chỉ định cách máy chủ diễn giải nội dung trường |
CardWithId
Một thẻ trong tin nhắn trò chuyện trên Google Chat.
Các ứng dụng nhắn tin có thể tạo thẻ bằng tính năng xác thực ứng dụng. Trong Chương trình dùng thử dành cho nhà phát triển, nếu ứng dụng Chat của bạn xác thực dưới dạng người dùng, thì ứng dụng đó có thể tạo thông báo dạng thẻ. Nếu ứng dụng Chat của bạn không thuộc Chương trình Bản dùng trước cho nhà phát triển, thì ứng dụng đó không thể tạo thẻ có xác thực người dùng.
Để tìm hiểu cách tạo một tin nhắn có 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ẻ| Biểu diễn dưới dạng JSON |
|---|
{
"cardId": string,
"card": {
object ( |
| Trường | |
|---|---|
cardId |
Bắt buộc nếu thông báo chứa nhiều thẻ. Giá trị nhận dạng riêng biệt cho một thẻ trong thông báo. |
card |
Thẻ. Kích thước tối đa là 32 KB. |
Annotation
Chú thích có thể được liên kết với phần nội dung văn bản thuần tuý của thư hoặc với các khối liên kết đến các tài nguyên của Google Workspace như Google Tài liệu hoặc Trang tính có startIndex và length bằng 0. Để 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ạ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"
}
}]
| Biểu diễn dưới dạng JSON |
|---|
{ "type": enum ( |
| Trường | |
|---|---|
type |
Loại chú thích này. |
length |
Độ dài của chuỗi con trong nội dung thư ở dạng văn bản thuần tuý mà chú thích này tương ứng. Nếu không có, tức là độ dài bằng 0. |
startIndex |
Chỉ mục bắt đầu (dựa trên 0, bao gồm) trong nội dung thư ở dạng văn bản thuần tuý mà chú giải này tương ứng. |
| Siêu dữ liệu bổ sung về chú giải. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
userMention |
Siêu dữ liệu về lượt đề cập đến người dùng. |
slashCommand |
Siêu dữ liệu cho một lệnh dấu gạch chéo. |
richLinkMetadata |
Siêu dữ liệu cho một đường liên kết đa dạng. |
customEmojiMetadata |
Siêu dữ liệu của một biểu tượng cảm xúc tuỳ chỉnh. |
| Kết thúc các trường loại trừ lẫn nhau. | |
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 |
Một lệnh dấu gạch chéo được gọi. |
RICH_LINK |
Chú thích đường liên kết đa dạng. |
CUSTOM_EMOJI |
Chú thích biểu tượng cảm xúc tuỳ chỉnh. |
UserMentionMetadata
Siêu dữ liệu chú thích cho lượt đề cập đến người dùng (@).
| Biểu diễn dưới dạng JSON |
|---|
{ "user": { object ( |
| Trường | |
|---|---|
user |
Người dùng được đề cập. |
type |
Loại thông tin đề 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. |
SlashCommandMetadata
Siêu dữ liệu chú thích cho lệnh dấu gạch chéo (/).
| Biểu diễn dưới dạng JSON |
|---|
{ "bot": { object ( |
| Trường | |
|---|---|
bot |
Ứng dụng Chat có lệnh đã được gọi. |
type |
Loại lệnh dấu gạch chéo. |
commandName |
Tên của lệnh dấu gạch chéo được gọi. |
commandId |
Mã lệnh của lệnh dấu gạch chéo được gọi. |
triggersDialog |
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. |
RichLinkMetadata
Đường liên kết nhiều định dạng đến một tài nguyên. Bạn có thể liên kết đường liên kết đa dạng thức với phần nội dung dạng văn bản thuần tuý của thư hoặc thể hiện các khối liên kết đến các tài nguyên của Google Workspace như Google Tài liệu hoặc Trang tính bằng startIndex và length của 0.
| Biểu diễn dưới dạng JSON |
|---|
{ "uri": string, "richLinkType": enum ( |
| Trường | |
|---|---|
uri |
URI của đường liên kết này. |
richLinkType |
Loại đường liên kết đa dạng. |
| Dữ liệu cho tài nguyên được liên kết. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
driveLinkData |
Dữ liệu cho một đường liên kết đến Drive. |
chatSpaceLinkData |
Dữ liệu cho đường liên kết đến không gian trò chuyện. |
meetSpaceLinkData |
Dữ liệu cho đường liên kết đến không gian trên Meet. |
calendarEventLinkData |
Dữ liệu cho đường liên kết đến sự kiện trên Lịch. |
| Kết thúc các trường loại trừ lẫn nhau. | |
RichLinkType
Loại đường liên kết đa dạng. Sau này, 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 cho enum. Không sử dụng. |
DRIVE_FILE |
Một loại đường liên kết đa dạng thức của Google Drive. |
CHAT_SPACE |
Một loại đường liên kết đa dạng thức của không gian trên Chat. Ví dụ: khối thông minh cho không gian. |
GMAIL_MESSAGE |
Một loại đường liên kết đa dạng thức của thư trong Gmail. Cụ thể là một thẻ Gmail từ tính năng Chia sẻ với Chat. API này chỉ hỗ trợ việc đọc thư có đường liên kết đa dạng thức GMAIL_MESSAGE. |
MEET_SPACE |
Một loại đường liên kết đa dạng thức trong tin nhắn trên Meet. Ví dụ: khối Meet. |
CALENDAR_EVENT |
Một loại đường liên kết đa dạng thức của thông báo trên Lịch. Ví dụ: Khối lịch. |
DriveLinkData
Dữ liệu cho đường liên kết đến Google Drive.
| Biểu diễn dưới dạng JSON |
|---|
{
"driveDataRef": {
object ( |
| Trường | |
|---|---|
driveDataRef |
Một DriveDataRef tham chiếu đến một tệp trên Google Drive. |
mimeType |
Loại MIME của tài nguyên được liên kết trên Google Drive. |
ChatSpaceLinkData
Dữ liệu cho đường liên kết đến phòng Chat.
| Biểu diễn dưới dạng JSON |
|---|
{ "space": string, "thread": string, "message": string } |
| Trường | |
|---|---|
space |
Không gian của tài nguyên không gian trong Chat được liên kết. Định dạng |
thread |
Chuỗi của tài nguyên không gian Chat được liên kết. Định dạng |
message |
Tin nhắn của tài nguyên phòng Chat được liên kết. Định dạng |
MeetSpaceLinkData
Dữ liệu cho đường liên kết đến không gian trên Meet.
| Biểu diễn dưới dạng JSON |
|---|
{ "meetingCode": string, "type": enum ( |
| Trường | |
|---|---|
meetingCode |
Mã cuộc họp của không gian Meet được liên kết. |
type |
Cho biết loại không gian Meet. |
huddleStatus |
Không bắt buộc. Chỉ có đầu ra. Nếu Meet là một cuộc gặp mặt, thì cột này sẽ cho biết trạng thái của cuộc gặp mặt. Nếu không, giá trị này sẽ không được đặt. |
Loại
Loại không gian Meet.
| Enum | |
|---|---|
TYPE_UNSPECIFIED |
Giá trị mặc định cho enum. Không sử dụng. |
MEETING |
Không gian Meet là một cuộc họp. |
HUDDLE |
Không gian Meet là một cuộc họp nhóm. |
HuddleStatus
Trạng thái của cuộc trò chuyện nhóm
| Enum | |
|---|---|
HUDDLE_STATUS_UNSPECIFIED |
Giá trị mặc định cho enum. Không sử dụng. |
STARTED |
Cuộc họp nhanh đã bắt đầu. |
ENDED |
Huddle đã kết thúc. Trong trường hợp này, URI và giá trị nhận dạng của phòng họp trên Meet sẽ không còn hợp lệ nữa. |
MISSED |
Bạn đã bỏ lỡ một huddle. Trong trường hợp này, URI và giá trị nhận dạng của phòng họp trên Meet sẽ không còn hợp lệ nữa. |
CalendarEventLinkData
Dữ liệu cho đường liên kết đến sự kiện trên Lịch.
| Biểu diễn dưới dạng JSON |
|---|
{ "calendarId": string, "eventId": string } |
| Trường | |
|---|---|
calendarId |
Mã nhận dạng Lịch của Lịch được liên kết. |
eventId |
Giá trị nhận dạng sự kiện của sự kiện được liên kết trên Lịch. |
CustomEmojiMetadata
Siêu dữ liệu chú thích cho biểu tượng cảm xúc tuỳ chỉnh.
| Biểu diễn dưới dạng JSON |
|---|
{
"customEmoji": {
object ( |
| Trường | |
|---|---|
customEmoji |
Biểu tượng cảm xúc tuỳ chỉnh. |
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 một chuỗi tin nhắn.
Nếu chỉ định một luồng khi tạo tin nhắn, 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 luồng nào khớp.
| Biểu diễn dưới dạng JSON |
|---|
{ "name": string, "threadKey": string } |
| Trường | |
|---|---|
name |
Giá trị nhận dạng. Tên tài nguyên của luồng. Ví dụ: |
threadKey |
Không bắt buộc. Đầu vào để tạo hoặc cập nhật một chuỗi. Nếu không, chỉ có đầu ra. Mã nhận dạng của chuỗi. Hỗ trợ tối đa 4.000 ký tự. Mã nhận dạng này là duy nhất đối với ứng dụng Chat đặt mã nhận dạng đó. Ví dụ: nếu nhiều ứng dụng Chat tạo một tin nhắn bằng cùng một khoá luồng, thì các tin nhắn đó sẽ được đăng trong các luồng 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 |
ActionResponse
Các tham số mà ứng dụng Chat có thể dùng để định cấu hình cách đăng câu trả lời.
| Biểu diễn dưới dạng JSON |
|---|
{ "type": enum ( |
| Trường | |
|---|---|
type |
Chỉ có đầu vào. Loại phản hồi của ứng dụng Chat. |
url |
Chỉ có đầu vào. URL để người dùng xác thực hoặc định cấu hình. (Chỉ dành cho loại phản hồi |
dialogAction |
Chỉ có đầu vào. Phản hồi một sự kiện tương tác liên quan đến một hộp thoại. Phải đi kèm với |
updatedWidget |
Chỉ có đầu vào. 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 đối với sự kiện CARD_CLICKED khi loại người 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. Bạn chỉ được phép sử dụng phương thức này để phản hồi sự kiện MESSAGE có URL trùng khớp hoặc sự kiện CARD_CLICKED trong đó loại người 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 về các lựa chọn tự động hoàn thành văn bản của tiện ích. |
DialogAction
Chứa một hộp thoại và mã trạng thái yêu cầu.
| Biểu diễn dưới dạng JSON |
|---|
{ "actionStatus": { object ( |
| Trường | |
|---|---|
actionStatus |
Chỉ có đầu vào. Trạng thái của yêu cầu gọi hoặc gửi một 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. |
| Hành động cần thực hiện. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
dialog |
Chỉ có đầu vào. Hộp thoại cho yêu cầu. |
| Kết thúc các trường loại trừ lẫn nhau. | |
Hộp thoại
Trình bao bọc xung quanh nội dung thẻ của hộp thoại.
| Biểu diễn dưới dạng JSON |
|---|
{
"body": {
object ( |
| Trường | |
|---|---|
body |
Chỉ có đầu vào. Nội dung của hộp thoại, được kết xuất trong một phương thức. Các ứng dụng Google Chat không hỗ trợ những thực thể thẻ sau: |
ActionStatus
Biểu thị trạng thái của yêu cầu gọi hoặc gửi một hộp thoại.
| Biểu diễn dưới dạng JSON |
|---|
{
"statusCode": enum ( |
| Trường | |
|---|---|
statusCode |
Mã trạng thái. |
userFacingMessage |
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, thì một thông báo chung dựa trên |
Mã
Mã lỗi chuẩn cho các API gRPC.
Đôi khi, nhiều mã lỗi có thể áp dụng. Các dịch vụ phải trả về mã lỗi cụ thể nhất có thể áp dụng. Ví dụ: ưu tiên OUT_OF_RANGE hơn FAILED_PRECONDITION nếu cả hai mã đều áp dụng. Tương tự, hãy ưu tiên NOT_FOUND hoặc ALREADY_EXISTS hơn FAILED_PRECONDITION.
| Enum | |
|---|---|
OK |
Không phải là lỗi; được trả về khi thành công. Ánh xạ HTTP: 200 OK |
CANCELLED |
Thao tác đã bị huỷ, thường là do người gọi. Ánh xạ HTTP: 499 Client Closed Request (Yêu cầu đã đóng của máy khách) |
UNKNOWN |
Lỗi không xác định. Ví dụ: lỗi này có thể được trả về khi giá trị Ánh xạ HTTP: 500 Lỗi máy chủ nội bộ |
INVALID_ARGUMENT |
Ứng dụng khách chỉ định đối số không hợp lệ. Xin lưu ý rằng thuộc tính này khác với Ánh xạ HTTP: 400 Yêu cầu không hợp lệ |
DEADLINE_EXCEEDED |
Thời hạn đã hết trước khi thao tác có thể hoàn tất. Đối với các thao tác thay đổi trạng thái của hệ thống, lỗi này có thể được trả về ngay cả khi thao tác đã hoàn tất thành công. Ví dụ: phản hồi thành công từ một máy chủ có thể bị trì hoãn đủ lâu để thời hạn kết thúc. Ánh xạ HTTP: 504 Hết thời gian chờ của cổng nối |
NOT_FOUND |
Không tìm thấy một số thực thể được yêu cầu (ví dụ: tệp hoặc thư mục). Lưu ý cho nhà phát triển máy chủ: nếu một yêu cầu bị từ chối đối với toàn bộ nhóm người dùng, chẳng hạn như việc triển khai tính năng từng bước hoặc danh sách cho phép không có trong tài liệu, thì bạn có thể sử dụng Liên kết HTTP: 404 Không tìm thấy |
ALREADY_EXISTS |
Đối tượng mà một ứng dụng đã cố gắng tạo (ví dụ: tệp hoặc thư mục) đã tồn tại. Ánh xạ HTTP: Xung đột 409 |
PERMISSION_DENIED |
Trình gọi không có quyền thực hiện thao tác đã chỉ định. Bạn không được dùng Ánh xạ HTTP: 403 Bị cấm |
UNAUTHENTICATED |
Yêu cầu không có thông tin xác thực hợp lệ cho thao tác. Liên kết HTTP: 401 Không được phép |
RESOURCE_EXHAUSTED |
Một số tài nguyên đã cạn kiệt, có thể là hạn mức cho mỗi người dùng hoặc có thể toàn bộ hệ thống tệp đã hết dung lượng. Ánh xạ HTTP: 429 Quá nhiều yêu cầu |
FAILED_PRECONDITION |
Thao tác bị từ chối vì hệ thống không ở trạng thái cần thiết để thực hiện thao tác. Ví dụ: thư mục cần xoá không phải là thư mục trống, thao tác rmdir được áp dụng cho một thư mục không phải là thư mục, v.v. Người triển khai dịch vụ có thể sử dụng các nguyên tắc sau để quyết định giữa Ánh xạ HTTP: 400 Yêu cầu không hợp lệ |
ABORTED |
Thao tác đã bị huỷ, thường là do vấn đề về tính đồng thời, chẳng hạn như lỗi kiểm tra bộ đánh số thứ tự hoặc giao dịch bị huỷ. Hãy xem các nguyên tắc ở trên để quyết định giữa Ánh xạ HTTP: Xung đột 409 |
OUT_OF_RANGE |
Thao tác được thực hiện ngoài phạm vi hợp lệ. Ví dụ: tìm kiếm hoặc đọc quá cuối tệp. Không giống như Có khá nhiều điểm trùng lặp giữa Ánh xạ HTTP: 400 Yêu cầu không hợp lệ |
UNIMPLEMENTED |
Thao tác này chưa được triển khai hoặc không được hỗ trợ/bật trong dịch vụ này. Liên kết HTTP: 501 Not Implemented |
INTERNAL |
Lỗi nội bộ. Điều này có nghĩa là một số bất biến mà hệ thống cơ bản mong đợi đã bị phá vỡ. Mã lỗi này dành riêng cho các lỗi nghiêm trọng. Ánh xạ HTTP: 500 Lỗi máy chủ nội bộ |
UNAVAILABLE |
Dịch vụ này hiện không dùng được. Đây thường là một điều kiện tạm thời và bạn có thể khắc phục bằng cách thử lại với độ trễ. Xin lưu ý rằng không phải lúc nào bạn cũng nên thử lại các thao tác không có tính chất luỹ đẳng. Hãy xem các nguyên tắc ở trên để quyết định giữa Liên kết HTTP: 503 Không có dịch vụ |
DATA_LOSS |
Mất hoặc hỏng dữ liệu không thể khôi phục. Ánh xạ HTTP: 500 Lỗi máy chủ nội bộ |
UpdatedWidget
Đối với các tiện ích selectionInput, trả về các đề xuất tự động hoàn thành cho một trình đơn chọn nhiều mục.
| Biểu diễn dưới dạng JSON |
|---|
{
"widget": string,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"suggestions": {
object ( |
| Trường | |
|---|---|
widget |
Mã nhận dạng của tiện ích đã cập nhật. Giá trị nhận dạng này phải khớp với giá trị nhận dạng của tiện ích đã kích hoạt yêu cầu cập nhật. |
| Tiện ích được cập nhật để phản hồi một hành động của người dùng. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
suggestions |
Danh sách kết quả tự động hoàn thành của tiện ích |
| Kết thúc các trường loại trừ lẫn nhau. | |
SelectionItems
Danh sách kết quả tự động hoàn thành của tiện ích.
| Biểu diễn dưới dạng JSON |
|---|
{
"items": [
{
object ( |
| Trường | |
|---|---|
items[] |
Một mảng gồm các đối tượng SelectionItem. |
SlashCommand
Siêu dữ liệu về một lệnh dấu gạch chéo trong Google Chat.
| Biểu diễn dưới dạng JSON |
|---|
{ "commandId": string } |
| Trường | |
|---|---|
commandId |
Mã của lệnh dấu gạch chéo. |
MatchedUrl
Một URL trùng khớp trong tin nhắn trò chuyện. Các ứng dụng trò chuyện có thể xem trước các URL trùng khớp. Để biết thêm thông tin, hãy xem phần Xem trước đường liên kết.
| Biểu diễn dưới dạng JSON |
|---|
{ "url": string } |
| Trường | |
|---|---|
url |
Chỉ có đầu ra. URL trùng khớp. |
EmojiReactionSummary
Số người thể hiện cảm xúc bằng một biểu tượng cụ thể đối với một tin nhắn.
| Biểu diễn dưới dạng JSON |
|---|
{
"emoji": {
object ( |
| Trường | |
|---|---|
emoji |
Chỉ có đầu ra. Biểu tượng cảm xúc liên kết với các lượt thể hiện cảm xúc. |
reactionCount |
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 liên quan. |
DeletionMetadata
Thông tin về thư đã bị xoá. Một thông báo sẽ bị xoá khi deleteTime được đặt.
| Biểu diễn dưới dạng JSON |
|---|
{
"deletionType": enum ( |
| Trường | |
|---|---|
deletionType |
Cho biết người đã xoá tin nhắn. |
DeletionType
Ai đã xoá tin nhắn và cách xoá tin nhắn. Sau này, chúng tôi có thể thêm nhiều giá trị khác. Hãy xem bài viết Chỉnh sửa hoặc xoá tin nhắn trong Google Chat để biết thông tin chi tiết về thời điểm bạn có thể xoá tin nhắn.
| Enum | |
|---|---|
DELETION_TYPE_UNSPECIFIED |
Giá trị này không được dùng. |
CREATOR |
Người dùng đã xoá tin nhắn của chính họ. |
SPACE_OWNER |
Chủ sở hữu hoặc người quản lý đã xoá tin nhắn. |
ADMIN |
Quản trị viên Google Workspace đã xoá tin nhắn. Quản trị viên có thể xoá mọi tin nhắn trong không gian, kể cả tin nhắn do bất kỳ thành viên nào trong không gian hoặc ứng dụng Chat gửi. |
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 đã xoá tin nhắn thay cho nhà sáng tạo (bằng cách sử dụng tính năng xác thực người dùng). |
SPACE_OWNER_VIA_APP |
Một ứng dụng Chat đã xoá tin nhắn thay cho người quản lý không gian (bằng cách sử dụng quy trình xác thực người dùng). |
SPACE_MEMBER |
Một thành viên của không gian đã xoá tin nhắn. Người dùng có thể xoá tin nhắn do ứng dụng gửi. |
QuotedMessageMetadata
Thông tin về một thư mà một thư khác trích dẫn.
Khi cập nhật một thông báo, bạn không thể thêm hoặc thay thế trường quotedMessageMetadata, nhưng có thể xoá trường này.
Để biết ví dụ về cách sử dụng, hãy xem phần Trích dẫn một tin nhắn khác.
| Biểu diễn dưới dạng JSON |
|---|
{ "name": string, "lastUpdateTime": string, "quoteType": enum ( |
| Trường | |
|---|---|
name |
Bắt buộc. Tên tài nguyên của thông báo được trích dẫn. Định dạng |
lastUpdateTime |
Bắt buộc. 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. Nếu tin nhắn đã được chỉnh sửa, hãy sử dụng trường này Nếu |
quoteType |
Không bắt buộc. Chỉ định loại trích dẫn. Nếu không được đặt, thì hệ thống sẽ mặc định là REPLY trong đường dẫn đọc/ghi thư để đảm bảo khả năng tương thích ngược. |
quotedMessageSnapshot |
Chỉ có đầu ra. Ảnh chụp nhanh nội dung của tin nhắn được trích dẫn. |
forwardedMetadata |
Chỉ có đầu ra. Siêu dữ liệu về không gian nguồn của tin nhắn được trích dẫn. Chỉ được điền sẵn cho loại báo giá CHUYỂN TIẾP. |
QuoteType
Loại trích dẫn của tin nhắn được trích dẫn.
| Enum | |
|---|---|
QUOTE_TYPE_UNSPECIFIED |
Đã đặt trước. Giá trị này không được dùng. |
REPLY |
Khi
|
FORWARD |
Khi
|
QuotedMessageSnapshot
Cung cấp ảnh chụp nhanh nội dung của tin nhắn được trích dẫn tại thời điểm trích dẫn hoặc chuyển tiếp
| Biểu diễn dưới dạng JSON |
|---|
{ "sender": string, "text": string, "formattedText": string, "annotations": [ { object ( |
| Trường | |
|---|---|
sender |
Chỉ có đầu ra. Tên tác giả của tin nhắn được trích dẫn. Được điền sẵn cho cả loại trích dẫn TRẢ LỜI và CHUYỂN TIẾP. |
text |
Chỉ có đầu ra. Ảnh chụp nhanh nội dung văn bản của tin nhắn được trích dẫn. |
formattedText |
Chỉ có đầu ra. Chứa tin nhắn được trích dẫn |
annotations[] |
Chỉ có đầu ra. Chú giải được phân tích cú pháp từ nội dung văn bản của thư được trích dẫn. Chỉ được điền sẵn cho loại báo giá CHUYỂN TIẾP. |
attachments[] |
Chỉ có đầu ra. Tệp đính kèm trong thư được trích dẫn. Đây là bản sao của siêu dữ liệu tệp đính kèm trong thư được trích dẫn. Chỉ được điền sẵn cho loại báo giá CHUYỂN TIẾP. |
ForwardedMetadata
Siêu dữ liệu về không gian nguồn mà từ đó tin nhắn được chuyển tiếp.
| Biểu diễn dưới dạng JSON |
|---|
{ "space": string, "spaceDisplayName": string } |
| Trường | |
|---|---|
space |
Chỉ có đầu ra. Tên tài nguyên của không gian nguồn. Định dạng: spaces/{space} |
spaceDisplayName |
Chỉ có đầu ra. Tên hiển thị của không gian hoặc tin nhắn trực tiếp nguồn tại thời điểm chuyển tiếp. Đối với |
AttachedGif
Một ảnh GIF được chỉ định bằng URL.
| Biểu diễn dưới dạng JSON |
|---|
{ "uri": string } |
| Trường | |
|---|---|
uri |
Chỉ có đầu ra. URL lưu trữ ảnh GIF. |
AccessoryWidget
Một hoặc nhiều tiện ích tương tác xuất hiện ở cuối thông báo. Để biết chi tiết, hãy xem bài viết Thêm tiện ích tương tác ở cuối tin nhắn.
| Biểu diễn dưới dạng JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"buttonList": {
object ( |
| Trường | |
|---|---|
| Loại hành động. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
buttonList |
Danh sách các nút. |
| Kết thúc các trường loại trừ lẫn nhau. | |
Phần tử
| Biểu diễn dưới dạng JSON |
|---|
{ "citedSources": [ { object ( |
| Trường | |
|---|---|
citedSources[] |
Danh sách các nguồn sẽ xuất hiện bên dưới thông báo dưới dạng đường liên kết ở chân trang. Những phần tử này không được tham chiếu nội tuyến. Đối với các tham chiếu nội dòng, hãy dùng |
citations[] |
Danh sách các trích dẫn nội tuyến được tham chiếu trong văn bản thông báo (thông qua thẻ |
CitedSource
| Biểu diễn dưới dạng JSON |
|---|
{ "title": string, "uri": string, "snippet": { object ( |
| Trường | |
|---|---|
title |
Bắt buộc. Tiêu đề văn bản thuần tuý của |
uri |
Bắt buộc. URI trỏ đến tài nguyên mà |
snippet |
Không bắt buộc. Đoạn trích chứa thông tin trực tiếp từ nguồn. |
footer |
Không bắt buộc. Thông tin bổ sung xuất hiện cùng với đoạn trích dưới dạng chân trang. |
Đoạn trích
| Biểu diễn dưới dạng JSON |
|---|
{
"text": string,
"imagePreview": {
object ( |
| Trường | |
|---|---|
text |
Không bắt buộc. Một đoạn trích ngắn bằng văn bản thuần tuý lấy trực tiếp từ kho ngữ liệu có thể xuất hiện trong Chat. Không hỗ trợ định dạng markdown. |
imagePreview |
Không bắt buộc. Bản xem trước hình ảnh của đoạn trích được cung cấp dưới dạng dữ liệu đầu vào khi tạo trích dẫn. |
ElementsImage
| Biểu diễn dưới dạng JSON |
|---|
{ "imageUri": string } |
| Trường | |
|---|---|
| Bắt buộc. Một trong các biểu diễn hình ảnh được hỗ trợ. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
imageUri |
Bắt buộc. Một URI có thể truy cập công khai cho hình ảnh. |
| Kết thúc các trường loại trừ lẫn nhau. | |
Trích dẫn
<chat-citation data-id="{id}">{text}</chat-citation>. Chú thích chỉ được hỗ trợ khi markupSyntax của thông báo được đặt thành MARKDOWN.Các trích dẫn không được tham chiếu trong Elements.citations (những trích dẫn không có thẻ <chat-citation> tương ứng trong văn bản thư) sẽ bị bỏ qua và không khiến thư bị từ chối.
| Biểu diễn dưới dạng JSON |
|---|
{
"id": string,
"citedSources": [
{
object ( |
| Trường | |
|---|---|
id |
Bắt buộc. Mã do ứng dụng xác định. Chỉ được chứa chữ cái và số ASCII, đồng thời có ít hơn 63 ký tự. |
citedSources[] |
Không bắt buộc. Danh sách các nguồn có liên quan đến câu trích dẫn. Nguồn được hiển thị trong thẻ di chuột của câu trích dẫn. |
MarkupSyntax
Chỉ định cú pháp đánh dấu dùng để định dạng văn bản tin nhắn trò chuyện. Áp dụng cho trường text của tài nguyên Message.
| Enum | |
|---|---|
MARKUP_SYNTAX_UNSPECIFIED |
Biểu thị giá trị không xác định. |
MARKUP_SYNTAX_CHAT |
Sử dụng cú pháp đánh dấu của Google Chat. Hãy xem https://developers.google.com/workspace/chat/format-messages#format-texts để biết thêm thông tin. |
MARKUP_SYNTAX_MARKDOWN |
Sử dụng cú pháp Markdown. Cú pháp này dựa trên quy cách CommonMark, có thêm các tiện ích. Hãy xem https://developers.google.com/workspace/chat/format-messages#format-texts để biết thêm thông tin. |
Phương thức |
|
|---|---|
|
Tạo tin nhắn trong một không gian trên Google Chat. |
|
Xoá một tin nhắn. |
|
Trả về thông tin chi tiết về một tin nhắn. |
|
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. |
|
Cập nhật một tin nhắn. |
|
Thay thế các thẻ có trong một tin nhắn. |
|
Tìm kiếm những tin nhắn trong Google Chat mà người dùng gọi có quyền truy cập. |
|
Cập nhật một tin nhắn. |