- 资源:Message
- JSON 表示法
- 卡片
- CardHeader
- ImageStyle
- 版块
- 微件标记WidgetMarkup
- TextParagraph
- 图片
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- Icon
- 按钮
- TextButton
- ImageButton
- CardAction
- CardWithId
- 卡片
- CardHeader
- ImageType
- 版块
- widget
- TextParagraph
- 图片
- OnClick
- 操作
- ActionParameter
- LoadIndicator
- 交互
- OpenLink
- OpenAs
- OnClose
- DecoratedText
- 图标
- MaterialIcon
- 按钮
- 颜色
- SwitchControl
- ControlType
- ButtonList
- TextInput
- 类型
- 建议
- SuggestionItem
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- 分隔线
- 网格
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- 列
- 列
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- widget
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- 注解
- AnnotationType
- UserMentionMetadata
- 类型
- SlashCommandMetadata
- 类型
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- 线程
- ActionResponse
- ResponseType
- DialogAction
- 对话框
- ActionStatus
- 代码
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif
- AccessoryWidget
- 方法
资源:消息
Google Chat 聊天室中的消息。
JSON 表示法 |
---|
{ "name": string, "sender": { object ( |
字段 | |
---|---|
name |
消息的资源名称。 格式: 其中, 如果您在创建消息时设置了自定义 ID,则可以使用此 ID 在请求中指定消息,只需将 |
sender |
仅限输出。创建消息的用户。如果您的 Chat 应用以用户的身份进行身份验证,输出结果会填充用户 |
createTime |
可选。不可变。对于在 Chat 中创建的聊天室,显示消息的创建时间。此字段仅输出,但在“导入模式聊天室”中使用时除外。 对于导入模式聊天室,请将此字段设为来源中消息创建时间的历史时间戳,以保留原始创建时间。 |
lastUpdateTime |
仅限输出。用户上次编辑消息的时间。如果消息从未编辑过,则此字段为空。 |
deleteTime |
仅限输出。消息在 Google Chat 中删除的时间。如果消息永远不会被删除,则此字段为空。 |
text |
邮件的纯文本正文。指向图片、视频或网页的第一个链接会生成预览条状标签。您还可以用“@”提及某位 Google Chat 用户或聊天室中的所有人。 要了解如何创建短信,请参阅发送短信。 |
formattedText |
仅限输出。包含消息
有关详情,请参阅查看邮件中发送的文本格式 |
cards[] |
已废弃:请改用 内容丰富的互动卡片,可用于显示各种界面元素,例如设置了格式的文本、按钮和可点击的图片。卡片通常显示在邮件纯文本正文下方。 |
cardsV2[] |
一个 cards 数组。 只有 Chat 应用可以创建卡片。如果您的 Chat 应用以用户的身份进行身份验证,则消息不能包含卡片。 如需了解卡片及其创建方法,请参阅发送卡片消息。 使用卡片制作工具设计和预览卡片。 打开卡片制作工具 |
annotations[] |
仅限输出。与此消息中的 |
thread |
消息所属的会话。如需查看用法示例,请参阅发起或回复消息串。 |
space |
如果您的 Chat 应用以用户的身份进行身份验证,输出结果会填充聊天室 |
fallbackText |
消息卡片的纯文本说明,在无法显示实际卡片(例如移动设备通知)时使用。 |
actionResponse |
仅限输入。Chat 应用可以用来配置回复发布方式的参数。 |
argumentText |
仅限输出。消息的纯文本正文,其中所有提及 Chat 应用的消息均去掉。 |
slashCommand |
仅限输出。斜杠命令信息(如果适用)。 |
attachment[] |
用户上传的附件。 |
matchedUrl |
仅限输出。 |
threadReply |
仅限输出。如果为 如果聊天室不支持在消息串中回复,则此字段始终为“ |
clientAssignedMessageId |
可选。消息的自定义 ID。您可以使用字段来识别消息,或者获取、删除或更新消息。如需设置自定义 ID,请在创建消息时指定 |
emojiReactionSummaries[] |
仅限输出。消息中的表情符号回应摘要列表。 |
privateMessageViewer |
不可变。用于创建消息的输入,否则仅输出。可以查看消息的用户。设置完成后,消息不会公开,只有指定用户和 Chat 应用才能查看。私信不支持链接预览和附件。 只有 Chat 应用可以发送私信。如果您的 Chat 应用通过用户身份验证才能发送消息,则消息不得设为不公开,必须省略此字段。 有关详情,请参阅向 Google Chat 用户发送私信。 |
deletionMetadata |
仅限输出。关于已删除消息的信息。设置 |
quotedMessageMetadata |
仅限输出。Google Chat 用户在聊天室中引用的消息的相关信息。Google Chat 用户可以引用消息进行回复。 |
attachedGifs[] |
仅限输出。邮件中附加的 GIF 图片。 |
accessoryWidgets[] |
显示在邮件底部的一个或多个互动微件。您可以向包含文字和/或卡片的信息添加配件微件。不支持包含对话框的消息。有关详情,请参阅在邮件底部添加互动式微件。 如果使用配件 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 开始,含 0)。 |
联合字段 metadata 。关于注解的其他元数据。metadata 只能是下列其中一项: |
|
userMention |
用户提及的元数据。 |
slashCommand |
斜杠命令的元数据。 |
richLinkMetadata |
富媒体链接的元数据。 |
AnnotationType
注释的类型。
枚举 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
枚举的默认值。请勿使用。 |
USER_MENTION |
提及一位用户。 |
SLASH_COMMAND |
系统将调用斜杠命令。 |
RICH_LINK |
富链接注释。 |
UserMentionMetadata
用户提及 (@) 的注解元数据。
JSON 表示法 |
---|
{ "user": { object ( |
字段 | |
---|---|
user |
用户提到过。 |
type |
用户提及的类型。 |
类型
枚举 | |
---|---|
TYPE_UNSPECIFIED |
枚举的默认值。请勿使用。 |
ADD |
将用户添加到聊天室。 |
MENTION |
在聊天室中提及用户。 |
SlashCommandMetadata
斜杠命令 (/) 的注解元数据。
JSON 表示法 |
---|
{ "bot": { object ( |
字段 | |
---|---|
bot |
调用了命令的 Chat 应用。 |
type |
斜杠命令的类型。 |
commandName |
调用的斜杠命令的名称。 |
commandId |
调用的斜杠命令的 ID。 |
triggersDialog |
指示斜杠命令是否用于对话框。 |
类型
枚举 | |
---|---|
TYPE_UNSPECIFIED |
枚举的默认值。请勿使用。 |
ADD |
将 Chat 应用添加到聊天室。 |
INVOKE |
在空格中调用斜杠命令。 |
RichLinkMetadata
指向资源的丰富链接。
JSON 表示法 |
---|
{ "uri": string, "richLinkType": enum ( |
字段 | |
---|---|
uri |
此链接的 URI。 |
richLinkType |
富媒体链接类型。 |
联合字段 data 。关联资源的数据。data 只能是下列其中一项: |
|
driveLinkData |
云端硬盘链接的数据。 |
RichLinkType
富媒体链接类型。未来我们可能会添加更多类型。
枚举 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
枚举的默认值。请勿使用。 |
DRIVE_FILE |
一种 Google 云端硬盘富媒体链接类型。 |
DriveLinkData
Google 云端硬盘关联的数据。
JSON 表示法 |
---|
{
"driveDataRef": {
object ( |
字段 | |
---|---|
driveDataRef |
一个 DriveDataRef,引用 Google 云端硬盘文件。 |
mimeType |
关联的 Google 云端硬盘资源的 MIME 类型。 |
会话
Google Chat 聊天室中的消息串。如需查看用法示例,请参阅发起或回复消息串。
如果您在创建邮件时指定了会话串,则可以设置 messageReplyOption
字段,以确定在找不到匹配的会话串时如何操作。
JSON 表示法 |
---|
{ "name": string, "threadKey": string } |
字段 | |
---|---|
name |
仅限输出。线程的资源名称。 示例: |
threadKey |
可选。用于创建或更新线程的输入。否则,将仅输出。线程的 ID。最多支持 4000 个字符。 此 ID 是设置此 ID 的 Chat 应用的唯一 ID。例如,如果多个 Chat 应用使用相同的会话键创建了一条消息,那么这些消息会发布到不同的会话中。如需在人员或其他 Chat 应用创建的会话中回复,请改为指定会话 |
ActionResponse
Chat 应用可以用来配置回复发布方式的参数。
JSON 表示法 |
---|
{ "type": enum ( |
字段 | |
---|---|
type |
仅限输入。Chat 应用响应的类型。 |
url |
仅限输入。供用户进行身份验证或配置的网址。(仅适用于 |
dialogAction |
仅限输入。对与对话框相关的互动事件的响应。须随 |
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 |
仅限输入。调用或提交对话框的请求的状态。根据需要向用户显示状态和消息。例如,在出现错误或成功时。 |
联合字段 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
更新后的 widget 的响应。用于为 widget 提供自动补全选项。
JSON 表示法 |
---|
{ "widget": string, // Union field |
字段 | |
---|---|
widget |
更新后的 widget 的 ID。此 ID 必须与触发更新请求的微件的 ID 一致。 |
联合字段 updated_widget 。该微件会根据用户操作而更新。updated_widget 只能是下列其中一项: |
|
suggestions |
微件自动补全结果列表 |
SelectionItems
微件自动补全结果列表。
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
谁删除了消息以及删除方式。
枚举 | |
---|---|
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 |
仅限输出。引用的消息的资源名称。 格式: |
lastUpdateTime |
仅限输出。引用消息的创建或上次更新时间的时间戳。 |
AttachedGif
通过网址指定的 GIF 图片。
JSON 表示法 |
---|
{ "uri": string } |
字段 | |
---|---|
uri |
仅限输出。托管 GIF 图片的网址。 |
AccessoryWidget
显示在邮件底部的一个或多个互动微件。有关详情,请参阅在邮件底部添加互动式微件。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 action 。操作的类型。action 只能是下列其中一项: |
|
buttonList |
按钮列表。 |
方法 |
|
---|---|
|
在 Google Chat 聊天室中创建消息。 |
|
删除消息。 |
|
返回有关消息的详细信息。 |
|
列出来电者所属的聊天室中的消息,包括已屏蔽成员和聊天室的消息。 |
|
更新消息。 |
|
更新消息。 |