REST Resource: spaces.messages

资源：Message

Google Chat 聊天室中的消息。

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)
}
字段
name

string

标识符。消息的资源名称。

格式：spaces/{space}/messages/{message}

其中，{space} 是发布消息的聊天室的 ID，{message} 是系统为消息分配的 ID。例如 spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB。

如果您在创建消息时设置了自定义 ID，则可以在请求中使用此 ID 来指定消息，方法是将 {message} 替换为 clientAssignedMessageId 字段中的值。例如 spaces/AAAAAAAAAAA/messages/client-custom-name。如需了解详情，请参阅为消息命名。
sender

object (User)

仅限输出。创建消息的用户。如果您的 Chat 应用以用户身份进行身份验证，则输出只会为内部和外部用户填充 user name 和 type 字段，除非他们是聊天室成员或与调用用户有先前的亲和关系（例如私信 [DM] 对话）。
createTime

string (Timestamp format)

可选。不可变。对于在 Chat 中创建的聊天室，这是消息的创建时间。此字段仅限输出，但在导入模式聊天室中使用时除外。

对于导入模式聊天室，请将此字段设置为在来源中创建消息的历史时间戳，以保留原始创建时间。
lastUpdateTime

string (Timestamp format)

仅限输出。用户上次修改消息的时间。如果消息从未被修改过，则此字段为空。
deleteTime

string (Timestamp format)

仅限输出。在 Google Chat 中删除消息的时间。如果消息从未被删除，则此字段为空。
text

string

可选。邮件的纯文本正文。指向图片、视频或网页的第一个链接会生成预览条状标签。您还可以使用“@”提及 Google Chat 用户或聊天室中的所有人。

如需了解如何创建短信，请参阅发送消息。
formattedText

string

仅限输出。包含消息 text，其中添加了标记以传达格式。此字段可能无法捕获界面中显示的所有格式，但包含以下内容：

  • 标记语法，用于粗体、斜体、删除线、等宽字体、等宽字体块、项目符号列表和块引用。

  • 使用 <users/{user}> 格式提及用户。

  • 使用 <{url}|{rendered_text}> 格式的自定义超链接，其中第一个字符串是网址，第二个字符串是呈现的文本，例如 <http://example.com|custom text>。

  • 使用 :{emojiName}: 格式的自定义表情符号，例如 :smile:。这不适用于 Unicode 表情符号，例如 U+1F600 表示露齿笑脸表情符号。

  • 使用星号 (*) 的项目符号列表项，例如 * item。

如需了解详情，请参阅查看消息中发送的文本格式
cards[]
(deprecated)

object (Card)

已弃用：请改用 cardsV2。

内容丰富、格式规范且可互动的卡片，可用于显示界面元素，例如：格式化文本、按钮和可点击的图片。卡片通常显示在邮件的纯文本正文下方。cards 和 cardsV2 的大小上限为 32 KB。
cardsV2[]

object (CardWithId)

可选。卡片数组。

Chat 应用可以使用应用身份验证创建卡片。作为开发者预览版计划的一部分，如果您的 Chat 应用以用户身份进行身份验证，则可以创建卡片消息。如果您的 Chat 应用未加入开发者预览版计划，则无法创建需要用户身份验证的卡片。

如需了解如何创建包含卡片的消息，请参阅发送消息。

使用卡片构建器设计和预览卡片。

打开卡片构建器
annotations[]

object (Annotation)

仅限输出。注释可以与消息的纯文本正文相关联，也可以与链接到 Google Workspace 资源（例如 Google 文档或表格）的条状标签相关联，其 startIndex 和 length 为 0。
thread

object (Thread)

邮件所属的会话。如需查看用法示例，请参阅发起或回复消息串。
space

object (Space)

仅限输出。如果您的 Chat 应用以用户身份进行身份验证，则输出仅填充聊天室 name。
fallbackText

string

可选。消息卡片的纯文本说明，在无法显示实际卡片时（例如移动设备通知）使用。
actionResponse

object (ActionResponse)

仅限输入。Chat 应用可用于配置其回答发布方式的参数。
argumentText

string

仅限输出。消息的纯文本正文，其中去除了所有提及 Chat 应用的内容。
slashCommand

object (SlashCommand)

仅限输出。斜杠命令信息（如果适用）。
attachment[]

object (Attachment)

可选。用户上传的附件。
matchedUrl

object (MatchedUrl)

仅限输出。聊天消息 text 字段中与链接预览格式匹配的网址。如需了解详情，请参阅预览链接。
threadReply

boolean

仅限输出。如果值为 true，则表示该消息是回复消息串中的回复。如果为 false，则消息会作为消息串的第一条消息或没有消息串式回复的消息显示在聊天室的顶级对话中。

如果聊天室不支持在消息串中回复，则此字段始终为 false。
silent

boolean

仅限输出。此消息是否为静音消息。静默消息是指 Chat 会为收件人屏蔽推送通知的消息。
clientAssignedMessageId

string

可选。消息的自定义 ID。您可以使用此字段来标识消息，或获取、删除或更新消息。如需设置自定义 ID，请在创建消息时指定 messageId 字段。如需了解详情，请参阅为消息命名。
emojiReactionSummaries[]

object (EmojiReactionSummary)

仅限输出。消息的表情符号回应摘要列表。
privateMessageViewer

object (User)

可选。不可变。用于创建消息的输入，否则仅输出。可以查看消息的用户。设置后，消息将变为私密消息，仅对指定用户和 Chat 应用可见。如需在请求中添加此字段，您必须使用应用身份验证调用 Chat API，并省略以下内容：

如需了解详情，请参阅私下发送消息。
deletionMetadata

object (DeletionMetadata)

仅限输出。有关已删除邮件的信息。设置 deleteTime 后，系统会删除消息。
quotedMessageMetadata

object (QuotedMessageMetadata)

可选。另一条消息引用的消息的相关信息。

创建消息时，您可以引用同一消息串中的消息，也可以引用根消息来创建新的根消息。不过，您无法引用其他消息串中的消息回复。

更新消息时，您无法添加或替换 quotedMessageMetadata 字段，但可以将其移除。

如需查看用法示例，请参阅引用其他消息。
attachedGifs[]

object (AttachedGif)

仅限输出。邮件中附加的 GIF 图片。
accessoryWidgets[]

object (AccessoryWidget)

可选。显示在消息底部的一个或多个互动式 widget。您可以向包含文本、卡片或同时包含文本和卡片的消息添加辅助微件。不支持包含对话框的消息。如需了解详情，请参阅在邮件底部添加互动式微件。

创建包含辅助微件的消息需要应用身份验证。
elements

object (Elements)

可选。元素是在创建消息期间提供的其他组件，可能与消息文本的特定部分相关联，也可能不相关。这与注释不同，注释仅用于输出，提供与消息片段或整个消息文本相关的补充信息。
markupSyntax

enum (MarkupSyntax)

可选。指定服务器如何解读消息 text 字段内容。

CardWithId

Google Chat 聊天消息中的卡片。

Chat 应用可以使用应用身份验证创建卡片。作为开发者预览版计划的一部分，如果您的 Chat 应用以用户身份进行身份验证，则可以创建卡片消息。如果您的 Chat 应用未加入开发者预览版计划，则无法创建需要用户身份验证的卡片。

如需了解如何创建包含卡片的消息，请参阅发送消息。

使用卡片构建器设计和预览卡片。

打开卡片构建器

JSON 表示法 
{
  "cardId": string,
  "card": {
    object (Card)
  },
  "ownerUser": {
    object (User)
  }
}
字段
cardId

string

如果消息包含多张卡片，则必须提供此字段。消息中卡片的唯一标识符。
card

object (Card)

一张卡片。大小上限为 32 KB。
ownerUser

object (User)

仅限输出。拥有该卡的应用。

注释

注释可以与消息的纯文本正文相关联，也可以与链接到 Google 文档或表格等 Google Workspace 资源的条状标签相关联，其中 startIndex 和 length 为 0。如需为短信添加基本格式，请参阅设置短信格式。

纯文本邮件正文示例：

Hello @FooBot how are you!"

相应的注释元数据：

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
JSON 表示法 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
字段
type

enum (AnnotationType)

此注释的类型。
length

integer

此注释对应的纯文本邮件正文中的子字符串长度。如果不存在，则表示长度为 0。
startIndex

integer

此注释对应的纯文本邮件正文中的起始索引（从 0 开始，包含边界值）。
有关注释的其他元数据。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
userMention

object (UserMentionMetadata)

用户提及的元数据。
slashCommand

object (SlashCommandMetadata)

斜杠命令的元数据。
customEmojiMetadata

object (CustomEmojiMetadata)

自定义表情符号的元数据。
互斥字段结束。

AnnotationType

注释的类型。

枚举
ANNOTATION_TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
USER_MENTION 有人提及了某位用户。
SLASH_COMMAND 调用了斜杠命令。
CUSTOM_EMOJI 自定义表情符号注释。

UserMentionMetadata

用户提及 (@) 的注释元数据。

JSON 表示法 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
字段
user

object (User)

提及的用户。
type

enum (Type)

用户提及类型。

类型

枚举
TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
ADD 将用户添加到聊天室。
MENTION 在聊天室中提及用户。

SlashCommandMetadata

斜杠命令 (/) 的注释元数据。

JSON 表示法 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
字段
bot

object (User)

调用了其命令的 Chat 应用。
type

enum (Type)

斜杠命令的类型。
commandName

string

调用的斜杠命令的名称。
commandId

string (int64 format)

所调用的斜杠命令的命令 ID。
triggersDialog

boolean

指示斜杠命令是否用于对话框。

类型

枚举
TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
ADD 将 Chat 应用添加到聊天室。
INVOKE 在聊天室中调用斜杠命令。

RichLinkMetadata

指向资源的富链接。富链接可以与消息的纯文本正文相关联，也可以表示链接到 Google Workspace 资源（例如 Google 文档或表格）的条状标签，其 startIndex 和 length 为 0。

JSON 表示法 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
字段
uri

string

此链接的 URI。
关联资源的数据。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
互斥字段结束。

RichLinkType

富链接类型。未来可能会添加更多类型。

枚举
DRIVE_FILE Google 云端硬盘富链接类型。
CHAT_SPACE Chat 聊天室富链接类型。例如，聊天室智能条状标签。
GMAIL_MESSAGE Gmail 邮件富链接类型。具体来说，就是分享到 Chat 功能中的 Gmail 芯片。该 API 仅支持读取包含 GMAIL_MESSAGE 丰富链接的消息。
MEET_SPACE Meet 消息富链接类型。例如，Meet 芯片。
CALENDAR_EVENT 日历消息富链接类型。例如，日历条状标签。

DriveLinkData

Google 云端硬盘链接的数据。

JSON 表示法 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
字段
driveDataRef

object (DriveDataRef)

引用 Google 云端硬盘文件的 DriveDataRef。
mimeType

string

关联的 Google 云端硬盘资源的 MIME 类型。

ChatSpaceLinkData

Chat 聊天室链接的数据。

JSON 表示法 
{
  "space": string,
  "thread": string,
  "message": string
}
字段
space

string

关联的 Chat 聊天室资源所在的聊天室。

格式：spaces/{space}
thread

string

关联的 Chat 聊天室资源的消息串。

格式：spaces/{space}/threads/{thread}
message

string

关联的 Chat 聊天室资源的消息。

格式：spaces/{space}/messages/{message}

MeetSpaceLinkData

Meet 空间链接的数据。

JSON 表示法 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
字段
meetingCode

string

关联的 Meet 空间的会议代码。
type

enum (Type)

指明 Meet 空间的类型。
huddleStatus

enum (HuddleStatus)

可选。仅限输出。如果 Meet 是 Huddle，则表示 Huddle 的状态。否则，此字段处于未设置状态。

类型

Meet 空间的类型。

枚举
TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
MEETING Meet 空间是一场会议。
HUDDLE Meet 空间是即时会议。

HuddleStatus

huddle 的状态

枚举
HUDDLE_STATUS_UNSPECIFIED 枚举的默认值。请勿使用。
STARTED 即时会议已开始。
ENDED 即时会议已结束。在这种情况下，Meet 空间 URI 和标识符将不再有效。
MISSED 您错过了即时会议。在这种情况下，Meet 空间 URI 和标识符将不再有效。

CalendarEventLinkData

日历活动链接的数据。

JSON 表示法 
{
  "calendarId": string,
  "eventId": string
}
字段
calendarId

string

所关联日历的日历标识符。
eventId

string

关联的日历活动的活动标识符。

CustomEmojiMetadata

自定义表情符号的注释元数据。

JSON 表示法 
{
  "customEmoji": {
    object (CustomEmoji)
  }
}
字段
customEmoji

object (CustomEmoji)

自定义表情符号。

会话

Google Chat 聊天室中的消息串。如需查看用法示例，请参阅发起或回复消息串。

如果您在创建消息时指定了会话，则可以设置 messageReplyOption 字段，以确定在找不到匹配会话时会发生什么情况。

JSON 表示法 
{
  "name": string,
  "threadKey": string
}
字段
name

string

标识符。会话串的资源名称。

示例：spaces/{space}/threads/{thread}
threadKey

string

可选。用于创建或更新会话串的输入。否则，仅限输出。会话串的 ID。最多支持 4000 个字符。

此 ID 对于设置它的 Chat 应用而言是唯一的。例如，如果多个 Chat 应用使用同一消息串键创建消息，这些消息会发布在不同的消息串中。如需在由用户或其他 Chat 应用创建的消息串中回复，请改为指定消息串 name 字段。

ActionResponse

Chat 应用可用于配置其回答发布方式的参数。

JSON 表示法 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
字段
type

enum (ResponseType)

仅限输入。Chat 应用响应的类型。
url

string

仅限输入。供用户进行身份验证或配置的网址。（仅适用于 REQUEST_CONFIG 响应类型。）
dialogAction

object (DialogAction)

仅限输入。对与对话框相关的互动事件的响应。必须由 ResponseType.Dialog 陪同。
updatedWidget

object (UpdatedWidget)

仅限输入。更新后的 widget 的响应。

ResponseType

Chat 应用响应的类型。

枚举
TYPE_UNSPECIFIED 作为 NEW_MESSAGE 处理的默认类型。
NEW_MESSAGE 在主题中作为新消息发布。
UPDATE_MESSAGE 更新 Chat 应用的消息。只有在消息发送者类型为 BOT 的 CARD_CLICKED 事件中，才允许执行此操作。
UPDATE_USER_MESSAGE_CARDS 更新用户消息中的卡片。只有在响应网址匹配的 MESSAGE 事件或消息发送者类型为 HUMAN 的 CARD_CLICKED 事件时，才允许执行此操作。文本会被忽略。
REQUEST_CONFIG 私下要求用户进行额外的身份验证或配置。
DIALOG 显示对话框。
UPDATE_WIDGET 微件文本自动补全选项查询。

DialogAction

包含对话和请求状态代码。

JSON 表示法 
{
  "actionStatus": {
    object (ActionStatus)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dialog": {
    object (Dialog)
  }
}
字段
actionStatus

object (ActionStatus)

仅限输入。调用或提交对话框的请求的状态。如有必要，向用户显示状态和消息。例如，在发生错误或成功时。
要执行的操作。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
dialog

object (Dialog)

仅限输入。请求的对话。
互斥字段结束。

Dialog

对话框卡片正文的封装容器。

JSON 表示法 
{
  "body": {
    object (Card)
  }
}
字段
body

object (Card)

仅限输入。对话框的正文，在模态窗口中呈现。Google Chat 应用不支持以下卡片实体：DateTimePicker、OnChangeAction。

ActionStatus

表示调用或提交对话框的请求的状态。

JSON 表示法 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
字段
statusCode

enum (Code)

状态代码。
userFacingMessage

string

向用户发送的有关其请求状态的消息。如果未设置，系统会根据 statusCode 发送一般消息。

代码

gRPC API 的规范错误代码。

有时可能有多个错误代码都适用。服务应返回适用且最具体的错误代码。例如，如果 OUT_OF_RANGE 和 FAILED_PRECONDITION 两个代码都适用，则前者优先于后者。同样，NOT_FOUND 或 ALREADY_EXISTS 优先于 FAILED_PRECONDITION。

枚举
OK

不是错误信息；成功时返回此项。

HTTP 映射：200 OK
CANCELLED

操作已取消（通常是被调用者取消）。

HTTP 映射：499 Client Closed Request
UNKNOWN

未知错误。例如，当从另一个地址空间接收到的 Status 值属于此地址空间中未知的错误空间时，可能返回此错误。另外，因 API 没有返回足够错误信息而引发的错误也可能会转换为此错误。

HTTP 映射：500 内部服务器错误
INVALID_ARGUMENT

客户端指定的参数无效。请注意，这与 FAILED_PRECONDITION 不同。无论系统状态如何，INVALID_ARGUMENT 都会指出有问题的参数（例如文件名格式错误）。

HTTP 映射：400 Bad Request
DEADLINE_EXCEEDED

在操作完成之前截止期限已过。对于更改系统状态的操作，即使操作已成功完成，也可能会返回此错误。例如，服务器的成功响应可能会延迟足够长的时间以使截止期限过期。

HTTP 映射：504 Gateway Timeout
NOT_FOUND

找不到所请求的部分实体（例如，文件或目录）。

服务器开发者注意：如果要拒绝整个一类用户的请求（例如，功能逐步发布的用户或未正式加入许可名单的用户），则可以使用 NOT_FOUND。如果针对某类用户中的部分用户拒绝请求（例如基于用户的访问权限控制），则必须使用 PERMISSION_DENIED。

HTTP 映射：404 Not Found
ALREADY_EXISTS

客户端试图创建的实体（如文件或目录）已经存在。

HTTP 映射：409 Conflict
PERMISSION_DENIED

调用者无权执行指定的操作。如果遭拒的原因是由于部分资源已用尽，则不得使用 PERMISSION_DENIED（请改用 RESOURCE_EXHAUSTED 来表示此类错误）。如果调用者无法识别，则不得使用 PERMISSION_DENIED（请改用 UNAUTHENTICATED 来表示此类错误）。此错误代码并不意味着请求有效，或者请求的实体存在或满足其他先决条件。

HTTP 映射：403 Forbidden
UNAUTHENTICATED

请求没有相应操作的有效身份验证凭证。

HTTP 映射：401 Unauthorized
RESOURCE_EXHAUSTED

部分资源已用尽，可能是每用户配额不足，也可能是整个文件系统的存储空间已用完。

HTTP 映射：429 Too Many Requests
FAILED_PRECONDITION

操作被拒绝，因为系统未处于执行该操作所需的状态。例如，要删除的目录非空、将 rmdir 操作应用于非目录等等。

服务实施者可根据以下准则来确定是选择 FAILED_PRECONDITION、ABORTED 还是 UNAVAILABLE：(a) 如果客户端只能重试失败的调用，则使用 UNAVAILABLE。(b) 如果客户端应在更高级层执行重试，则使用 ABORTED。例如当客户端指定的“测试并设置”操作失败时，这意味着客户端应重启“读取-修改-写入”序列。(c) 如果客户端不得在系统状态明确修正前执行重试，则使用 FAILED_PRECONDITION。例如，如果因非空目录而导致“rmdir”失败，应返回 FAILED_PRECONDITION，因为客户端只能在目录中的文件删除之后执行重试。

HTTP 映射：400 Bad Request
ABORTED

操作已中止，通常是由于序列程序检查失败或事务中止等并发问题。

请参阅上述准则以确定是选择 FAILED_PRECONDITION、ABORTED 还是 UNAVAILABLE。

HTTP 映射：409 Conflict
OUT_OF_RANGE

尝试执行的操作已超出有效范围。例如，查找或读取操作已超出文件末尾。

与 INVALID_ARGUMENT 不同，此错误指示的问题可以通过改变系统状态得到修复。例如，如果要求的读取操作偏移量不在 [0,2^32-1] 范围内，则 32 位文件系统将会生成 INVALID_ARGUMENT，但如果要求的读取操作偏移量超过当前文件大小，该系统则会生成 OUT_OF_RANGE。

FAILED_PRECONDITION 和 OUT_OF_RANGE 之间有一定的共通之处。我们建议尽量使用 OUT_OF_RANGE（错误更具体一些），这样，循环访问空间的调用者就可以轻松查找 OUT_OF_RANGE 错误以检测完成情况。

HTTP 映射：400 Bad Request
UNIMPLEMENTED

操作在此服务中未实现或不受支持/未启用。

HTTP 映射：501 Not Implemented
INTERNAL

内部错误。这意味着底层系统所期望的一些不变量已损坏。此错误代码保留用于严重错误。

HTTP 映射：500 内部服务器错误
UNAVAILABLE

该服务目前不可用。这很可能是一种暂时情况，可以通过退避重试来纠正。 请注意，重试执行非幂等操作并非总是安全的。

请参阅上述准则以确定是选择 FAILED_PRECONDITION、ABORTED 还是 UNAVAILABLE。

HTTP 映射：503 Service Unavailable
DATA_LOSS

数据丢失或损坏且不可恢复。

HTTP 映射：500 内部服务器错误

UpdatedWidget

对于 selectionInput widget，返回多选菜单的自动补全建议。

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 (SelectionItems)
  }
}
字段
widget

string

更新后的小组件的 ID。该 ID 必须与触发更新请求的 widget 的 ID 一致。
该 widget 已更新，以响应用户操作。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
suggestions

object (SelectionItems)

微件自动补全结果列表
互斥字段结束。

SelectionItems

微件自动补全结果列表。

JSON 表示法 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
字段
items[]

object (SelectionItem)

由 SelectionItem 对象组成的数组。

SlashCommand

Google Chat 中斜杠命令的相关元数据。

JSON 表示法 
{
  "commandId": string
}
字段
commandId

string (int64 format)

斜杠命令的 ID。

MatchedUrl

聊天消息中匹配的网址。Chat 应用可以预览匹配的网址。如需了解详情，请参阅预览链接。

JSON 表示法 
{
  "url": string
}
字段
url

string

仅限输出。匹配的网址。

EmojiReactionSummary

使用特定表情符号回应消息的人数。

JSON 表示法 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
字段
emoji

object (Emoji)

仅限输出。与回应关联的表情符号。
reactionCount

integer

仅限输出。使用关联表情符号的回应总数。

DeletionMetadata

有关已删除邮件的信息。设置 deleteTime 后，系统会删除消息。

JSON 表示法 
{
  "deletionType": enum (DeletionType)
}
字段
deletionType

enum (DeletionType)

指明是谁删除了消息。

DeletionType

谁删除了消息以及删除方式。未来可能会添加更多值。如需详细了解何时可以删除消息，请参阅在 Google Chat 中修改或删除消息。

枚举
DELETION_TYPE_UNSPECIFIED 此值未使用。
CREATOR 用户删除了自己的消息。
SPACE_OWNER 所有者或管理员删除了该消息。
ADMIN Google Workspace 管理员删除了该消息。管理员可以删除聊天室中的任何消息，包括任何聊天室成员或 Chat 应用发送的消息。
APP_MESSAGE_EXPIRY Chat 应用在消息过期后自行删除了该消息。
CREATOR_VIA_APP Chat 应用代表创建者（使用用户身份验证）删除了消息。
SPACE_OWNER_VIA_APP Chat 应用代表聊天室管理员（使用用户身份验证）删除了消息。
SPACE_MEMBER 聊天室成员删除了该消息。用户可以删除应用发送的消息。

QuotedMessageMetadata

另一条消息引用的消息的相关信息。

更新消息时，您无法添加或替换 quotedMessageMetadata 字段，但可以将其移除。

如需查看用法示例，请参阅引用其他消息。

JSON 表示法 
{
  "name": string,
  "lastUpdateTime": string,
  "quoteType": enum (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
字段
name

string

必需。所引用消息的资源名称。

格式：spaces/{space}/messages/{message}
lastUpdateTime

string (Timestamp format)

必需。创建或上次更新被引用消息时的时间戳。

如果消息经过修改，请使用此字段 lastUpdateTime。如果消息从未被修改过，请使用 createTime。

如果 lastUpdateTime 与所引用消息的最新版本不一致，请求会失败。
quoteType

enum (QuoteType)

可选。指定报价类型。如果未设置，则默认为消息读/写路径中的 REPLY，以实现向后兼容。
quotedMessageSnapshot

object (QuotedMessageSnapshot)

仅限输出。所引用消息内容的快照。
forwardedMetadata

object (ForwardedMetadata)

仅限输出。有关所引用消息的来源聊天室的元数据。仅针对 FORWARD 报价类型填充。

QuoteType

所引用消息的引用类型。

枚举
QUOTE_TYPE_UNSPECIFIED Reserved. 此值未使用。
REPLY

当 quoteType 为 REPLY 时，您可以执行以下操作：

  • 如果您在消息串中回复，则可以引用该消息串中的其他消息。

  • 如果您要创建根消息，则可以引用该聊天室中的其他根消息。
FORWARD

当 quoteType 为 FORWARD 时，您可以引用：

  • 来自其他聊天室的消息。

  • 同一聊天室中不同消息串中的消息回复。

QuotedMessageSnapshot

提供引用或转发时所引用消息内容的快照

JSON 表示法 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
字段
sender

string

仅限输出。所引用消息的作者姓名。为“回复”和“转发”引用类型填充。
text

string

仅限输出。所引用消息的文本内容快照。
formattedText

string

仅限输出。包含引用的消息 text，并添加了标记以支持超链接、自定义表情符号、标记等富文本格式。仅针对 FORWARD 引用类型填充。
annotations[]

object (Annotation)

仅限输出。从引用消息的文本正文中解析出的注释。仅针对 FORWARD 报价类型填充。
attachments[]

object (Attachment)

仅限输出。引用邮件中的附件。这些是所引用消息的附件元数据的副本。仅针对 FORWARD 报价类型填充。

ForwardedMetadata

有关消息转发来源聊天室的元数据。

JSON 表示法 
{
  "space": string,
  "spaceDisplayName": string
}
字段
space

string

仅限输出。来源空间的资源名称。格式：spaces/{space}
spaceDisplayName

string

仅限输出。转发时来源聊天室或私信的显示名称。对于 SPACE，这是聊天室名称。对于 DIRECT_MESSAGE，这是另一位参与者的姓名（例如“用户 A”）。对于GROUP_CHAT，这是根据成员的名字生成的名称，最多包含 5 个名字（包括创建者，例如“用户 A、用户 B”）。

AttachedGif

由网址指定的 GIF 图片。

JSON 表示法 
{
  "uri": string
}
字段
uri

string

仅限输出。托管 GIF 图片的网址。

AccessoryWidget

显示在消息底部的一个或多个互动式 widget。如需了解详情，请参阅在邮件底部添加互动式 widget。

JSON 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "buttonList": {
    object (ButtonList)
  }
}
字段
操作的类型。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
buttonList

object (ButtonList)

按钮列表。
互斥字段结束。

元素

元素是可能与创建消息时提供的消息文本相关联，也可能不相关联的其他组件。

JSON 表示法 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ]
}
字段
citedSources[]

object (CitedSource)

要在消息下方显示为页脚链接的来源列表。这些内容不会以内嵌方式引用。对于内嵌引用，请使用 citations。
citations[]

object (Citation)

消息文本中引用的内嵌引用列表（通过 <chat-citation> 标记），这些引用会呈现为交互式悬停卡片。

CitedSource

对信息来源的引用。

JSON 表示法 
{
  "title": string,
  "uri": string,
  "snippet": {
    object (Snippet)
  },
  "footer": {
    object (Footer)
  }
}
字段
title

string

必需。CitedSource 的纯文本标题。此字段不支持格式设置。
uri

string

必需。指向此 CitedSource 引用的资源的 URI。
snippet

object (Snippet)

可选。包含直接来自来源的信息的摘要。
footer

object (Footer)

可选。以页脚形式与摘要一起显示的额外信息。

Snippet

一个代码段对象，表示较大语料库中的选段。

JSON 表示法 
{
  "text": string,
  "imagePreview": {
    object (ElementsImage)
  }
}
字段
text

string

可选。直接来自语料库的简短纯文本摘录，可能会在 Chat 中呈现。不支持 Markdown 格式。
imagePreview

object (ElementsImage)

可选。创建引用时作为输入提供的摘要的图片预览。

ElementsImage

一个封装了不同图片表示方式的对象。目前支持的表示形式：- 从 URI 提取的图片。未来可能会支持其他表示形式。

JSON 表示法 
{

  "imageUri": string
}
字段
必需。一种受支持的图片表示形式。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
imageUri

string

必需。可公开访问的图片 URI。
互斥字段结束。

来源的页脚，用于注明出处。

JSON 表示法 
{
  "text": string
}
字段
text

string

可选。要在页脚中显示的文本。

引用

引用是内嵌参考，可为用户提供有关内嵌参考的更详细信息。消息文本中应包含相应的内嵌引用，并采用 <chat-citation data-id="{id}">{text}</chat-citation> 标记格式。仅当消息的 markupSyntax 设置为 MARKDOWN 时，才支持引用。

Elements.citations 中未引用的引用（即在消息文本中没有匹配的 <chat-citation> 标记）会被忽略，不会导致消息被拒绝。

JSON 表示法 
{
  "id": string,
  "citedSources": [
    {
      object (CitedSource)
    }
  ]
}
字段
id

string

必需。应用定义的 ID。只能包含 ASCII 字母和数字，且长度少于 63 个字符。
citedSources[]

object (CitedSource)

可选。与引用相关的来源列表。来源会显示在引用悬停卡片中。

MarkupSyntax

指定用于设置聊天消息文本格式的标记语法。适用于 Message 资源的 text 字段。

枚举
MARKUP_SYNTAX_UNSPECIFIED 表示未指定的值。
MARKUP_SYNTAX_CHAT 使用 Google Chat 的标记语法。如需了解详情，请参阅 https://developers.google.com/workspace/chat/format-messages#format-texts。
MARKUP_SYNTAX_MARKDOWN 使用 Markdown 语法。此语法基于 CommonMark 规范，并包含其他扩展。如需了解详情，请参阅 https://developers.google.com/workspace/chat/format-messages#format-texts。

方法

create

 在 Google Chat 聊天室中创建消息。

delete

 删除消息。

get

 返回有关消息的详细信息。

list

 列出调用方所属聊天室中的消息，包括来自已屏蔽成员和聊天室的消息。

patch

 更新消息。

replaceCards

 替换消息中包含的卡片。
在 Google Chat 中搜索调用用户有权访问的消息。

update

 更新消息。