REST Resource: spaces.messages

资源：消息

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,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ]
}
字段
name

string

资源名称，格式为 spaces/*/messages/*。

示例：spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB
sender

object (User)

仅供输出。创建消息的用户。如果您的 Chat 应用以用户身份进行身份验证，输出内容会填充用户 name 和 type。
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>。
  • 使用 :{emoji_name}: 格式的自定义表情符号，例如 :smile:。这不适用于 Unicode 表情符号，例如使用 U+1F600 表示笑脸表情符号。

有关详情，请参阅查看邮件中发送的文本格式
cards[]
(deprecated)

object (Card)

已弃用：请改用 cardsV2。

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

object (CardWithId)

一个卡片数组。

只有聊天应用才能创建卡片。如果您的 Chat 应用以用户身份通过身份验证，则消息不能包含卡片。

如需了解卡片以及如何创建卡片，请参阅使用卡片设计动态、互动且一致的界面。
annotations[]

object (Annotation)

仅供输出。与此消息中的 text 关联的注解。
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)

仅供输出。spaces.messages.text 中与链接预览格式匹配的网址。如需了解详情，请参阅预览链接。
threadReply

boolean

仅供输出。如果为 true，则消息是回复会话中的回复。若设为 false，相应消息会以话题中的第一条消息或没有话题式回复的消息的形式显示在聊天室的顶级对话中。

如果聊天室不支持在话题中回复，则此字段始终为“false”。
clientAssignedMessageId

string

在创建 Chat 消息时分配的自定义名称。必须以 client- 开头，并且只能包含小写字母、数字和连字符，长度不得超过 63 个字符。指定此字段可获取、更新或删除具有指定值的消息。指定自定义名称后，Chat 应用就可以召回消息，而不会保存创建消息时返回响应正文中的消息 name。分配自定义名称不会替换生成的 name 字段，而是消息的资源名称。相反，它会将自定义名称设置为 clientAssignedMessageId 字段，您可以在处理后续操作（例如更新或删除消息）时引用该字段。如需查看用法示例，请参阅为已创建的消息命名。
emojiReactionSummaries[]

object (EmojiReactionSummary)

仅供输出。消息中的表情符号回应摘要列表。
deletionMetadata

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

仅供输出。Google Chat 用户在聊天室中引用的消息的相关信息。Google Chat 用户可以引用消息进行回复。
attachedGifs[]

object (AttachedGif)

仅供输出。邮件中附加的 GIF 图片。

包含 ID 的银行卡

Google Chat 消息中的卡片。

只有聊天应用才能创建卡片。如果您的 Chat 应用以用户身份通过身份验证，则消息不能包含卡片。

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

string

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

object (Card)

卡片。大小上限为 32 KB。

注解

仅供输出。与邮件的纯文本正文相关联的注释。要为短信添加基本格式，请参阅设置短信格式。

纯文本邮件正文示例：

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,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  }
  // End of list of possible types for union field metadata.
}
字段
type

enum (AnnotationType)

此注释的类型。
length

integer

此注释对应的纯文本消息正文中子字符串的长度。
startIndex

integer

此注释对应的纯文本邮件正文中的起始索引（从 0 开始，含 0）。
联合字段 metadata。关于注解的其他元数据。metadata 只能是下列其中一项：
userMention

object (UserMentionMetadata)

用户提及的元数据。
slashCommand

object (SlashCommandMetadata)

斜杠命令的元数据。

AnnotationType

注释的类型。

枚举
ANNOTATION_TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
USER_MENTION 提及一名用户。
SLASH_COMMAND 系统会调用斜杠命令。

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 在空格中调用斜杠命令。

会话

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

enum (ResponseType)

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

string

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

object (DialogAction)

仅限输入。对与对话框相关的事件的响应。必须附有 ResponseType.Dialog。

响应类型

Chat 应用响应的类型。

枚举
TYPE_UNSPECIFIED 作为 NEW_MESSAGE 处理的默认类型。
NEW_MESSAGE 作为新消息在主题中发布。
UPDATE_MESSAGE 更新 Chat 应用的消息。只有在消息发送者类型为 BOT 的 CARD_CLICKED 事件中允许执行此操作。
UPDATE_USER_MESSAGE_CARDS 更新用户信息中的卡片。只能用于响应具有匹配网址的 MESSAGE 事件或消息发送者类型为 HUMAN 的 CARD_CLICKED 事件。文本会被忽略。
REQUEST_CONFIG 私下请求用户进行其他身份验证或配置。
DIALOG 显示对话框。

对话框操作

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

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.
}
字段
actionStatus

object (ActionStatus)

仅限输入。调用或提交对话框的请求的状态。根据需要向用户显示状态和消息。例如，在出现错误或成功时。

联合字段 action。

action 只能是下列其中一项：
dialog

object (Dialog)

仅限输入。Dialog。

对话框

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

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

object (Card)

仅限输入。对话框的正文，以模态形式渲染。Google Chat 应用不支持以下卡片实体：DateTimePicker、OnChangeAction。

操作状态

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

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 Internal Server Error
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 Internal Server Error
UNAVAILABLE

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

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

HTTP 映射：503 Service Unavailable
DATA_LOSS

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

HTTP 映射：500 Internal Server Error

SlashCommand

Google Chat 中的斜杠命令。

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

string (int64 format)

调用的斜杠命令的 ID。

匹配的网址

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

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

string

仅供输出。匹配的网址。

表情符号回应摘要

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

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

object (Emoji)

与回应相关联的表情符号。
reactionCount

integer

使用关联表情符号的回应总数。

删除元数据

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

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

enum (DeletionType)

表示谁删除了消息。

删除类型

消息删除者和删除方式。

枚举
DELETION_TYPE_UNSPECIFIED 此值未使用。
CREATOR 用户删除了自己的消息。
SPACE_OWNER 聊天室所有者删除了该消息。
ADMIN Google Workspace 管理员已删除此消息。
APP_MESSAGE_EXPIRY Chat 应用在自己的消息过期后删除了自己的消息。
CREATOR_VIA_APP Chat 应用代表用户删除了消息。
SPACE_OWNER_VIA_APP 某 Chat 应用代表聊天室所有者删除了消息。

QuotedMessageMetadata

引用的消息的相关信息。

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

string

仅供输出。引用的消息的资源名称。

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

string (Timestamp format)

仅供输出。创建引用的消息或引用消息的上次更新时间的时间戳。

附加的 GIF

通过网址指定的 GIF 图片。

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

string

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

方法

create

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

delete

 删除消息。

get

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

list

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

patch

 更新消息。

update

 更新消息。