- Tài nguyên: Thông báo
- Thẻ
- Tiêu đề thẻ
- Kiểu hình ảnh
- Phần
- WidgetMarkup
- Đoạn văn bản
- Hình ảnh
- OnClick
- Biểu mẫu hành động
- Thao tác về tham số
- OpenLink
- KeyValue
- Biểu tượng
- Nút
- Nút văn bản
- Nút hình ảnh
- CardAction
- CardWithId
- Thẻ
- Tiêu đề thẻ
- Loại hình ảnh
- Phần
- Tiện ích
- Đoạn văn bản
- Hình ảnh
- OnClick
- Hành động
- Thao tác về tham số
- LoadIndicator
- Tương tác
- OpenLink
- OpenAs
- Đang đóng
- TextdText
- Biểu tượng
- Nút
- Màu
- SwitchControl
- Loại kiểm soát
- ButtonList
- Mục nhập văn bản
- Loại
- Đề xuất
- Mục đề xuất
- SelectionInput
- SelectionType
- SelectionItem
- DateTimePicker
- DateTimePickerType
- Divider
- Lưới
- GridItem
- Thành phần hình ảnh
- ImageCropStyle
- ImageCropType
- BorderStyle
- Đường viền
- GridItemLayout
- CardAction
- CardFixedfooter
- Hiển thị kiểu
- Chú thích
- Loại chú thích
- Siêu dữ liệu đề cập đến người dùng
- Loại
- SlashCommandMetadata
- Loại
- Luồng
- Thao tác phản hồi
- Loại phản hồi
- DialogAction
- Hộp thoại
- ActionStatus
- Mã
- SlashCommand
- URL phù hợp
- EmojiReactionsummary
- DeletionMetadata
- Loại Nhớt
- Phương thức
Tài nguyên: Tin nhắn
Một tin nhắn trong 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ỉ đầu ra. 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, kết quả sẽ điền sẵn người dùng |
createTime |
Chỉ đầu ra. Thời điểm tạo tin nhắn trong máy chủ Google Chat. |
lastUpdateTime |
Chỉ đầu ra. Thời gian mà người dùng chỉnh sửa tin nhắn gần đây nhất. Nếu thông báo chưa từng được chỉnh sửa, trường này để trống. |
deleteTime |
Chỉ đầu ra. Thời điểm tin nhắn đã bị xóa trong máy chủ của Google Chat. Nếu thư này không bao giờ bị xoá, trường này sẽ trống. |
text |
Nội dung văn bản thuần tuý của thông báo. Đường liên kết đầu tiên đến một hình ảnh, video, trang web hoặc mục xem trước khác sẽ tạo ra một khối xem trước. |
cards[] |
Không dùng nữa: Thay vào đó, hãy sử dụng Thẻ tương tác, được định dạng và phong phú 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, hình ảnh có thể nhấp. Thẻ thường được hiển thị bên dưới nội dung văn bản thuần tuý của thông báo. |
cardsV2[] |
Các thẻ tương tác và được định dạng phong phú hiển thị các thành phần trên giao diện người dùng và các tiện ích có thể chỉnh sửa, chẳng hạn như:
Thẻ thường được hiển thị bên dưới nội dung văn bản của tin nhắn Trò chuyện, nhưng có thể xuất hiện ở các vị trí khác, chẳng hạn như hộp thoại. Mỗi thẻ có thể có kích thước tối đa là 32 KB.
Các tiện ích hiện được hỗ trợ bao gồm:
|
annotations[] |
Chỉ đầu ra. Chú thích liên kết với văn bản trong tin nhắn này. |
thread |
Chuỗi tin nhắn thuộc về. Để sử dụng ví dụ: hãy xem phần Bắt đầu hoặc trả lời 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ẽ điền vào không gian |
fallbackText |
Nội dung mô tả thẻ ở dạng văn bản thuần tuý, được dùng khi không thể hiển thị các thẻ thực tế (ví dụ: thông báo trên thiết bị di động). |
actionResponse |
Chỉ thiết bị vào. Các thông số mà một ứng dụng Chat có thể sử dụng để định cấu hình cách đăng câu trả lời. |
argumentText |
Chỉ đầu ra. Phần văn bản thuần tuý của tin nhắn, trong đó có tất cả các lượt đề cập đến ứng dụng Chat đều được xoá bỏ. |
slashCommand |
Chỉ đầ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. |
matchedUrl |
Chỉ đầu ra. URL trong |
threadReply |
Chỉ đầu ra. Khi Nếu không gian không hỗ trợ việc trả lời trong chuỗi, 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ỉ đầu ra. Danh sách các bản tóm tắt phản ứng bằng biểu tượng cảm xúc trên tin nhắn. |
deletionMetadata |
Chỉ đầu ra. Thông tin về một tin nhắn đã bị xoá. Một tin nhắn sẽ bị xoá khi bạn đặt |
Thẻ có mã nhận dạng
Tiện ích cho ứng dụng Chat để chỉ định.
Biểu diễn dưới dạng JSON |
---|
{
"cardId": string,
"card": {
object ( |
Các trường | |
---|---|
cardId |
Bắt buộc đối với |
card |
Thẻ hỗ trợ bố cục đã xác định, các phần tử giao diện người dùng tương tác như nút và nội dung đa phương tiện như hình ảnh. Hãy sử dụng thẻ này để trình bày thông tin chi tiết, thu thập thông tin từ người dùng và hướng dẫn người dùng thực hiện bước tiếp theo. |
Annotation
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.
Ví dụ về nội dung thư 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 phần nội dung của văn bản thuần tuý mà chú thích này tương ứng. |
startIndex |
Chỉ mục bắt đầu (dựa trên 0, bao gồm) trong nội dung thông điệp dạng văn bản thuần tuý này chú thích này. |
Trường liên kết 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: |
|
userMention |
Siêu dữ liệu về lượt đề cập của người dùng. |
slashCommand |
Siêu dữ liệu cho một 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. KHÔNG SỬ DỤNG. |
USER_MENTION |
Người dùng được đề cập. |
SLASH_COMMAND |
Lệnh dấu gạch chéo sẽ được gọi. |
Siêu dữ liệu về người dùng
Siêu dữ liệu chú thích cho 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 nói đến. |
type |
Loại đề 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 |
Nhắc đến người dùng trong không gian. |
Siêu dữ liệu CommandSCommand
Siêu dữ liệu chú giải 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 lên. |
commandId |
Mã lệnh của lệnh dấu gạch chéo lên. |
triggersDialog |
Cho biết lệnh dấu gạch chéo có phải là 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. |
Chuỗi hội thoại
Một chuỗi cuộc trò chuyện trong Google Chat.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "threadKey": string } |
Các trường | |
---|---|
name |
Tên tài nguyên của luồng. Ví dụ: dấu cách/{space}/threads/{thread} |
threadKey |
Không bắt buộc. Giá trị nhận dạng luồng mờ. Để bắt đầu hoặc thêm vào một chuỗi, hãy tạo tin nhắn và chỉ định Đối với các yêu cầu khác, đây là trường chỉ xuất. |
Phản hồi hành động
Các thông số mà một ứng dụng Chat có thể sử 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ỉ thiết bị vào. Loại phản hồi ứng dụng Chat. |
url |
Chỉ thiết bị vào. URL để người dùng xác thực hoặc thiết lập. (Chỉ dành cho các loại phản hồi REQUEST_CONFIG.) |
dialogAction |
Chỉ thiết bị vào. Phản hồi 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 ứng dụng Chat.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Loại mặc định; sẽ đượ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 đối với sự kiện CARD_CLICKED mà loại người gửi tin nhắn là BOT. |
UPDATE_USER_MESSAGE_CARDS |
Cập nhật các thẻ trên thông báo của người dùng. Điều này chỉ được phép khi phản hồi sự kiện MESSAGE có url được khớp hoặc sự kiện CARD_CLICKED mà loại người gửi tin nhắn là HUMAN. Văn bản sẽ bị bỏ qua. |
REQUEST_CONFIG |
Yêu cầu người dùng cung cấp thêm thông tin xác thực hoặc cấu hình để hỗ trợ riêng tư. |
DIALOG |
Trình bày một hộp thoại. |
Hộp thoại
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ỉ thiết bị vào. Trạng thái của yêu cầu gọi hoặc gửi hộp thoại. Hiển thị trạng thái và thông báo cho người dùng, nếu cần. Ví dụ: Trong trường hợp xảy ra lỗi hoặc thành công. |
Trường liên kết
|
|
dialog |
Chỉ thiết bị vào. Hộp thoại cho yêu cầu. |
Hộp thoại
Bao bọc quanh phần 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ỉ thiết bị vào. Nội dung của hộp thoại được hiển thị ở chế độ. Ứng dụng Google Chat không hỗ trợ các thực thể thẻ sau: |
Trạng thái hoạt động
Thể hiện trạng thái của 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 của yêu cầu. Nếu bạn không đặt chính sách này, một thông báo chung dựa trên |
Mã
Mã lỗi chính tắc cho API gRPC.
Đôi khi, có thể áp dụng nhiều mã lỗi. Dịch vụ sẽ 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 áp dụng cả hai mã. Tương tự như vậy, hãy ưu tiên NOT_FOUND
hoặc ALREADY_EXISTS
hơn FAILED_PRECONDITION
.
Enum | |
---|---|
OK |
Không phải là lỗi; đã trả về thành công. Liên kết HTTP: 200 OK |
CANCELLED |
Thao tác đã bị huỷ, thường là do người gọi thực hiện. Liên kết HTTP: Yêu cầu đã đóng ứng dụng khách 499 |
UNKNOWN |
Lỗi không xác định. Ví dụ: lỗi này có thể được trả về khi một giá trị Liên kết HTTP: Lỗi máy chủ nội bộ 500 |
INVALID_ARGUMENT |
Máy khách đã chỉ định một đối số không hợp lệ. Vui lòng lưu ý điều này khác với Liên kết HTTP: 400 yêu cầu không hợp lệ |
DEADLINE_EXCEEDED |
Thời hạn đã hết hạn trước khi hoạt động có thể hoàn tất. Đối với các hoạt động thay đổi trạng thái của hệ thống, lỗi này có thể được trả về ngay cả khi hoạt động đã hoàn tất thành công. Ví dụ: phản hồi thành công từ máy chủ có thể đã bị trì hoãn đủ lâu để hết hạn. Liên kết HTTP: Thời gian chờ cổng 504 |
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 ý dành 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ộ một nhóm người dùng, chẳng hạn như phát hành tính năng dần dần hoặc danh sách cho phép không được ghi lại, thì hệ thống có thể sử dụng Liên kết HTTP: Không tìm thấy lỗi 404 |
ALREADY_EXISTS |
Mục mà ứng dụng đã cố gắng tạo (ví dụ: tệp hoặc thư mục) đã tồn tại. Liên kết 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 dùng Liên kết 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 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ể là toàn bộ hệ thống tệp đã hết dung lượng. Liên kết HTTP: 429 Quá nhiều yêu cầu |
FAILED_PRECONDITION |
Thao tác này đã bị từ chối vì hệ thống không ở trạng thái cần thiết để thực thi thao tác. Ví dụ: thư mục cần xoá không để trống, thao tác rmdir được áp dụng cho một thư mục không phải 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 Liên kết HTTP: 400 yêu cầu không hợp lệ |
ABORTED |
Hoạt động bị huỷ, thường là do vấn đề đồng thời, chẳng hạn như lỗi kiểm tra trình tự hoặc huỷ giao dịch. Xem các nguyên tắc ở trên để quyết định giữa Liên kết 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 cuối tệp. Không giống như Có một chút trùng lặp giữa Liên kết HTTP: 400 yêu cầu không hợp lệ |
UNIMPLEMENTED |
Thao tác này không đượ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 chưa được triển khai |
INTERNAL |
Lỗi nội bộ. Điều này có nghĩa là một số biến thể dự kiến do hệ thống cơ bản dự kiến đã bị hỏng. Mã lỗi này được dành riêng cho các lỗi nghiêm trọng. Liên kết 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. Điều kiện này có thể khắc phục bằng cách thử lại với thời gian đợi. Lưu ý rằng không phải lúc nào bạn cũng có thể thử lại các thao tác không đúng cách. Xem các nguyên tắc ở trên để quyết định giữa Liên kết HTTP: Dịch vụ 503 không hoạt động |
DATA_LOSS |
Lỗi dữ liệu không thể khôi phục hoặc bị hỏng. Liên kết HTTP: Lỗi máy chủ nội bộ 500 |
Lệnh SlashCommand
Lệnh 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 gạch chéo được gọi. |
Url được khớp
URL được so khớp trong tin nhắn Chat. Các ứng dụng nhắn tin có thể xem trước URL được so khớp. Để biết thêm thông tin, hãy tham khảo 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ỉ đầu ra. URL đã được so khớp. |
Tóm tắt biểu tượng cảm xúc
Số người đã phản ứng với một 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 phản ứng. |
reactionCount |
Tổng số phản ứng sử dụng biểu tượng cảm xúc liên quan. |
XoáSiêu dữ liệu
Thông tin về một tin nhắn đã bị xoá. Một tin nhắn 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á tin nhắn. |
Loại yêu cầu xoá
Ai và là người đã xoá tin nhắn này.
Enum | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Giá trị này không được sử dụng. |
CREATOR |
Người dùng đã xoá tin nhắn của chính 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 đó. |
APP_MESSAGE_EXPIRY |
Một ứng dụng Chat đã xoá tin nhắn của chính ứng dụng khi ứng dụng đó 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 nhắn tin. |
Phương pháp |
|
---|---|
|
Tạo thông báo. |
|
Xoá tin nhắn. |
|
Trả về tin nhắn. |
|
Liệt kê tin nhắn trong không gian có người gọi, 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 tin nhắn. |
|
Cập nhật tin nhắn. |