- Tài nguyên: Tin nhắn
- Thẻ
- CardHeader
- ImageStyle
- Mục
- Đánh dấu tiện ích
- Đoạn văn bản
- Hình ảnh
- Khi nhấp chuột
- FormAction
- ActionParameter
- OpenLink (Mở đường liên kết)
- Giá trị khoá
- Biểu tượng
- Nút
- TextButton
- ImageButton
- CardAction
- CardWithId
- Thẻ
- CardHeader
- Loại hình ảnh
- Mục
- Tiện ích
- Đoạn văn bản
- Hình ảnh
- Khi nhấp chuột
- Thao tác
- ActionParameter
- LoadIndicator
- Lượt tương tác
- OpenLink (Mở đường liên kết)
- OpenAs (Mở dưới dạng)
- OnClose
- Trang trí văn bản
- Biểu tượng
- Nút
- Màu
- Điều khiển bằng công tắc
- Loại đối chứng
- Danh sách nút
- Phương thức nhập văn bản
- Loại
- Đề xuất
- suggestedionItem
- SelectionInput
- Loại lựa chọn
- Lựa chọn mục
- PlatformDataSource
- CommonDataSource
- Đánh dấu HostAppDataSource
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Divider
- Lưới
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- Loại đường viền
- GridItemLayout
- Cột
- Cột
- HorizontalSizeStyle
- Căn chỉnh ngang
- Căn chỉnh theo chiều dọc
- Tiện ích
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- Chú thích
- AnnotationType
- User{7}Metadata
- Loại
- SlashCommandMetadata
- Loại
- Chuỗi
- Phản hồi hành động
- Loại phản hồi
- DialogAction
- Hộp thoại
- Trạng thái hành động
- Mã
- SlashCommand
- matchUrl
- EmojiReactionSummary
- DeletionMetadata
- Loại bỏ dữ liệu
- quotedMessageMetadata
- Đính kèmGif
- 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 ( |
Các trường | |
---|---|
name |
Tên tài nguyên ở dạng Ví dụ: |
sender |
Chỉ kết quả. Người dùng đã tạo thông báo. Nếu ứng dụng Chat của bạn xác thực với tư cách người dùng, thì kết quả sẽ được điền vào người dùng |
createTime |
Đối với các không gian được tạo trong Chat, đây là thời điểm tạo tin nhắn. Trường này chỉ cho ra kết quả, trừ phi được dùng trong các không gian nhập. Đối với các không gian đã nhập, hãy đặt trường này thành dấu thời gian lịch sử mà tin nhắn được tạo trong nguồn để duy trì thời gian tạo ban đầu. |
lastUpdateTime |
Chỉ kết quả. Thời gian mà người dùng chỉnh sửa thông báo lần gần đây nhất. Nếu thông báo chưa từng được chỉnh sửa, thì trường này sẽ trống. |
deleteTime |
Chỉ kết quả. 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 |
Nội dung thư. Đường liên kết đầu tiên đến một hình ảnh, video hoặc trang web sẽ tạo 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 mọi người trong không gian. Để tìm hiểu về cách tạo tin nhắn văn bản, hãy xem bài viết Gửi tin nhắn văn bản. |
formattedText |
Chỉ kết quả. 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 sử dụng Các thẻ phong phú, có định dạng và có tính tương tác mà bạn có thể sử 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. Thẻ thường được hiển thị bên dưới phần nội dung văn bản thuần tuý của thư. |
cardsV2[] |
Một dãy thẻ. Chỉ ứ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 người dùng, thì tin nhắn không được chứa thẻ. Để tìm hiểu về thẻ và cách tạo thẻ, hãy xem bài viết Thiết kế giao diện người dùng linh động, tương tác và nhất quán bằng thẻ. |
annotations[] |
Chỉ kết quả. Chú thích liên quan đến |
thread |
Chuỗi có tin nhắn. Để tìm hiểu 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 của bạn xác thực với tư cách người dùng, thì kết quả sẽ được điền vào không gian |
fallbackText |
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ị thẻ thực tế, ví dụ: thông báo trên thiết bị di động. |
actionResponse |
Chỉ nhập. Các thông số mà ứng dụng trong Chat có thể dùng để định cấu hình cách đăng câu trả lời. |
argumentText |
Chỉ kết quả. Nội dung tin nhắn và tất cả lượt đề cập đến ứng dụng Chat đều bị loại bỏ. |
slashCommand |
Chỉ kết quả. 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. |
matchedUrl |
Chỉ kết quả. Một URL trong |
threadReply |
Chỉ kết quả. Khi Nếu không gian không hỗ trợ tính năng trả lời trong chuỗi tin nhắn, thì trường này luôn là |
clientAssignedMessageId |
Tên tuỳ chỉnh cho tin nhắn trong Chat được chỉ định khi tạo. Phải bắt đầu bằng |
emojiReactionSummaries[] |
Chỉ kết quả. Danh sách tóm tắt biểu tượng cảm xúc trên tin nhắn. |
deletionMetadata |
Chỉ kết quả. Thông tin về một tin nhắn đã bị xoá. Một thông báo sẽ bị xoá khi bạn đặt |
quotedMessageMetadata |
Chỉ kết quả. Thông tin về tin nhắn được 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. |
attachedGifs[] |
Chỉ kết quả. Ảnh GIF được đính kèm vào thư. |
Thẻ có mã nhận dạng
Một thẻ trong tin nhắn trên Google Chat.
Chỉ ứ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 người dùng, thì tin nhắn không được chứa thẻ.
Biểu diễn dưới dạng JSON |
---|
{
"cardId": string,
"card": {
object ( |
Các trường | |
---|---|
cardId |
Bắt buộc nếu tin nhắn chứa nhiều thẻ. Giá trị nhận dạng duy nhất của một thẻ trong tin nhắn. |
card |
Thẻ. Kích thước tối đa là 32 KB. |
Annotation
Chỉ kết quả. Chú thích liên kết với phần 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ông báo ở 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 ( |
Các trường | |
---|---|
type |
Loại 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. |
startIndex |
Chỉ mục bắt đầu (từ 0 đến hết) trong phần nội dung thông báo dạng văn bản thuần tuý mà chú thích này tương ứng. |
Trường nhóm 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: |
|
userMention |
Siêu dữ liệu về lượt đề cập đến người dùng. |
slashCommand |
Siêu dữ liệu của lệnh dấu gạch chéo. |
Loại chú thích
Loại chú thích.
Enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Giá trị mặc định cho enum. Đừ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. |
UserĐề cậpSiêu dữ liệu
Siêu dữ liệu chú thích cho các lượt đề cập của người dùng (@).
Biểu diễn dưới dạng JSON |
---|
{ "user": { object ( |
Các trường | |
---|---|
user |
Người dùng được đề cập. |
type |
Loại đề cập đến người dùng. |
Loại
Enum | |
---|---|
TYPE_UNSPECIFIED |
Giá trị mặc định cho enum. Đừ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 ( |
Các 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. Đừ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 khoảng trắng. |
Chuỗi hội thoại
Một chuỗi tin nhắn trong một phòng Google Chat. Để tìm hiểu 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 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 chuỗi nào phù hợp.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "threadKey": string } |
Các trường | |
---|---|
name |
Chỉ kết quả. Tên tài nguyên của luồng. Ví dụ: |
threadKey |
Không bắt buộc. Thông tin đầu vào để tạo hoặc cập nhật chuỗi tin nhắn. Nếu không, chỉ kết quả đầu ra. Mã nhận dạng cho chuỗi. Hỗ trợ tối đa 4000 ký tự. Đây là mã nhận dạng duy nhất của ứng dụng Chat đã đặt mã này. Ví dụ: nếu nhiều ứng dụng trong Chat tạo một tin nhắn bằng cùng một khoá chuỗi, thì tin nhắn đó sẽ được đăng trong các chuỗi khác nhau. Để trả lời trong một chuỗi tin nhắn do một người hoặc một ứng dụng khác trong Chat tạo, hãy chỉ định trường |
Phản hồi hành động
Các thông số mà ứng dụng trong 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 ( |
Các trường | |
---|---|
type |
Chỉ nhập. Loại phản hồi của ứng dụng Chat. |
url |
Chỉ nhập. URL để người dùng xác thực hoặc định cấu hình. (Chỉ dành cho loại phản hồi |
dialogAction |
Chỉ nhập. Phản hồi cho một sự kiện liên quan đến hộp thoại. Phải đi kèm với |
Loại phản hồi
Loại phản hồi của ứng dụng Chat.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Loại mặc định được xử lý là NEW_MESSAGE . |
NEW_MESSAGE |
Đăng dưới dạng một 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 có loại người gửi tin nhắn là BOT . |
UPDATE_USER_MESSAGE_CARDS |
Cập nhật các thẻ trên tin nhắn của người dùng. Hành động này chỉ được phép phản hồi sự kiện MESSAGE có URL trùng khớp hoặc sự kiện CARD_CLICKED có loại người gửi tin nhắn là HUMAN . Bỏ qua văn bản. |
REQUEST_CONFIG |
Yêu cầu người dùng xác thực hoặc định cấu hình bổ sung một cách riêng tư. |
DIALOG |
Trình bày một hộp thoại. |
DialogAction
Chứa 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 ( |
Các trường | |
---|---|
actionStatus |
Chỉ nhập. Trạng thái của một yêu cầu gọi hoặc gửi hộp thoại. Hiện trạng thái và thông báo cho người dùng nếu cần. Ví dụ: trong trường hợp xảy ra lỗi hoặc thành công. |
Trường nhóm
|
|
dialog |
Chỉ nhập. Hộp thoại cho yêu cầu. |
Hộp thoại
Trình bao bọc xung quanh thân thẻ của hộp thoại.
Biểu diễn dưới dạng JSON |
---|
{
"body": {
object ( |
Các trường | |
---|---|
body |
Chỉ nhập. Nội dung của hộp thoại, được hiển thị trong một cửa sổ phụ. Ứng dụng Google Chat không hỗ trợ các thực thể thẻ sau: |
Trạng thái hoạt động
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.
Biểu diễn dưới dạng JSON |
---|
{
"statusCode": enum ( |
Các trường | |
---|---|
statusCode |
Mã trạng thái. |
userFacingMessage |
Thông báo để cho người dùng biết 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 thì một thông báo chung dựa trên |
Mã
Các mã lỗi chính tắc cho các API gRPC.
Đôi khi, có thể áp dụng nhiều mã lỗi. Dịch vụ phải trả về mã lỗi cụ thể nhất áp dụng. Ví dụ: ưu tiên OUT_OF_RANGE
hơn FAILED_PRECONDITION
nếu áp dụng cả hai mã. Tương tự, ưu tiên NOT_FOUND
hoặc ALREADY_EXISTS
hơn FAILED_PRECONDITION
.
Enum | |
---|---|
OK |
Không phải lỗi; đã 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: Yêu cầu đóng ứng dụng 499 |
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: Lỗi máy chủ nội bộ 500 |
INVALID_ARGUMENT |
Ứng dụng khách chỉ định một đối số không hợp lệ. Xin lưu ý rằng giá trị này khác với Ánh xạ HTTP: Yêu cầu 400 không hợp lệ |
DEADLINE_EXCEEDED |
Đã hết thời hạn trước khi thao tác này 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ụ: một phản hồi thành công từ một máy chủ có thể bị trì hoãn đủ lâu để hết thời hạn. Ánh xạ HTTP: Hết thời gian chờ cổng 504 |
NOT_FOUND |
Không tìm thấy một số thực thể đã yêu cầu (ví dụ: tệp hoặc thư mục). Lưu ý đối với các 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ư phát hành dần tính năng hoặc danh sách cho phép không có tài liệu, thì Ánh xạ HTTP: 404 Không tìm thấy |
ALREADY_EXISTS |
Thực thể mà ứ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 |
Phương thức gọi không có quyền thực thi thao tác đã chỉ định. Không được sử 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. Ánh xạ HTTP: 401 trái phép |
RESOURCE_EXHAUSTED |
Một số tài nguyên đã hế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 |
Hoạt động đã bị từ chối vì hệ thống không ở trạng thái bắt buộc để thực thi hoạt động. Ví dụ: thư mục cần xoá là thư mục không trống, thao tác rmdir được áp dụng cho thư mục không phải thư mục, v.v. Trình 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: Yêu cầu 400 không hợp lệ |
ABORTED |
Hoạt động đã bị hủy, thường do vấn đề đồng thời, chẳng hạn như lỗi kiểm tra trình tự tuần tự hoặc hủy giao dịch. Hãy xem 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 vượt quá phạm vi hợp lệ. Ví dụ: tìm kiếm hoặc đọc kết thúc tệp trong quá khứ. Không giống như Có một chút trùng lặp giữa Ánh xạ HTTP: Yêu cầu 400 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. Ánh xạ HTTP: 501 Chưa được triển khai |
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 dự kiến đã bị hỏng. Mã lỗi này dành riêng cho các lỗi nghiêm trọng. Ánh xạ HTTP: Lỗi máy chủ nội bộ 500 |
UNAVAILABLE |
Dịch vụ này hiện không dùng được. Đây rất có thể là một tình trạng tạm thời và có thể khắc phục bằng cách thử lại với thời gian đợi. Xin lưu ý rằng việc thử lại các thao tác không thay đổi không phải lúc nào cũng an toàn. Hãy xem nguyên tắc ở trên để quyết định giữa Ánh xạ HTTP: 503 Dịch vụ không có sẵn |
DATA_LOSS |
Mất hoặc hỏng dữ liệu không thể khôi phục. Ánh xạ HTTP: Lỗi máy chủ nội bộ 500 |
Lệnh SlashCommand
Lệnh dấu gạch chéo trong Google Chat.
Biểu diễn dưới dạng JSON |
---|
{ "commandId": string } |
Các trường | |
---|---|
commandId |
Mã của lệnh dấu gạch chéo đã gọi. |
Url được so khớp
Một URL trùng khớp trong tin nhắn trò chuyện. Các ứng dụng nhắn tin có thể xem trước các URL đã 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 } |
Các trường | |
---|---|
url |
Chỉ kết quả. URL trùng khớp. |
Tóm tắt phản ứng với biểu tượng cảm xúc
Số người đã phản ứng với tin nhắn bằng một biểu tượng cảm xúc cụ thể.
Biểu diễn dưới dạng JSON |
---|
{
"emoji": {
object ( |
Các trường | |
---|---|
emoji |
Biểu tượng cảm xúc liên quan đến các lượt bày tỏ cảm xúc. |
reactionCount |
Tổng số lượt bày tỏ cảm xúc sử dụng biểu tượng cảm xúc liên quan. |
Siêu dữ liệu xoá
Thông tin về một tin nhắn đã bị xoá. Một thông báo sẽ bị xoá khi bạn đặt deleteTime
.
Biểu diễn dưới dạng JSON |
---|
{
"deletionType": enum ( |
Các trường | |
---|---|
deletionType |
Cho biết ai đã xoá thư. |
Loại xoá
Ai đã xoá tin nhắn và cách thức xoá tin nhắn đó.
Enum | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Giá trị này không được sử dụng. |
CREATOR |
Người dùng đã tự xoá tin nhắn của chính mình. |
SPACE_OWNER |
Chủ sở hữu không gian đã xoá tin nhắn. |
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 đã tự xoá tin nhắn của chính mình khi hết hạn. |
CREATOR_VIA_APP |
Một ứng dụng nhắn tin đã thay mặt người dùng xoá tin nhắn. |
SPACE_OWNER_VIA_APP |
Một ứng dụng nhắn tin đã thay mặt chủ sở hữu không gian xoá tin nhắn. |
TríchdMessageMetadata
Thông tin về một tin nhắn được trích dẫn.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "lastUpdateTime": string } |
Các trường | |
---|---|
name |
Chỉ kết quả. Tên tài nguyên của tin nhắn được trích dẫn. Định dạng |
lastUpdateTime |
Chỉ kết quả. Dấu thời gian khi tin nhắn được trích dẫn được tạo hoặc lần cập nhật tin nhắn được trích dẫn gần đây nhất. |
GIF đính kèm
Ảnh GIF được URL chỉ định.
Biểu diễn dưới dạng JSON |
---|
{ "uri": string } |
Các trường | |
---|---|
uri |
Chỉ kết quả. URL lưu trữ hình ảnh GIF. |
Phương thức |
|
---|---|
|
Tạo tin nhắn trong một phòng Google Chat. |
|
Xoá tin nhắn. |
|
Trả về chi tiết về một tin nhắn. |
|
Liệt kê tin nhắn trong một không gian có người gọi là thành viên, bao gồm cả tin nhắn từ các không gian và thành viên bị chặn. |
|
Cập nhật một thông báo. |
|
Cập nhật một thông báo. |