REST Resource: spaces.messages

Tài nguyên: Tin nhắn

Tin nhắn trong một không gian trên Google Chat.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "silent": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ],
  "elements": {
    object (Elements)
  },
  "markupSyntax": enum (MarkupSyntax)
}
Trường
name

string

Giá trị nhận dạng. Tên tài nguyên của thông báo.

Định dạng spaces/{space}/messages/{message}

Trong đó, {space} là mã nhận dạng của không gian nơi tin nhắn được đăng và {message} là mã nhận dạng do hệ thống chỉ định cho tin nhắn. Ví dụ: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

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 một yêu cầu bằng cách thay thế {message} bằng giá trị trong trường clientAssignedMessageId. Ví dụ: spaces/AAAAAAAAAAA/messages/client-custom-name. Để biết thông tin chi tiết, hãy xem bài viết Đặt tên cho thông báo.
sender

object (User)

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 dưới dạng người dùng, thì kết quả chỉ điền sẵn các trường user name và type cho cả người dùng nội bộ và người dùng bên ngoài, trừ phi họ là thành viên của không gian hoặc có mối quan hệ trước đó, chẳng hạn như cuộc trò chuyện qua tin nhắn trực tiếp (DM), với người dùng gọi.
createTime

string (Timestamp format)

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 tin nhắn được tạo. Trường này chỉ có thể xuất, ngoại trừ khi đượ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à tin nhắn được tạo trong nguồn để giữ nguyên thời gian tạo ban đầu.
lastUpdateTime

string (Timestamp format)

Chỉ có đầu ra. Thời điể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, thì trường này sẽ trống.
deleteTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm tin nhắn bị xoá trong Google Chat. Nếu tin nhắn không bao giờ bị xoá, thì trường này sẽ trống.
text

string

Không bắt buộc. Nội dung văn bản thuần tuý của thư. Đườ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 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.
formattedText

string

Chỉ có đầu ra. Chứa thông báo text có thêm mã đánh dấu để truyền đạt định dạng. Trường này có thể không ghi lại tất cả định dạng hiển thị trong giao diện người dùng, nhưng bao gồm những định dạng sau:

  • Cú pháp đánh dấu cho kiểu chữ đậm, in nghiêng, gạch ngang chữ, đơn cách, khối đơn cách, danh sách có dấu đầu dòng và khối trích dẫn.

  • Lượt đề cập của người dùng theo định dạng <users/{user}>.

  • Siêu liên kết tuỳ chỉnh sử dụng định dạng <{url}|{rendered_text}>, trong đó chuỗi đầu tiên là URL và chuỗi thứ hai là văn bản được hiển thị, ví dụ: <http://example.com|custom text>.

  • Biểu tượng cảm xúc tuỳ chỉnh sử dụng định dạng :{emojiName}:, ví dụ: :smile:. Quy tắc này không áp dụng cho biểu tượng cảm xúc Unicode, chẳng hạn như U+1F600 cho biểu tượng cảm xúc khuôn mặt cười toe toét.

  • Đánh dấu đầu dòng các mục trong danh sách bằng dấu hoa thị (*) – ví dụ: * item.

Để 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[]
(deprecated)

object (Card)

Không dùng nữa: Hãy sử dụng cardsV2.

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 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 và cardsV2 có thể có kích thước tối đa là 32 KB.
cardsV2[]

object (CardWithId)

Không bắt buộc. Một mảng thẻ.

Ứng dụng Chat có thể tạo thẻ bằng tính năng xác thực ứng dụng. Trong Chương trình Bản dùng trước 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 tin nhắn dạng thẻ. Nếu không tham gia Bản dùng trước cho nhà phát triển, ứng dụng Chat của bạn sẽ không thể tạo thẻ có tính năng xác thực người dùng.

Để 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[]

object (Annotation)

Chỉ có đầu ra. Chú thích có thể được liên kết với 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 là 0.
thread

object (Thread)

Chuỗi thư chứa thư này. Để 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

object (Space)

Chỉ có đầu ra. Nếu ứng dụng Chat xác thực dưới dạng người dùng, thì kết quả chỉ điền sẵn không gian name.
fallbackText

string

Không bắt buộc. Nội dung mô tả bằng văn bản thuần tuý về thẻ của tin nhắn, được dùng khi không thể hiển thị thẻ thực tế, chẳng hạn như thông báo qua thiết bị di động.
actionResponse

object (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 phản hồi.
argumentText

string

Chỉ có đầu ra. Nội dung văn bản thuần túy của tin nhắn, trong đó tất cả lượt đề cập đến ứng dụng Chat đều bị xóa.
slashCommand

object (SlashCommand)

Chỉ có đầu ra. Thông tin về lệnh dấu gạch chéo (nếu có).
attachment[]

object (Attachment)

Không bắt buộc. Tệp đính kèm do người dùng tải lên.
matchedUrl

object (MatchedUrl)

Chỉ có đầu ra. Một URL trong trường Tin nhắn trò chuyện text khớp với mẫu bản xem trước đường liên kết. Để biết thêm thông tin, hãy xem bài viết Xem trước đường liên kết.
threadReply

boolean

Chỉ có đầu ra. Khi true, tin nhắn là một câu trả lời trong chuỗi trả lời. Khi false, tin nhắn sẽ xuất hiện trong cuộc trò chuyện cấp cao nhất của không gian dưới dạng tin nhắn đầu tiên của một chuỗi hoặc tin nhắn không có thư trả lời theo chuỗi.

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à false.
silent

boolean

Chỉ có đầu ra. Liệu đây có phải là tin nhắn không có âm thanh hay không. Tin nhắn im lặng là tin nhắn mà Chat sẽ chặn thông báo đẩy cho người nhận.
clientAssignedMessageId

string

Không bắt buộc. Mã tùy chỉnh cho thông báo. Bạn có thể sử dụng trường này để xác định một tin nhắn hoặc để lấy, xoá hoặc cập nhật một tin nhắn. Để đặt mã tuỳ chỉnh, hãy chỉ định trường messageId khi bạn tạo thông báo. Để biết thông tin chi tiết, hãy xem bài viết Đặt tên cho thông báo.
emojiReactionSummaries[]

object (EmojiReactionSummary)

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

object (User)

Không bắt buộc. Không thể thay đổi. Dữ liệu đầu vào để tạo thông báo, nếu không thì chỉ có dữ liệu đầu ra. Người dùng có thể xem thông báo. Khi được đặt, tin nhắn sẽ ở chế độ riêng tư và chỉ người dùng được chỉ định và ứng dụng Chat mới có thể nhìn thấy. Để đưa trường này vào yêu cầu, bạn phải gọi API Chat bằng phương thức 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

object (DeletionMetadata)

Chỉ có đầu ra. Thông tin về tin nhắn đã xoá. Tin nhắn sẽ bị xoá khi deleteTime được đặt.
quotedMessageMetadata

object (QuotedMessageMetadata)

Không bắt buộc. Thông tin về một tin nhắn mà một tin nhắn 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 thư trả lời từ 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 quotedMessageMetadata, nhưng có thể xoá trường này.

Để xem ví dụ về cách sử dụng, hãy xem phần Trích dẫn tin nhắn khác.
attachedGifs[]

object (AttachedGif)

Chỉ có đầu ra. Hình ảnh GIF được đính kèm vào thư.
accessoryWidgets[]

object (AccessoryWidget)

Không bắt buộc. Một hoặc nhiều tiện ích tương tác xuất hiện ở cuối thư. Bạn có thể thêm tiện ích phụ kiện vào những tin nhắn có chứa văn bản, thẻ hoặc cả văn bản và thẻ. Không hỗ trợ cho các thông báo có chứa hộp thoại. Để biết thông tin chi tiết, hãy xem phần Thêm tiện ích tương tác ở cuối tin nhắn.

Để tạo tin nhắn có tiện ích bổ sung, bạn cần xác thực ứng dụng.
elements

object (Elements)

Không bắt buộc. Thành phần 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ành phần này khác với chú thích (chỉ có đầu ra và cung cấp thông tin bổ sung liên quan đến các đoạn thông báo hoặc toàn bộ văn bản thông báo).

markupSyntax

enum (MarkupSyntax)

Không bắt buộc. Chỉ định cách máy chủ diễn giải nội dung trường text của thư khi tạo thư hoặc cập nhật trường text của thư.

Khi gọi messages.patch, hãy đặt markupSyntax và text trên tài nguyên Message và đưa text (không phải markupSyntax) vào updateMask.

Annotation

Chú thích có thể được liên kết với 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 là 0. Để thêm định dạng cơ bản cho tin nhắn văn bản, hãy xem bài viết Định dạng tin nhắn văn bản.

Ví dụ về nội dung thư dạng văn bản thuần tuý:

Hello @FooBot how are you!"

Siêu dữ liệu chú thích tương ứng:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Biểu diễn dưới dạng JSON 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
Trường
type

enum (AnnotationType)

Loại chú thích này.
length

integer

Độ dài của chuỗi con trong nội dung thư ở dạng văn bản thuần túy mà chú thích này tương ứng. Nếu không có, thì độ dài là 0.
startIndex

integer

Chỉ mục bắt đầu (bắt đầu từ 0, bao gồm cả chỉ mục này) trong nội dung thư ở dạng văn bản thuần túy mà chú thích này tương ứng.
Siêu dữ liệu bổ sung về chú thích. 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

object (UserMentionMetadata)

Siêu dữ liệu về lượt đề cập người dùng.
slashCommand

object (SlashCommandMetadata)

Siêu dữ liệu cho lệnh dấu gạch chéo.
customEmojiMetadata

object (CustomEmojiMetadata)

Siêu dữ liệu cho 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. Đừng sử dụng.
USER_MENTION Một người dùng được nhắc đến.
SLASH_COMMAND Một lệnh dấu gạch chéo được gọi.
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 người dùng (@).

Biểu diễn dưới dạng JSON 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
Trường
user

object (User)

Người dùng được nhắc đến.
type

enum (Type)

Loại lượt đề cập 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 (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
Trường
bot

object (User)

Ứng dụng Chat có lệnh được gọi.
type

enum (Type)

Loại lệnh dấu gạch chéo.
commandName

string

Tên của lệnh dấu gạch chéo được gọi.
commandId

string (int64 format)

Mã lệnh của lệnh dấu gạch chéo được gọi.
triggersDialog

boolean

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 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 không gian.

RichLinkMetadata

Đường liên kết đa dạng thức đến một tài nguyên. Đường liên kết đa dạng thức có thể được liên kết với nội dung văn bản thuần tuý của tin nhắn hoặc đại diện cho các khối liên kết đến tài nguyên của Google Workspace như Google Tài liệu hoặc Trang tính có startIndex và length là 0.

Biểu diễn dưới dạng JSON 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
Trường
uri

string

URI của đường liên kết này.
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:
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 thức. Chúng tôi có thể thêm nhiều loại khác trong tương lai.

Enum
DRIVE_FILE Một loại đường liên kết đa dạng thức của Google Drive.
CHAT_SPACE Loại đường liên kết đa dạng thức của không gian trong 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 khối Gmail từ tính năng Chia sẻ lên Chat. API này chỉ hỗ trợ đọc tin nhắn có đường liên kết đa dạng thức GMAIL_MESSAGE.
MEET_SPACE Loại đường liên kết đa dạng thức của tin nhắn trên Meet. Ví dụ: khối Meet.
CALENDAR_EVENT Loại đường liên kết đa dạng thức của tin nhắn 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 (DriveDataRef)
  },
  "mimeType": string
}
Trường
driveDataRef

object (DriveDataRef)

DriveDataRef tham chiếu đến một tệp trên Google Drive.
mimeType

string

Loại mime của tài nguyên Google Drive được liên kết.

ChatSpaceLinkData

Dữ liệu cho đường liên kết đến không gian trong Chat.

Biểu diễn dưới dạng JSON 
{
  "space": string,
  "thread": string,
  "message": string
}
Trường
space

string

Không gian của tài nguyên không gian được liên kết trong Chat.

Định dạng spaces/{space}
thread

string

Chuỗi tin nhắn của tài nguyên phòng Chat được liên kết.

Định dạng spaces/{space}/threads/{thread}
message

string

Tin nhắn của tài nguyên không gian trong Chat được liên kết.

Định dạng spaces/{space}/messages/{message}

MeetSpaceLinkData

Dữ liệu cho đường liên kết đến không gian họp trên Meet.

Biểu diễn dưới dạng JSON 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
Trường
meetingCode

string

Mã cuộc họp của không gian Meet được liên kết.
type

enum (Type)

Cho biết loại không gian họp.
huddleStatus

enum (HuddleStatus)

Không bắt buộc. Chỉ có đầu ra. Nếu cuộc họp trên Meet là một cuộc họp nhanh, thì trường này cho biết trạng thái của cuộc họp nhanh. Nếu không, giá trị này sẽ không được đặt.

Loại

Loại không gian họp trên Meet.

Enum
TYPE_UNSPECIFIED Giá trị mặc định cho enum. Đừng sử dụng.
MEETING Không gian họp là một cuộc họp.
HUDDLE Không gian họp là một cuộc họp nhanh.

HuddleStatus

Trạng thái của cuộc họp nhanh

Enum
HUDDLE_STATUS_UNSPECIFIED Giá trị mặc định cho enum. Đừng sử dụng.
STARTED Cuộc họp nhanh đã bắt đầu.
ENDED Cuộc họp nhanh đã kết thúc. Trong trường hợp này, URI và giá trị nhận dạng của không gian họp trên Meet sẽ không còn hợp lệ.
MISSED Bạn đã bỏ lỡ cuộc họp nhanh. Trong trường hợp này, URI và giá trị nhận dạng của không gian họp trên Meet sẽ không còn hợp lệ.

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

string

Giá trị nhận dạng lịch của Lịch được liên kết.
eventId

string

Giá trị nhận dạng sự kiện của sự kiện trên lịch được liên kết.

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 (CustomEmoji)
  }
}
Trường
customEmoji

object (CustomEmoji)

Biểu tượng cảm xúc tuỳ chỉnh.

ActionResponse

Các tham số mà ứng dụng Chat có thể dùng để định cấu hình cách đăng phản hồi.

Biểu diễn dưới dạng JSON 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
Trường
type

enum (ResponseType)

Chỉ có đầu vào. Loại phản hồi của ứng dụng Chat.
url

string

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 các loại phản hồi REQUEST_CONFIG.)
dialogAction

object (DialogAction)

Chỉ có đầu vào. Phản hồi cho 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 ResponseType.Dialog.
updatedWidget

object (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. Bạn chỉ được phép làm việc này trong sự kiện CARD_CLICKED khi loại người gửi tin nhắn 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 thực hiện việc này để phản hồi một sự kiện MESSAGE có URL trùng khớp hoặc một sự kiện CARD_CLICKED có loại người gửi tin nhắn là HUMAN. Văn bản bị bỏ qua.
REQUEST_CONFIG Yêu cầu riêng người dùng xác thực hoặc định cấu hình thêm.
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 của tiện ích.

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 (ActionStatus)
  },

  "dialog": {
    object (Dialog)
  }
}
Trường
actionStatus

object (ActionStatus)

Chỉ có đầu 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.
Thao tác 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

object (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 phần nội dung thẻ của hộp thoại.

Biểu diễn dưới dạng JSON 
{
  "body": {
    object (Card)
  }
}
Trường
body

object (Card)

Chỉ có đầu vào. Nội dung của hộp thoại, được hiển thị trong một phương thức.

ActionStatus

Đại diện cho 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 (Code),
  "userFacingMessage": string
}
Trường
statusCode

enum (Code)

Mã trạng thái.
userFacingMessage

string

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, một thông báo chung dựa trên statusCode sẽ được gửi.

Mã

Mã lỗi chuẩn cho API gRPC.

Đôi khi, nhiều mã lỗi có thể áp dụng. 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ỗi; được trả về khi thành công.

Ánh xạ HTTP: 200 OK
CANCELLED

Thao tác đã bị huỷ, thường là do phương thức gọi.

Ánh xạ HTTP: 499 Client Closed Request
UNKNOWN

Lỗi không xác định. Ví dụ: lỗi này có thể được trả về khi giá trị Status nhận được từ một không gian địa chỉ khác thuộc về một không gian lỗi không xác định trong không gian địa chỉ này. Ngoài ra, các lỗi do API không trả về đủ thông tin lỗi cũng có thể được chuyển đổi thành lỗi này.

Ánh xạ HTTP: 500 Lỗi máy chủ nội bộ
INVALID_ARGUMENT

Ứng dụng đã chỉ định một đối số không hợp lệ. Xin lưu ý rằng điều này khác với FAILED_PRECONDITION. INVALID_ARGUMENT cho biết các đối số có vấn đề bất kể trạng thái của hệ thống (ví dụ: tên tệp không đúng định dạng).

Ánh xạ HTTP: 400 Yêu cầu không hợp lệ
DEADLINE_EXCEEDED

Đã hết hạn 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áy chủ có thể bị trì hoãn đủ lâu để hết hạn.

Ánh xạ HTTP: 504 Gateway Timeout
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ư khi triển khai tính năng theo giai đoạn hoặc danh sách cho phép không có trong tài liệu, thì bạn có thể sử dụng NOT_FOUND. Nếu một yêu cầu bị từ chối đối với một số người dùng trong một lớp người dùng, chẳng hạn như chế độ kiểm soát quyền truy cập dựa trên người dùng, thì bạn phải sử dụng PERMISSION_DENIED.

Ánh xạ HTTP: 404 Không tìm thấy
ALREADY_EXISTS

Thực thể mà ứng dụng khách cố gắng tạo (ví dụ: tệp hoặc thư mục) đã tồn tại.

Ánh xạ HTTP: 409 Xung đột
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 PERMISSION_DENIED cho các trường hợp từ chối do hết tài nguyên (thay vào đó, hãy sử dụng RESOURCE_EXHAUSTED cho các lỗi đó). Không được sử dụng PERMISSION_DENIED nếu không thể xác định phương thức gọi (hãy sử dụng UNAUTHENTICATED cho những lỗi đó). Mã lỗi này không có nghĩa là yêu cầu hợp lệ hoặc thực thể được yêu cầu tồn tại hoặc đáp ứng các điều kiện tiên quyết khác.

Á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 này.

Ánh xạ HTTP: 401 Unauthorized
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

Thao tác 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 tồn tại, 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 FAILED_PRECONDITION, ABORTED và UNAVAILABLE: (a) Sử dụng UNAVAILABLE nếu ứng dụng có thể thử lại lệnh gọi không thành công. (b) Sử dụng ABORTED nếu ứng dụng khách nên thử lại ở cấp cao hơn. Ví dụ: khi một thao tác kiểm tra và đặt do ứng dụng chỉ định không thành công, cho biết ứng dụng nên khởi động lại trình tự đọc-sửa đổi-ghi. (c) Sử dụng FAILED_PRECONDITION nếu ứng dụng không nên thử lại cho đến khi trạng thái hệ thống được khắc phục rõ ràng. Ví dụ: nếu "rmdir" không thành công vì thư mục không trống, thì FAILED_PRECONDITION sẽ được trả về vì ứng dụng không nên thử lại trừ phi các tệp bị xoá khỏi thư mục.

Á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 trình tự hoặc huỷ giao dịch.

Xem hướng dẫn ở trên để quyết định giữa FAILED_PRECONDITION, ABORTED và UNAVAILABLE.

Ánh xạ HTTP: 409 Xung đột
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 sau khi kết thúc tệp.

Không giống như INVALID_ARGUMENT, lỗi này cho biết một vấn đề có thể được khắc phục nếu trạng thái hệ thống thay đổi. Ví dụ: hệ thống tệp 32 bit sẽ tạo INVALID_ARGUMENT nếu được yêu cầu đọc ở độ lệch không nằm trong dải [0,2^32-1], nhưng sẽ tạo OUT_OF_RANGE nếu được yêu cầu đọc từ độ lệch vượt quá kích thước tệp hiện tại.

FAILED_PRECONDITION và OUT_OF_RANGE có một số điểm trùng lặp. Bạn nên sử dụng OUT_OF_RANGE (lỗi cụ thể hơn) khi áp dụng để những phương thức gọi lặp lại trong một không gian có thể dễ dàng tìm lỗi OUT_OF_RANGE để phát hiện thời điểm hoàn tất.

Ánh xạ 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.

Ánh xạ HTTP: 501 Chưa 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 được 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 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 sau một khoảng thời gian đợi. Xin lưu ý rằng không phải lúc nào cũng an toàn khi thử lại các thao tác không có tính luỹ đẳng.

Xem hướng dẫn ở trên để quyết định giữa FAILED_PRECONDITION, ABORTED và UNAVAILABLE.

Ánh xạ 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 trình đơn nhiều lựa chọn.

Biểu diễn dưới dạng JSON 
{
  "widget": string,

  "suggestions": {
    object (SelectionItems)
  }
}
Trường
widget

string

Mã của tiện ích được cập nhật. Mã nhận dạng phải khớp với mã nhận dạng của tiện ích đã kích hoạt yêu cầu cập nhật.
Tiện ích đã cập nhật để phản hồi 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

object (SelectionItems)

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 (SelectionItem)
    }
  ]
}
Trường
items[]

object (SelectionItem)

Một mảng chứa 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

string (int64 format)

Mã nhận dạng 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. Ứng dụng trò chuyện có thể xem trước các URL phù hợ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

string

Chỉ có đầu ra. URL khớp với mẫu.

EmojiReactionSummary

Số người đã bày tỏ cảm xúc bằng một biểu tượng cảm xúc cụ thể đối với một tin nhắn.

Biểu diễn dưới dạng JSON 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
Trường
emoji

object (Emoji)

Chỉ có đầu ra. Biểu tượng cảm xúc liên quan đến lượt thể hiện cảm xúc.
reactionCount

integer

Chỉ có đầu ra. Tổng số lượt bày tỏ cảm xúc bằng biểu tượng cảm xúc liên quan.

DeletionMetadata

Thông tin về tin nhắn đã xoá. Tin nhắn sẽ bị xoá khi deleteTime được đặt.

Biểu diễn dưới dạng JSON 
{
  "deletionType": enum (DeletionType)
}
Trường
deletionType

enum (DeletionType)

Cho biết người đã xoá tin nhắn.

DeletionType

Người đã xoá tin nhắn và cách xoá. Các giá trị khác có thể được thêm vào trong tương lai. 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 có thể xoá tin nhắn.

Enum
DELETION_TYPE_UNSPECIFIED Giá trị này không được sử dụng.
CREATOR Người dùng đã xoá tin nhắn của chính họ.
SPACE_OWNER Chủ sở hữu hoặc người quản lý đã xoá tin nhắn.
ADMIN Một quản trị viên Google Workspace đã xoá tin nhắn này. Quản trị viên có thể xoá mọi tin nhắn trong không gian, bao gồm 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 ứng dụng đó khi tin nhắn hết hạn.
CREATOR_VIA_APP Một ứng dụng Chat đã thay mặt người tạo xoá tin nhắn (bằng phương thức xác thực người dùng).
SPACE_OWNER_VIA_APP Một ứng dụng Chat đã xoá tin nhắn thay mặt cho người quản lý không gian (bằng cách 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 tin nhắn mà một tin nhắn 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.

Để xem ví dụ về cách sử dụng, hãy xem phần Trích dẫn tin nhắn khác.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "lastUpdateTime": string,
  "quoteType": enum (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
Trường
name

string

Bắt buộc. Tên tài nguyên của tin nhắn được trích dẫn.

Định dạng spaces/{space}/messages/{message}
lastUpdateTime

string (Timestamp format)

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 thông báo đã được chỉnh sửa, hãy sử dụng trường lastUpdateTime này. Nếu tin nhắn chưa từng được chỉnh sửa, hãy sử dụng createTime.

Nếu lastUpdateTime không khớp với phiên bản mới nhất của tin nhắn được trích dẫn, thì yêu cầu sẽ không thành công.
quoteType

enum (QuoteType)

Không bắt buộc. Chỉ định loại dấu ngoặc kép. Nếu không được đặt, thì giá trị 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

object (QuotedMessageSnapshot)

Chỉ có đầu ra. Ảnh chụp nhanh nội dung của tin nhắn được trích dẫn.
forwardedMetadata

object (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 sử dụng.
REPLY

Khi quoteType là REPLY, bạn có thể làm những việc sau:

  • Nếu đang trả lời trong một chuỗi tin nhắn, bạn có thể trích dẫn một tin nhắn khác trong chuỗi đó.

  • Nếu đang tạo một tin nhắn gốc, bạn có thể trích dẫn một tin nhắn gốc khác trong không gian đó.
FORWARD

Khi quoteType là FORWARD, bạn có thể trích dẫn:

  • Tin nhắn từ một không gian khác.

  • Tin nhắn trả lời từ một chuỗi tin nhắn khác trong cùng một không gian.

QuotedMessageSnapshot

Cung cấp thông tin tổng quan nhanh về 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 (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
Trường
sender

string

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

string

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

string

Chỉ có đầu ra. Chứa tin nhắn được trích dẫn text có thêm mã đánh dấu để hỗ trợ định dạng đa dạng thức như siêu liên kết,biểu tượng cảm xúc tuỳ chỉnh, mã đánh dấu, v.v. Chỉ được điền sẵn cho loại trích dẫn CHUYỂN TIẾP.
annotations[]

object (Annotation)

Chỉ có đầu ra. Chú thích đượ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[]

object (Attachment)

Chỉ có đầu ra. Tệp đính kèm trong tin nhắn được trích dẫn. Đây là bản sao siêu dữ liệu của 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

string

Chỉ có đầu ra. Tên tài nguyên của không gian nguồn. Định dạng: spaces/{space}
spaceDisplayName

string

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 SPACE, đây là tên không gian. Đối với DIRECT_MESSAGE, đây là tên của người tham gia khác (ví dụ: "Người dùng A"). Đối với GROUP_CHAT, đây là tên được tạo dựa trên tên của các thành viên, tối đa 5 người, bao gồm cả nhà sáng tạo (ví dụ: "Người dùng A, Người dùng B").

AttachedGif

Hình ảnh GIF được chỉ định bằng một URL.

Biểu diễn dưới dạng JSON 
{
  "uri": string
}
Trường
uri

string

Chỉ có đầu ra. URL lưu trữ hình ảnh GIF.

Phần tử

Thành phần là các thành phần bổ sung có thể liên kết hoặc không liên kết với văn bản thông báo được cung cấp trong quá trình tạo thông báo.

Biểu diễn dưới dạng JSON 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ],
  "steps": {
    object (Steps)
  }
}
Trường
citedSources[]

object (CitedSource)

Danh sách các nguồn sẽ xuất hiện dưới dạng đường liên kết ở chân trang của thông báo. Các tệp này không được tham chiếu cùng dòng. Đối với tệp đối chiếu cùng dòng, hãy sử dụng citations.
citations[]

object (Citation)

Danh sách các trích dẫn nội dòng được tham chiếu trong văn bản của tin nhắn (thông qua thẻ <chat-citation>) hiển thị dưới dạng thẻ di chuột tương tác.
steps

object (Steps)

Không bắt buộc. Một thành phần cho biết các bước mà ứng dụng Chat thực hiện để tạo tin nhắn.

Các bước

Tập hợp các mục liên kết với một tin nhắn trò chuyện, giúp xác định cách tin nhắn được tạo. Ứng dụng Chat có thể sử dụng các bước để hiển thị lý do, lệnh gọi công cụ hoặc tiến trình liên quan đến việc tạo tin nhắn.

Biểu diễn dưới dạng JSON 
{
  "steps": [
    {
      object (Step)
    }
  ]
}
Trường
steps[]

object (Step)

Không bắt buộc. Danh sách các bước.

Phương thức

create

 Tạo tin nhắn trong không gian Google Chat.

delete

 Xoá tin nhắn.

get

 Trả về thông tin chi tiết về một tin nhắn.

list

 Liệt kê các 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.

patch

 Cập nhật tin nhắn.

replaceCards

 Thay thế các thẻ có trong một tin nhắn.
Tìm kiếm tin nhắn trong Google Chat mà người dùng gọi có quyền truy cập.

update

 Cập nhật tin nhắn.