- 资源:Message
- JSON 表示法
- 卡片
- CardHeader
- ImageStyle
- 部分
- WidgetMarkup
- TextParagraph
- Image
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- Icon
- 按钮
- TextButton
- ImageButton
- CardAction
- CardWithId
- 卡片
- CardHeader
- ImageType
- 部分
- 微件
- TextParagraph
- TextSyntax
- Image
- OnClick
- 操作
- ActionParameter
- LoadIndicator
- 交互
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- 图标
- MaterialIcon
- DecoratedText
- VerticalAlignment
- 按钮
- 颜色
- 类型
- SwitchControl
- ControlType
- ButtonList
- TextInput
- 类型
- 建议
- SuggestionItem
- 验证
- InputType
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- 分隔线
- 网格
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- 列
- 列
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- 微件
- ChipList
- 布局
- 条状标签
- 轮播界面
- CarouselCard
- NestedWidget
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- 注释
- AnnotationType
- UserMentionMetadata
- 类型
- SlashCommandMetadata
- 类型
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- CustomEmojiMetadata
- 线程
- ActionResponse
- ResponseType
- DialogAction
- 对话
- ActionStatus
- 代码
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif
- AccessoryWidget
- 方法
资源:Message
Google Chat 聊天室中的消息。
JSON 表示法 |
---|
{ "name": string, "sender": { object ( |
字段 | |
---|---|
name |
标识符。消息的资源名称。 格式: 其中, 如果您在创建消息时设置了自定义 ID,则可以使用此 ID 在请求中指定消息,方法是将 |
sender |
仅限输出。创建消息的用户。如果您的 Chat 应用以用户身份进行身份验证,则输出会填充 user |
createTime |
可选。不可变。对于在 Chat 中创建的聊天室,消息的创建时间。此字段仅限输出,除非在导入模式空间中使用。 对于导入模式空间,请将此字段设置为消息在源中创建时的历史时间戳,以便保留原始创建时间。 |
lastUpdateTime |
仅限输出。用户上次修改消息的时间。如果消息从未经过修改,则此字段为空。 |
deleteTime |
仅限输出。相应消息在 Google Chat 中被删除的时间。如果消息永远不会被删除,则此字段为空。 |
text |
可选。邮件的纯文本正文。第一个指向图片、视频或网页的链接会生成预览条状标签。您还可以@提及 Google Chat 用户或聊天室中的所有人。 如需了解如何创建短信,请参阅发送消息。 |
formattedText |
仅限输出。包含添加了标记以传达格式设置的
如需了解详情,请参阅查看消息中发送的文本格式 |
cards[] |
已弃用:请改用 丰富、格式化且可互动的卡片,可用于显示界面元素,例如:格式化文本、按钮和可点击的图片。卡片通常显示在消息的纯文本正文下方。 |
cardsV2[] |
可选。卡片数组。 只有 Chat 应用可以创建卡片。如果您的 Chat 应用以用户身份进行身份验证,则消息不能包含卡片。 如需了解如何创建包含卡片的邮件,请参阅发送邮件。 使用卡片构建器设计和预览卡片。 打开卡片构建器 |
annotations[] |
仅限输出。与此消息中的 |
thread |
相应消息所属的对话串。如需查看使用示例,请参阅发起或回复消息串。 |
space |
仅限输出。如果 Chat 应用以用户身份进行身份验证,则输出仅填充 space |
fallbackText |
可选。消息卡片的纯文本说明,在无法显示实际卡片时使用,例如移动通知。 |
actionResponse |
仅限输入。Chat 应用可用于配置其响应发布方式的参数。 |
argumentText |
仅限输出。消息的纯文本正文,其中已去除所有 Chat 应用提及内容。 |
slashCommand |
仅限输出。斜杠命令信息(如果适用)。 |
attachment[] |
可选。用户上传的附件。 |
matchedUrl |
仅限输出。 |
threadReply |
仅限输出。如果值为 如果聊天室不支持在话题中回复,则此字段始终为 |
clientAssignedMessageId |
可选。消息的自定义 ID。您可以使用字段来标识消息,或获取、删除或更新消息。如需设置自定义 ID,请在创建消息时指定 |
emojiReactionSummaries[] |
仅限输出。消息上的表情符号回应摘要列表。 |
privateMessageViewer |
可选。不可变。用于创建消息的输入,否则仅输出。可以查看消息的用户。如果设置了此字段,相应消息将设为私密,仅对指定用户和 Chat 应用可见。如需在请求中添加此字段,您必须使用应用身份验证来调用 Chat API,并省略以下内容: 如需了解详情,请参阅私下发送消息。 |
deletionMetadata |
仅限输出。有关已删除消息的信息。设置 |
quotedMessageMetadata |
仅限输出。与 Google Chat 用户在聊天室中引用的消息相关的信息。Google Chat 用户可以引用消息来回复。 |
attachedGifs[] |
仅限输出。附加到邮件中的 GIF 图片。 |
accessoryWidgets[] |
可选。显示在邮件底部的一个或多个互动 widget。您可以向包含文字、卡片或同时包含文字和卡片的消息添加辅助 widget。不支持包含对话框的消息。如需了解详情,请参阅在邮件底部添加互动式微件。 创建包含辅助功能 widget 的消息需要进行应用身份验证。 |
CardWithId
Google Chat 消息中的卡片。
只有 Chat 应用可以创建卡片。如果您的 Chat 应用以用户身份进行身份验证,则消息不能包含卡片。
使用卡片构建器设计和预览卡片。
打开卡片构建器JSON 表示法 |
---|
{
"cardId": string,
"card": {
object ( |
字段 | |
---|---|
cardId |
如果消息包含多张卡片,则必须填写。消息中卡片的唯一标识符。 |
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 ( |
字段 | |
---|---|
type |
相应注释的类型。 |
length |
相应注释所对应的纯文本消息正文中的子字符串的长度。 |
startIndex |
相应注释在纯文本消息正文中的起始索引(从 0 开始,含边界值)。 |
联合字段 metadata 。有关注释的其他元数据。metadata 只能是下列其中一项: |
|
userMention |
用户提及的元数据。 |
slashCommand |
斜杠命令的元数据。 |
richLinkMetadata |
富链接的元数据。 |
customEmojiMetadata |
自定义表情符号的元数据。 |
AnnotationType
注释的类型。
枚举 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
枚举的默认值。请勿使用。 |
USER_MENTION |
提及了用户。 |
SLASH_COMMAND |
调用斜杠命令。 |
RICH_LINK |
富链接注释。 |
CUSTOM_EMOJI |
自定义表情符号注释。 |
UserMentionMetadata
用户提及 (@) 的注释元数据。
JSON 表示法 |
---|
{ "user": { object ( |
字段 | |
---|---|
user |
提及的用户。 |
type |
用户提及的类型。 |
类型
枚举 | |
---|---|
TYPE_UNSPECIFIED |
枚举的默认值。请勿使用。 |
ADD |
将用户添加到聊天室。 |
MENTION |
在聊天室中提及用户。 |
SlashCommandMetadata
斜杠命令 (/) 的注释元数据。
JSON 表示法 |
---|
{ "bot": { object ( |
字段 | |
---|---|
bot |
调用了命令的 Chat 应用。 |
type |
斜杠命令的类型。 |
commandName |
所调用斜杠命令的名称。 |
commandId |
所调用斜杠命令的命令 ID。 |
triggersDialog |
指示斜杠命令是否用于对话框。 |
类型
枚举 | |
---|---|
TYPE_UNSPECIFIED |
枚举的默认值。请勿使用。 |
ADD |
将聊天应用添加到聊天室。 |
INVOKE |
在聊天室中调用斜杠命令。 |
RichLinkMetadata
指向资源的富链接。
JSON 表示法 |
---|
{ "uri": string, "richLinkType": enum ( |
字段 | |
---|---|
uri |
相应链接的 URI。 |
richLinkType |
富链接类型。 |
联合字段 data 。关联资源的数据。data 只能是下列其中一项: |
|
driveLinkData |
云端硬盘链接的数据。 |
chatSpaceLinkData |
聊天室链接的数据。 |
RichLinkType
富链接类型。未来可能会添加更多类型。
枚举 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
枚举的默认值。请勿使用。 |
DRIVE_FILE |
Google 云端硬盘富链接类型。 |
CHAT_SPACE |
Chat 聊天室富链接类型。例如,空间智能条状标签。 |
DriveLinkData
Google 云端硬盘链接的数据。
JSON 表示法 |
---|
{
"driveDataRef": {
object ( |
字段 | |
---|---|
driveDataRef |
引用 Google 云端硬盘文件的 DriveDataRef。 |
mimeType |
关联的 Google 云端硬盘资源的 MIME 类型。 |
ChatSpaceLinkData
Chat 聊天室链接的数据。
JSON 表示法 |
---|
{ "space": string, "thread": string, "message": string } |
字段 | |
---|---|
space |
关联的 Chat 聊天室资源的聊天室。 格式: |
thread |
关联的 Chat 聊天室资源的消息串。 格式: |
message |
关联的 Chat 聊天室资源的消息。 格式: |
CustomEmojiMetadata
自定义表情符号的注释元数据。
JSON 表示法 |
---|
{
"customEmoji": {
object ( |
字段 | |
---|---|
customEmoji |
自定义表情符号。 |
会话
Google Chat 聊天室中的消息串。如需查看使用示例,请参阅发起或回复消息串。
如果您在创建消息时指定了线程,则可以设置 messageReplyOption
字段来确定在找不到匹配的线程时会发生什么情况。
JSON 表示法 |
---|
{ "name": string, "threadKey": string } |
字段 | |
---|---|
name |
标识符。线程的资源名称。 示例: |
threadKey |
可选。用于创建或更新线程的输入。否则,仅限输出。线程的 ID。最多支持 4,000 个字符。 此 ID 对于设置它的聊天应用而言是唯一的。例如,如果多个 Chat 应用使用相同的线程键创建消息,则这些消息会发布到不同的线程中。如需在用户或其他 Chat 应用创建的消息串中回复,请改为指定消息串 |
ActionResponse
Chat 应用可用于配置其响应发布方式的参数。
JSON 表示法 |
---|
{ "type": enum ( |
字段 | |
---|---|
type |
仅限输入。聊天应用响应的类型。 |
url |
仅限输入。供用户进行身份验证或配置的网址。(仅适用于 |
dialogAction |
|
updatedWidget |
仅限输入。更新后的 widget 的响应。 |
ResponseType
聊天应用响应的类型。
枚举 | |
---|---|
TYPE_UNSPECIFIED |
作为 NEW_MESSAGE 处理的默认类型。 |
NEW_MESSAGE |
以新消息的形式发布到主题中。 |
UPDATE_MESSAGE |
更新 Chat 应用的消息。仅当 CARD_CLICKED 事件的消息发送者类型为 BOT 时,才允许使用此方法。 |
UPDATE_USER_MESSAGE_CARDS |
更新用户消息中的卡片。只有在以下情况下,才允许使用此方法作为响应:针对具有匹配网址的 MESSAGE 事件,或针对消息发送者类型为 HUMAN 的 CARD_CLICKED 事件。系统会忽略文本。 |
REQUEST_CONFIG |
私下要求用户进行额外的身份验证或配置。 |
DIALOG |
显示一个对话框。 |
UPDATE_WIDGET |
微件文本自动补全选项查询。 |
DialogAction
包含对话框和请求状态代码。
JSON 表示法 |
---|
{ "actionStatus": { object ( |
字段 | |
---|---|
actionStatus |
仅限输入。用于调用或提交对话框的请求的状态。根据需要向用户显示状态和消息。例如,在出现错误或成功时。 |
联合字段 action 。要执行的操作。action 只能是下列其中一项: |
|
dialog |
仅限输入。请求的对话。 |
对话框
对话框的卡片正文周围的封装容器。
JSON 表示法 |
---|
{
"body": {
object ( |
字段 | |
---|---|
body |
仅限输入。对话框的正文,以模态形式呈现。Google Chat 应用不支持以下卡片实体: |
ActionStatus
表示调用或提交对话框的请求的状态。
JSON 表示法 |
---|
{
"statusCode": enum ( |
字段 | |
---|---|
statusCode |
状态代码。 |
userFacingMessage |
要向用户发送的有关其请求状态的消息。如果未设置,则发送基于 |
代码
gRPC API 的规范错误代码。
有时可能有多个错误代码都适用。服务应返回适用且最具体的错误代码。例如,如果 OUT_OF_RANGE
和 FAILED_PRECONDITION
两个代码都适用,则前者优先于后者。同样,NOT_FOUND
或 ALREADY_EXISTS
优先于 FAILED_PRECONDITION
。
枚举 | |
---|---|
OK |
不是错误信息;成功时返回此项。 HTTP 映射:200 OK |
CANCELLED |
操作已取消(通常是被调用者取消)。 HTTP 映射:499 Client Closed Request |
UNKNOWN |
未知错误。例如,当从另一个地址空间接收到的 HTTP 映射:500 Internal Server Error |
INVALID_ARGUMENT |
客户端指定的参数无效。请注意,这与 HTTP 映射:400 Bad Request |
DEADLINE_EXCEEDED |
在操作完成之前截止期限已过。对于更改系统状态的操作,即使操作已成功完成,也可能会返回此错误。例如,服务器的成功响应可能会延迟足够长的时间以使截止期限过期。 HTTP 映射:504 Gateway Timeout |
NOT_FOUND |
找不到所请求的部分实体(例如,文件或目录)。 服务器开发者注意:如果要拒绝整个一类用户的请求(例如,功能逐步发布的用户或未正式加入许可名单的用户),则可以使用 HTTP 映射:404 Not Found |
ALREADY_EXISTS |
客户端试图创建的实体(如文件或目录)已经存在。 HTTP 映射:409 Conflict |
PERMISSION_DENIED |
调用者无权执行指定的操作。如果遭拒的原因是由于部分资源已用尽,则不得使用 HTTP 映射:403 Forbidden |
UNAUTHENTICATED |
请求没有相应操作的有效身份验证凭据。 HTTP 映射:401 Unauthorized |
RESOURCE_EXHAUSTED |
部分资源已用尽,可能是每用户配额不足,也可能是整个文件系统的存储空间已用完。 HTTP 映射:429 Too Many Requests |
FAILED_PRECONDITION |
操作被拒绝,因为系统未处于执行该操作所需的状态。例如,要删除的目录非空、将 rmdir 操作应用于非目录等等。 服务实施者可根据以下准则来确定是选择 HTTP 映射:400 Bad Request |
ABORTED |
操作已中止,通常是由于序列程序检查失败或事务中止等并发问题。 请参阅上述准则以确定是选择 HTTP 映射:409 Conflict |
OUT_OF_RANGE |
尝试执行的操作已超出有效范围。例如,查找或读取操作已超出文件末尾。 与
HTTP 映射:400 Bad Request |
UNIMPLEMENTED |
操作在此服务中未实现或不受支持/未启用。 HTTP 映射:501 Not Implemented |
INTERNAL |
内部错误。这意味着底层系统所期望的一些不变量已损坏。此错误代码保留用于严重错误。 HTTP 映射:500 Internal Server Error |
UNAVAILABLE |
该服务目前不可用。这很可能是一种暂时情况,可以通过退避重试来纠正。 请注意,重试执行非幂等操作并非总是安全的。 请参阅上述准则以确定是选择 HTTP 映射:503 Service Unavailable |
DATA_LOSS |
数据丢失或损坏且不可恢复。 HTTP 映射:500 Internal Server Error |
UpdatedWidget
对于 selectionInput
widget,返回多选菜单的自动补全建议。
JSON 表示法 |
---|
{ "widget": string, // Union field |
字段 | |
---|---|
widget |
更新后的 widget 的 ID。该 ID 必须与触发更新请求的 widget 的 ID 一致。 |
联合字段 updated_widget 。widget 会根据用户操作进行更新。updated_widget 只能是下列其中一项: |
|
suggestions |
widget 自动补全结果列表 |
SelectionItems
widget 自动补全结果的列表。
JSON 表示法 |
---|
{
"items": [
{
object ( |
字段 | |
---|---|
items[] |
SelectionItem 对象的数组。 |
SlashCommand
Google Chat 中有关斜杠命令的元数据。
JSON 表示法 |
---|
{ "commandId": string } |
字段 | |
---|---|
commandId |
斜杠命令的 ID。 |
MatchedUrl
Chat 消息中匹配的网址。聊天应用可以预览匹配的网址。如需了解详情,请参阅预览链接。
JSON 表示法 |
---|
{ "url": string } |
字段 | |
---|---|
url |
仅限输出。匹配的网址。 |
EmojiReactionSummary
使用特定表情符号回应消息的人数。
JSON 表示法 |
---|
{
"emoji": {
object ( |
字段 | |
---|---|
emoji |
仅限输出。与回应关联的表情符号。 |
reactionCount |
仅限输出。使用关联表情符号回应的总次数。 |
DeletionMetadata
有关已删除消息的信息。设置 deleteTime
后,系统会删除消息。
JSON 表示法 |
---|
{
"deletionType": enum ( |
字段 | |
---|---|
deletionType |
指明是谁删除了消息。 |
DeletionType
谁删除了消息以及消息是如何被删除的。将来可能会添加更多值。如需详细了解何时可以删除消息,请参阅在 Google Chat 中修改或删除消息。
枚举 | |
---|---|
DELETION_TYPE_UNSPECIFIED |
此值未使用。 |
CREATOR |
用户删除了自己的消息。 |
SPACE_OWNER |
聊天室管理员删除了相应消息。 |
ADMIN |
Google Workspace 管理员已删除相应消息。管理员可以删除聊天室中的任何消息,包括任何聊天室成员或 Chat 应用发送的消息。 |
APP_MESSAGE_EXPIRY |
Chat 应用在过期时删除了自己的消息。 |
CREATOR_VIA_APP |
聊天应用代表创建者(使用用户身份验证)删除了消息。 |
SPACE_OWNER_VIA_APP |
Chat 应用代表聊天室管理员(使用用户身份验证)删除了消息。 |
SPACE_MEMBER |
聊天室的某位成员删除了相应消息。用户可以删除应用发送的消息。 |
QuotedMessageMetadata
有关引用消息的信息。
JSON 表示法 |
---|
{ "name": string, "lastUpdateTime": string } |
字段 | |
---|---|
name |
仅限输出。引用消息的资源名称。 格式: |
lastUpdateTime |
仅限输出。引用消息的创建时间或上次更新时间的时间戳。 |
AttachedGif
由网址指定的 GIF 图像。
JSON 表示法 |
---|
{ "uri": string } |
字段 | |
---|---|
uri |
仅限输出。托管 GIF 图片的网址。 |
AccessoryWidget
显示在邮件底部的一个或多个互动 widget。如需了解详情,请参阅在邮件底部添加互动式微件。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 action 。操作的类型。action 只能是下列其中一项: |
|
buttonList |
按钮列表。 |
方法 |
|
---|---|
|
在 Google Chat 聊天室中创建消息。 |
|
删除消息。 |
|
返回有关消息的详细信息。 |
|
列出调用者所属聊天室中的消息,包括来自被屏蔽的成员和聊天室的消息。 |
|
更新消息。 |
|
更新消息。 |