REST Resource: spaces.messages

Tài nguyên: Tin nhắn

Tin nhắn trong phòng 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,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ]
}
Trường
name

string

Tên tài nguyên của thông báo.

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

Trong đó {space} là mã không gian đăng tin nhắn và {message} là mã 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, thì bạn có thể dùng mã này để chỉ định thông báo trong 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 phần Đặt tên cho tin nhắn.

sender

object (User)

Chỉ có đầu ra. Người dùng đã tạo thông báo. Nếu ứng dụng Chat xác thực với tư cách một người dùng, thì kết quả sẽ điền là người dùng nametype.

createTime

string (Timestamp format)

Không bắt buộc. Không thể thay đổi. Đố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ỉ là kết quả đầu ra, trừ phi được dùng trong không gian ở chế độ nhập.

Đối với không gian cho chế độ nhập, hãy đặt trường này thành dấu thời gian trước đây khi thông báo được tạo trong nguồn để duy trì thời gian tạo ban đầu.

lastUpdateTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian 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 trống.

deleteTime

string (Timestamp format)

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

text

string

Nội dung thông báo ở 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 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 văn bản.

formattedText

string

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

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

  • Người dùng đề cập bằng đị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 :{emoji_name}: – ví dụ: :smile:. Điều này không áp dụng cho biểu tượng cảm xúc Unicode, chẳng hạn như U+1F600 đối với biểu tượng cảm xúc mặt cười toe toét.

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

object (Card)

Không dùng nữa: Thay vào đó, hãy dùng cardsV2.

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 phần tử 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 xuất hiện bên dưới phần nội dung văn bản thuần tuý của thông báo. cardscardsV2 có thể có kích thước tối đa là 32 KB.

cardsV2[]

object (CardWithId)

Một dãy thẻ.

Chỉ các ứng dụng trong Chat mới có thể tạo thẻ. Nếu ứng dụng Chat 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 Gửi tin nhắn thẻ.

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 liên quan đến text trong tin nhắn này.

thread

object (Thread)

Chuỗi chứa tin nhắn. Để tham khảo ví dụ về cách sử dụng, hãy xem phần Bắt đầu hoặc trả lời chuỗi tin nhắn.

space

object (Space)

Nếu ứng dụng Chat 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 name.

fallbackText

string

Nội dung mô tả thẻ tin nhắn dưới dạng văn bản thuần tuý, 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

object (ActionResponse)

Chỉ nhập. Những tham số mà một ứng dụng Chat có thể dùng để định cấu hình cách đăng câu trả lời.

argumentText

string

Chỉ có đầu ra. Nội dung văn bản thuần tuý của thư cùng tất cả nội dung đề cập đến ứng dụng Chat đã được loại bỏ.

slashCommand

object (SlashCommand)

Chỉ có đầu ra. Dấu gạch chéo thông tin lệnh, nếu có.

attachment[]

object (Attachment)

Tệp đính kèm do người dùng tải lên.

matchedUrl

object (MatchedUrl)

Chỉ có đầu ra. URL trong spaces.messages.text khớp với mẫu 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à phản hồ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 tin nhắn hoặc tin nhắn không có tin nhắn trả lời theo chuỗi.

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

clientAssignedMessageId

string

Không bắt buộc. Mã nhận dạng tuỳ chỉnh của thông báo. Bạn có thể sử dụng trường để xác định một tin nhắn hoặc để nhận, xoá hoặc cập nhậ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 phần Đặt tên cho tin nhắn.

emojiReactionSummaries[]

object (EmojiReactionSummary)

Chỉ có đầu ra. Danh sách thông tin tóm tắt về lượt thể hiện cảm xúc bằng biểu tượng trên thư.

privateMessageViewer

object (User)

Không thể thay đổi. Dữ liệu đầu vào để tạo thông báo, nếu không thì chỉ xuất. Người dùng có thể xem thông báo. Khi bạn đặt, tin nhắn sẽ ở chế độ riêng tư và chỉ hiển thị với người dùng được chỉ định cũng như ứng dụng Chat. Bản xem trước đường liên kết và tệp đính kèm không được hỗ trợ cho tin nhắn riêng tư.

Chỉ các ứng dụng trong Chat mới có thể gửi tin nhắn riêng tư. Nếu ứng dụng Chat xác thực với tư cách người dùng để gửi tin nhắn thì tin nhắn không được ở chế độ riêng tư và phải bỏ qua trường này.

Để biết thông tin chi tiết, hãy xem bài viết Gửi tin nhắn riêng tư cho người dùng Google Chat.

deletionMetadata

object (DeletionMetadata)

Chỉ có đầ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 deleteTime.

quotedMessageMetadata

object (QuotedMessageMetadata)

Chỉ có đầu ra. Thông tin về tin nhắn được 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 tin nhắn để trả lời.

attachedGifs[]

object (AttachedGif)

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

accessoryWidgets[]

object (AccessoryWidget)

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 các tiện ích phụ vào tin nhắn chứa văn bản, thẻ hoặc cả văn bản và thẻ. Không được hỗ trợ đối với những thư chứa hộp thoại. Để biết thông tin chi tiết, hãy xem phần Thêm tiện ích tương tác ở cuối thư.

Để tạo tin nhắn bằng các tiện ích phụ kiện, bạn phải xác thực ứng dụng.

CardWithId

Thẻ trong tin nhắn trên Google Chat.

Chỉ các ứng dụng trong Chat mới có thể tạo thẻ. Nếu ứng dụng Chat xác thực với tư cách người dùng, thì tin nhắn không được chứa thẻ.

Thiết kế và xem trước thẻ bằng Trình tạo thẻ.

Mở Trình tạo thẻ

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

string

Đây là trường 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

object (Card)

Thẻ. Kích thước tối đa là 32 KB.

Annotation

Chỉ có đầu ra. Chú thích liên quan đến phần nội dung văn bản thuần tuý của tin nhắn. Để 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 (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  }
  // End of list of possible types for union field metadata.
}
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ông báo dạng văn bản thuần tuý mà chú thích này tương ứng với.

startIndex

integer

Chỉ mục bắt đầu (dựa trên 0, bao gồm) trong 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 hợp metadata. Siêu dữ liệu bổ sung về chú thích. metadata chỉ có thể là một trong những trạng thái sau:
userMention

object (UserMentionMetadata)

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

slashCommand

object (SlashCommandMetadata)

Siêu dữ liệu của lệnh dấu gạch chéo.

AnnotationType

Loại chú thích.

Enum
ANNOTATION_TYPE_UNSPECIFIED Giá trị mặc định cho enum. Không sử dụng.
USER_MENTION Có một người dùng được đề cập.
SLASH_COMMAND Lệnh dấu gạch chéo sẽ được gọi ra.

UserMentionMetadata

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 (User)
  },
  "type": enum (Type)
}
Trường
user

object (User)

Người dùng đã đề cập.

type

enum (Type)

Loại lượt đề cập của 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 (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 liệu lệnh dấu gạch chéo có phải 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 đa dạng thức đến tài nguyên.

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

  // Union field data can be only one of the following:
  "driveLinkData": {
    object (DriveLinkData)
  }
  // End of list of possible types for union field data.
}
Trường
uri

string

URI của đường liên kết này.

Trường hợp data. Dữ liệu của tài nguyên được liên kết. data chỉ có thể là một trong những trạng thái sau:

RichLinkType

Loại đường liên kết đa phương tiện. Chúng tôi có thể thêm nhiều loại khác trong tương lai.

Enum
DRIVE_FILE Loại đường liên kết đa phương tiện của Google Drive.

DriveLinkData

Dữ liệu về đườ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.

Chuỗi hội thoại

Một chuỗi cuộc trò chuyện trong một phòng Google Chat. Để tham khảo ví dụ về cách sử dụng, hãy xem phần Bắt đầu hoặc trả lời chuỗi tin nhắn.

Nếu chỉ định một chuỗi khi tạo thông báo, thì bạn có thể đặt trường messageReplyOption để xác định điều gì sẽ xảy ra nếu không tìm thấy chuỗi nào phù hợp.

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

string

Chỉ có đầu ra. Tên tài nguyên của luồng.

Ví dụ: spaces/{space}/threads/{thread}

threadKey

string

Không bắt buộc. Dữ liệu đầu vào để tạo hoặc cập nhật một luồng. Nếu không, bạn sẽ chỉ nhận được kết quả đầu ra. Mã nhận dạng của 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. 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ì các tin nhắn đó sẽ được đăng trong các chuỗi khác nhau. Để trả lời trong chuỗi do người dùng hoặc ứng dụng khác trong Chat tạo, hãy chỉ định trường name của chuỗi.

ActionResponse

Những tham số mà một ứ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 (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
Trường
type

enum (ResponseType)

Chỉ nhập. Loại phản hồi của ứng dụng Chat.

url

string

Chỉ nhập. URL để người dùng xác thực hoặc định cấu hình. (Chỉ dành cho REQUEST_CONFIG loại phản hồi.)

dialogAction

object (DialogAction)

Chỉ nhập. Phản hồi cho một sự kiện tương tác liên quan đến hộp thoại. Phải có ResponseType.Dialog đi kèm.

updatedWidget

object (UpdatedWidget)

Chỉ nhập. Phản hồi của tiện ích đã cập nhật.

ResponseType

Loại phản hồi của ứng dụng Chat.

Enum
TYPE_UNSPECIFIED Loại mặc định được xử lý là NEW_MESSAGE.
NEW_MESSAGE Đăng dưới dạng tin nhắn mới trong chủ đề.
UPDATE_MESSAGE Cập nhật tin nhắn của ứng dụng Chat. Điều này chỉ được phép trên sự kiện CARD_CLICKED khi loại người gửi 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 dùng để 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.
UPDATE_WIDGET Truy vấn tuỳ chọn tự động hoàn thành văn bản tiện ích.

DialogAction

Chứa hộp thoại và yêu cầu mã trạng thái.

Biểu diễn dưới dạng JSON
{
  "actionStatus": {
    object (ActionStatus)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}
Trường
actionStatus

object (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 hợp action. Hành động cần thực hiện. action chỉ có thể là một trong những trạng thái sau:
dialog

object (Dialog)

Chỉ nhập. Hộp thoại cho yêu cầu.

Hộp thoại

Bao bọc xung quanh phần thân 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ỉ nhập. Nội dung của hộp thoại, được hiển thị trong một cửa sổ phụ. Các ứng dụng Google Chat không hỗ trợ các thực thể thẻ sau: DateTimePicker, OnChangeAction.

ActionStatus

Biểu thị 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 chính sách này, thì một thông báo chung dựa trên statusCode sẽ được gửi.

Mã lỗi chính tắc cho các API gRPC.

Đôi khi, có thể có nhiều mã lỗi xuất hiện. Các dịch vụ phải trả về mã lỗi cụ thể nhất theo trường hợp. Ví dụ: ưu tiên OUT_OF_RANGE hơn FAILED_PRECONDITION nếu áp dụng cả hai mã. 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 phương thức gọi.

Liên kết 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ị 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ó thể được chuyển đổi thành lỗi này.

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

INVALID_ARGUMENT

Ứng dụng đã chỉ định một đối số không hợp lệ. Xin lưu ý rằng giá trị 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: Yêu cầu 400 không hợp lệ

DEADLINE_EXCEEDED

Đã hết thời 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ụ: 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: Thời gian chờ cổng vào 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 lớp 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 ghi nhận, thì NOT_FOUND có thể được sử dụng. Nếu 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ư kiểm soát quyền truy cập dựa trên người dùng, thì bạn phải dùng PERMISSION_DENIED.

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

ALREADY_EXISTS

Thực thể mà ứng dụng khách cố 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 PERMISSION_DENIED cho các trường hợp từ chối do đã dùng hết một số 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 (thay vào đó, hãy sử dụng UNAUTHENTICATED cho các lỗi đó). Mã lỗi này không ngụ ý rằng yêu cầu là hợp lệ hay thực thể được yêu cầu tồn tại hay đá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 không được 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

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 này. 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 một 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 FAILED_PRECONDITION, ABORTEDUNAVAILABLE: (a) Sử dụng UNAVAILABLE nếu ứng dụng có thể chỉ thử lại lệnh gọi không thành công. (b) Sử dụng ABORTED nếu ứng dụng nên thử lại ở cấp cao hơn. Ví dụ: khi kiểm thử và tập hợp do ứng dụng chỉ định không thành công, ứng dụng cần phải 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 do 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: Yêu cầu 400 không hợp lệ

ABORTED

Thao tác đã bị huỷ, thường là do sự cố đồng thời, chẳng hạn như lỗi kiểm tra trình tự hoặc giao dịch bị huỷ.

Xem các nguyên tắc ở trên để biết cách quyết định giữa FAILED_PRECONDITION, ABORTED hay UNAVAILABLE.

Ánh xạ HTTP: Xung đột 409

OUT_OF_RANGE

Đã cố gắng thực hiện thao tác vượt quá phạm vi hợp lệ. Ví dụ: tìm kiếm hoặc đọc cuối tệp trong quá khứ.

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 phạm vi [0,2^32-1], nhưng sẽ tạo OUT_OF_RANGE nếu được yêu cầu đọc từ một độ lệch vượt quá kích thước tệp hiện tại.

Có một chút trùng lặp giữa FAILED_PRECONDITIONOUT_OF_RANGE. Bạn nên sử dụng OUT_OF_RANGE (lỗi cụ thể hơn) khi áp dụng lỗi này để các phương thức gọi đang lặp lại qua một không gian có thể dễ dàng tìm lỗi OUT_OF_RANGE nhằm phát hiện khi nào chúng hoàn tất.

Á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. 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.

Xem các nguyên tắc ở trên để biết cách quyết định giữa FAILED_PRECONDITION, ABORTED hay UNAVAILABLE.

Ánh xạ HTTP: Dịch vụ 503 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

UpdatedWidget

Phản hồi của tiện ích đã cập nhật. Dùng để cung cấp tuỳ chọn tự động hoàn thành cho tiện ích.

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

  // Union field updated_widget can be only one of the following:
  "suggestions": {
    object (SelectionItems)
  }
  // End of list of possible types for union field updated_widget.
}
Trường
widget

string

Mã của tiện ích được cập nhật. Mã này phải khớp với mã của tiện ích đã kích hoạt yêu cầu cập nhật.

Trường hợp updated_widget. Tiện ích được cập nhật để phản hồi hành động của người dùng. updated_widget chỉ có thể là một trong những trạng thái sau:
suggestions

object (SelectionItems)

Danh sách kết quả tự động hoàn thành tiện ích

SelectionItems

Danh sách kết quả tự động hoàn thành tiện ích.

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

object (SelectionItem)

Một mảng gồm các đối tượng SelectionItem.

SlashCommand

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ã của lệnh dấu gạch chéo đã được gọi.

MatchedUrl

URL trùng khớp trong một tin nhắn trên Chat. Các ứng dụng trong Chat có thể xem trước các URL khớp. Để biết thêm thông tin, hãy xem mục 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.

EmojiReactionSummary

Số người đã thể hiện cảm xúc 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 (Emoji)
  },
  "reactionCount": integer
}
Trường
emoji

object (Emoji)

Biểu tượng cảm xúc liên quan đến lượt thể hiện cảm xúc.

reactionCount

integer

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

DeletionMetadata

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 (DeletionType)
}
Trường
deletionType

enum (DeletionType)

Cho biết ai đã xoá thư.

DeletionType

Ai đã xoá thư và cách xoá thư.

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 này.
APP_MESSAGE_EXPIRY Một ứng dụng Chat đã xoá tin nhắn của chính mình khi hết hạn.
CREATOR_VIA_APP Một ứng dụng Chat đã thay mặt người dùng xoá tin nhắn này.
SPACE_OWNER_VIA_APP Một ứng dụng Chat đã thay mặt chủ sở hữu không gian xoá tin nhắn này.

QuotedMessageMetadata

Thông tin về tin nhắn được trích dẫn.

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

string

Chỉ có đầu ra. 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)

Chỉ có đầu ra. 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 gần đây nhất của tin nhắn được trích dẫn.

AttachedGif

Hình ảnh GIF được chỉ định bởi 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.

AccessoryWidget

Một hoặc nhiều tiện ích tương tác xuất hiện ở cuối thư. Để biết thông tin chi tiết, hãy xem phần Thêm tiện ích tương tác ở cuối thư.

Biểu diễn dưới dạng JSON
{

  // Union field action can be only one of the following:
  "buttonList": {
    object (ButtonList)
  }
  // End of list of possible types for union field action.
}
Trường
Trường hợp action. Loại hành động. action chỉ có thể là một trong những trạng thái sau:
buttonList

object (ButtonList)

Danh sách các nút.

Phương thức

create

Tạo tin nhắn trong phòng 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ê tin nhắn trong một không gian có người gọi, bao gồm cả tin nhắn từ các thành viên và không gian bị chặn.

patch

Cập nhật một tin nhắn.

update

Cập nhật một tin nhắn.