- EventObject
- CommonEventObject
- HostApp
- 平台
- TimeZone
- 输入
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- 组织者
- 参加者
- ConferenceData
- ConferenceSolution
- 密钥
- EntryPoint
- 参数
- AddOnParameters
- 功能
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- 条状标签
- 图标
- StyledText
- 样式
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
EventObject
Google 插件互动事件,其中包含用户与宿主应用中的插件互动的数据。
当用户在宿主应用中与插件互动时,事件对象会以 JSON 格式传递给插件的回调函数或触发器(对于 Apps 脚本),或 https 端点(对于 HTTP)。事件对象会存储由每个宿主应用定义的宿主应用事件对象,以及包含一些与事件相关的通用字段的通用事件对象。
如需了解详情,请参阅事件对象。
| JSON 表示法 |
|---|
{ "commonEventObject": { object ( |
| 字段 | |
|---|---|
commonEventObject |
一个包含所有事件对象通用信息的对象,无论托管应用是什么。 |
authorizationEventObject |
仅针对向 HTTP 端点发出的请求设置 |
| 以下是互斥字段的列表。在响应中,最多只能设置其中一个字段: | |
calendar |
仅当调用主机为 Google 日历时才会显示。一个包含日历和活动信息的对象。 |
drive |
仅当调用主机为 Google 云端硬盘时才会显示。一个包含云端硬盘信息的对象。 |
gmail |
仅当调用主机为 Gmail 时才会显示。一个包含 Gmail 信息的对象。 |
sheets |
仅当调用主机为 Google 表格时才会显示。一个包含 Google 表格信息的对象。 |
slides |
仅当调用主机为 Google 幻灯片时才会显示。一个包含幻灯片信息的对象。 |
docs |
仅当调用主机为 Google 文档时才会显示。一个包含 Google 文档信息的对象。 |
chat |
仅在调用主机为 Google Chat 时才会显示。一个包含 Chat 信息。 |
workflow |
仅在调用主机为 Google Workspace Studio 时显示。一个包含工作流信息的对象。 |
| 互斥字段结束。 | |
CommonEventObject
通用事件对象是整个事件对象的一部分,用于将不依赖于宿主的一般信息从用户客户端传递到插件。这些信息包括用户的语言区域、宿主应用和平台等详细信息。
除了首页和上下文触发器之外,当用户与 widget 互动时,插件还会构建事件对象并将其传递给操作回调函数。插件的回调函数可以查询通用事件对象,以确定用户客户端中打开的 widget 的内容。例如,您的插件可以在 eventObject.commentEventObject.formInputs 对象中找到用户在 TextInput widget 中输入的文本。
对于 Chat 应用,指用户在与微件互动时调用的函数的名称。
| JSON 表示法 |
|---|
{ "userLocale": string, "hostApp": enum ( |
| 字段 | |
|---|---|
userLocale |
默认处于停用状态。用户的语言和国家/地区标识符,格式为 ISO 639 语言代码-ISO 3166 国家/地区代码。例如 如需启用此字段,您必须在插件清单中将 |
hostApp |
指明生成事件对象时插件在哪个宿主应用中处于活跃状态。可能的值包括下列项:
|
platform |
平台枚举,用于指示事件源自哪个平台( |
timeZone |
默认处于停用状态。时区 ID 以及相对于世界协调时间 (UTC) 的偏移量。如需启用此字段,您必须在插件清单中将 仅支持事件类型 |
formInputs |
一个映射,其中包含所显示卡片中微件的当前值。映射键是分配给每个输入 widget(例如 映射值对象的结构取决于 widget 类型: 注意:以下示例已针对 Apps 脚本的 V8 运行时进行了格式设置。如果您使用的是 Rhino 运行时,则必须在值后面添加
示例:对于
示例:对于
示例:对于
示例:对于
示例:对于 包含一系列 |
parameters |
您使用 开发者预览版:对于扩展 Google Chat 的插件,如需根据用户在多选菜单中输入的内容推荐选项,请使用 包含一系列 |
invokedFunction |
要调用的函数的名称。 对于扩展 Google Chat 的 Google Workspace 插件,此字段不会填充。相反,如需接收标识符等函数数据,扩展 Chat 的插件应使用 |
HostApp
Google Workspace 插件或 Google Chat 应用的 Google Workspace 应用。
对于插件,是指启动 Google Workspace 插件的 Workspace 应用。对于 Chat 应用,宿主应用始终为 CHAT。
| 枚举 | |
|---|---|
UNSPECIFIED_HOST_APP |
Google 无法识别宿主应用。 |
GMAIL |
该插件会从 Gmail 启动。 |
CALENDAR |
该插件会从 Google 日历中启动。 |
DRIVE |
该插件从 Google 云端硬盘启动。 |
DEMO |
未使用。 |
DOCS |
该插件会从 Google 文档中启动。 |
MEET |
该插件会从 Google Meet 中启动。 |
SHEETS |
该插件会从 Google 表格中启动。 |
SLIDES |
该插件会从 Google 幻灯片中启动。 |
DRAWINGS |
该插件会从 Google 绘图中启动。 |
CHAT |
Google Chat 应用。 |
平台
标识此调用的来源平台。
| 枚举 | |
|---|---|
UNKNOWN_PLATFORM |
|
WEB |
|
IOS |
|
ANDROID |
|
TimeZone
时区 ID 以及相对于世界协调时间 (UTC) 的偏移量。仅支持事件类型 CARD_CLICKED 和 SUBMIT_DIALOG。
| JSON 表示法 |
|---|
{ "id": string, "offset": integer } |
| 字段 | |
|---|---|
id |
IANA TZ 时区数据库代码,例如“America/Toronto”。 |
offset |
用户时区相对于世界协调时间 (UTC) 的偏移量(以毫秒为单位)。 |
输入
用户可以在卡片或对话框中输入的数据类型。输入类型取决于微件接受的值类型。
| JSON 表示法 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "stringInputs": { object ( |
| 字段 | |
|---|---|
| 以下是互斥字段的列表。在响应中,最多只能设置其中一个字段: | |
stringInputs |
一个字符串列表,表示用户在 widget 中输入的值。 如果该 widget 仅接受一个值(例如 |
dateTimeInput |
来自 |
dateInput |
来自仅接受日期值的 |
timeInput |
来自仅接受时间值的 |
| 互斥字段结束。 | |
StringInputs
常规 widget 的输入参数。对于单值 widget,它是一个单值列表。对于多值微件(例如复选框),系统会显示所有值。
| JSON 表示法 |
|---|
{ "value": [ string ] } |
| 字段 | |
|---|---|
value[] |
用户输入的字符串列表。 |
DateTimeInput
日期和时间输入值。
| JSON 表示法 |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| 字段 | |
|---|---|
msSinceEpoch |
自纪元时间以来的时间(以毫秒为单位)。 |
hasDate |
|
hasTime |
|
DateInput
日期输入值。
| JSON 表示法 |
|---|
{ "msSinceEpoch": string } |
| 字段 | |
|---|---|
msSinceEpoch |
自纪元时间以来的时间(以毫秒为单位)。 |
TimeInput
时间输入值。
| JSON 表示法 |
|---|
{ "hours": integer, "minutes": integer } |
| 字段 | |
|---|---|
hours |
24 小时制的小时。 |
minutes |
整点过后的分钟数。有效值为 0 到 59。 |
AuthorizationEventObject
封装插件请求的授权信息
| JSON 表示法 |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| 字段 | |
|---|---|
userOAuthToken |
最终用户 OAuth 访问令牌,已获得所请求范围的授权。(在 OAuth 权限请求页面拆分后,系统将使用最终用户授权的范围进行授权) |
userIdToken |
最终用户 ID 令牌(如果请求了适当的 ID 范围) |
systemIdToken |
此部署的 G Suite 插件服务账号的 ID 令牌 |
authorizedScopes[] |
用户授权的 OAuth 范围列表。 |
CalendarEventObject
日历事件对象是整个事件对象的一部分,其中包含有关用户日历和日历活动的信息。仅当宿主应用是 Google 日历时,此字段才会出现在事件对象中。
下表列出了事件对象的 calendar 字段中存在的字段。当且仅当日历活动中存在相应数据,并且插件将其 addOns.calendar.currentEventAccess 清单字段设置为 READ 或 READ_WRITE 时,标记为用户生成的数据的字段才会出现在事件对象中。
| JSON 表示法 |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| 字段 | |
|---|---|
id |
事件 ID。 |
recurringEventId |
周期性活动的 ID。 |
calendarId |
日历 ID。 |
organizer |
表示活动组织者的对象。 |
attendees[] |
用户生成的数据。日历活动参加者的列表。 |
conferenceData |
用户生成的数据。一个对象,表示与此活动关联的所有会议数据,例如 Google Meet 会议详细信息。 |
capabilities |
用户生成的数据。一个对象,用于描述插件查看或更新活动信息的功能。 |
组织者
| JSON 表示法 |
|---|
{ "email": string } |
| 字段 | |
|---|---|
email |
活动组织者的邮箱。 |
参加者
Attendee 对象包含 Google 日历活动中各个参加者的信息。当且仅当日历活动中存在数据,并且插件将其 addOns.calendar.currentEventAccess 清单 字段设置为 READ 或 READ_WRITE 时,此信息才会出现在事件对象中。
| JSON 表示法 |
|---|
{ "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } |
| 字段 | |
|---|---|
email |
参加者的邮箱。 |
displayName |
参加者的显示名称。 |
organizer |
如果参加者是此活动的组织者,则为 true。 |
self |
如果此参加者代表显示此活动的日历,则为 true;否则为 false。 |
resource |
如果参加者代表资源(例如会议室或设备),则为 true;否则为 false。 |
optional |
如果此参加者的出席状态标记为可选,则为 true;否则为 false。 |
responseStatus |
参加者的回复状态。可能的值包括下列项:
|
comment |
参加者的回复评论(如果有)。 |
additionalGuests |
参加者表示要携带的额外宾客人数。默认值为 0。 |
ConferenceData
会议数据对象包含与 Google 日历活动关联的会议的相关信息。这些会议可以是 Google 会议解决方案(例如 Google Meet),也可以是第三方会议。当且仅当日历活动中存在数据,并且插件将其 addOns.calendar.currentEventAccess 清单 字段设置为 READ 或 READ_WRITE 时,此信息才会出现在事件对象中。
| JSON 表示法 |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| 字段 | |
|---|---|
conferenceId |
会议的 ID。此 ID 旨在让应用能够跟踪会议;您不应向用户显示此 ID。 |
conferenceSolution |
表示会议解决方案(例如 Hangouts 或 Google Meet)的对象。 |
entryPoints[] |
会议入口点(例如网址或电话号码)的列表。 |
notes |
要向用户显示的有关会议的其他备注(例如网域管理员的说明或法律声明)。可包含 HTML。长度上限为 2048 个字符。 |
parameters |
一个对象,其中包含供插件使用的已定义参数数据的映射。 |
ConferenceSolution
| JSON 表示法 |
|---|
{
"iconUri": string,
"key": {
object ( |
| 字段 | |
|---|---|
iconUri |
代表此会议解决方案的用户可见图标的 URI。 |
key |
用于唯一标识此活动的会议解决方案的键。 |
name |
此会议解决方案的用户可见名称(未本地化)。 |
键
| JSON 表示法 |
|---|
{ "type": string } |
| 字段 | |
|---|---|
type |
会议解决方案类型。可能的值包括下列项:
|
EntryPoint
入口点对象包含有关访问给定会议的既定方式的信息,例如通过电话或视频。当且仅当日历活动中存在数据,并且插件将其 addOns.calendar.currentEventAccess 清单 字段设置为 READ 或 READ_WRITE 时,此信息才会出现在事件对象中。
| JSON 表示法 |
|---|
{ "accessCode": string, "entryPointType": string, "label": string, "meetingCode": string, "passcode": string, "password": string, "pin": string, "uri": string, "regionCode": string, "entryPointFeatures": [ string ] } |
| 字段 | |
|---|---|
accessCode |
用于访问会议的访问代码。长度上限为 128 个字符。会议提供商通常仅使用 {accessCode, meetingCode, passcode, password, pin} 的子集来提供会议访问权限。匹配并仅显示会议提供商使用的字段。 |
entryPointType |
入口点的类型。可能的值如下:
|
label |
入口点 URI 的用户可见标签(未本地化)。 |
meetingCode |
用于访问会议的会议代码。长度上限为 128 个字符。会议提供商通常仅使用 {accessCode, meetingCode, passcode, password, pin} 的子集来提供会议访问权限。匹配并仅显示会议提供商使用的字段。 |
passcode |
用于访问会议的密码。长度上限为 128 个字符。会议提供商通常仅使用 {accessCode, meetingCode, passcode, password, pin} 的子集来提供会议访问权限。匹配并仅显示会议提供商使用的字段。 |
password |
用于访问会议的密码。长度上限为 128 个字符。会议提供商通常仅使用 {accessCode, meetingCode, passcode, password, pin} 的子集来提供会议访问权限。匹配并仅显示会议提供商使用的字段。 |
pin |
用于访问会议的 PIN 码。长度上限为 128 个字符。会议提供商通常仅使用 {accessCode, meetingCode, passcode, password, pin} 的子集来提供会议访问权限。匹配并仅显示会议提供商使用的字段。 |
uri |
入口点的 URI。长度上限为 1300 个字符。格式取决于入口点类型:
|
regionCode |
电话号码的地区代码。如果 URI 不包含国家/地区代码,则用户需要此信息。这些值基于公开的 CLDR 地区代码列表。 |
entryPointFeatures[] |
入口点的特征。目前,这些功能仅适用于电话入口点:
|
参数
| JSON 表示法 |
|---|
{
"addOnParameters": {
object ( |
| 字段 | |
|---|---|
addOnParameters |
参数字符串键和值的映射。这些键和值由插件开发者定义,用于将信息附加到特定会议,以供插件使用。 |
AddOnParameters
| JSON 表示法 |
|---|
{ "parameters": { string: string, ... } } |
| 字段 | |
|---|---|
parameters |
包含一系列 |
功能
| JSON 表示法 |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| 字段 | |
|---|---|
canSeeAttendees |
用户生成的数据。如果插件可以读取活动参加者列表,则为 true;否则为 false。 |
canAddAttendees |
用户生成的数据。如果插件可以向活动参加者列表添加新参加者,则为 true;否则为 false。 |
canSeeConferenceData |
用户生成的数据。如果插件可以读取活动会议数据,则为 true;否则为 false。 |
canSetConferenceData |
用户生成的数据。如果插件可以更新活动会议数据,则为 true;否则为 false。 |
canAddAttachments |
用户生成的数据。如果插件可以向活动添加新附件,则为 true;否则为 false。 |
DriveEventObject
云端硬盘事件对象是整个事件对象的一部分,其中包含有关用户 Google 云端硬盘及其内容的信息。仅当宿主应用为 Google 云端硬盘时,此字段才会出现在事件对象中。
| JSON 表示法 |
|---|
{ "selectedItems": [ { object ( |
| 字段 | |
|---|---|
selectedItems[] |
在云端硬盘中选择的内容(文件或文件夹)列表。 |
activeCursorItem |
当前处于活跃状态的云端硬盘内容。 |
DriveItemMetadata
云端硬盘内容对象包含特定云端硬盘内容(例如文件或文件夹)的相关信息。
| JSON 表示法 |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| 字段 | |
|---|---|
id |
所选商品的 ID。 |
iconUrl |
代表所选项的图标的网址。 |
mimeType |
所选项的 MIME 类型。 |
title |
所选项的标题。 |
addonHasFileScopePermission |
如果为 true,则表示插件已请求并获得此内容的 https://www.googleapis.com/auth/drive.file 范围授权。否则,此字段为 false。 如果插件使用更宽松的范围(例如 https://www.googleapis.com/auth/drive 或 https://www.googleapis.com/auth/drive.readonly),则此字段不相关。在设计插件时,请始终使用尽可能最小的范围,以保护用户信息。 |
GmailEventObject
Gmail 事件对象是整个事件对象中包含用户 Gmail 邮件相关信息的部分。仅当托管应用为 Gmail 时,此字段才会出现在事件对象中。
| JSON 表示法 |
|---|
{ "messageId": string, "threadId": string, "accessToken": string, "toRecipients": [ string ], "ccRecipients": [ string ], "bccRecipients": [ string ] } |
| 字段 | |
|---|---|
messageId |
当前打开的 Gmail 邮件的 ID。 |
threadId |
当前打开的 Gmail 会话串 ID。 |
accessToken |
Gmail 专用访问令牌。您可以将此令牌与 |
toRecipients[] |
默认处于停用状态。插件正在撰写的草稿中当前包含的“收件人:”收件人邮箱列表。如需启用此字段,您必须在清单中将 |
ccRecipients[] |
默认处于停用状态。插件正在撰写的草稿中当前包含的“抄送:”收件人邮箱列表。如需启用此字段,您必须在清单中将 |
bccRecipients[] |
默认处于停用状态。插件正在撰写的草稿中当前包含的“密送:”收件人邮箱列表。如需启用此字段,您必须在清单中将 |
SheetsEventObject
Google 表格事件对象是整个事件对象的一部分,其中包含有关用户文档及其内容的信息。仅当插件扩展了 Google 表格时,此字段才会出现在事件对象中。
| JSON 表示法 |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| 字段 | |
|---|---|
id |
仅在用户已授权 |
title |
仅在用户已授权 |
addonHasFileScopePermission |
如果为 |
matchedUrl |
仅在满足以下条件时才会显示:
在 Google 表格中生成预览的链接的网址。如需使用此字段,您必须在插件清单中配置 用户预览链接 |
MatchedUrl
随链接预览请求返回的事件对象。
| JSON 表示法 |
|---|
{ "url": string } |
| 字段 | |
|---|---|
url |
匹配的网址。 |
SlidesEventObject
Google 幻灯片事件对象是整个事件对象的一部分,其中包含有关用户文档及其内容的信息。仅当插件扩展了 Google 幻灯片时,它才会出现在事件对象中。
| JSON 表示法 |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| 字段 | |
|---|---|
id |
仅在用户已授权 |
title |
仅在用户已授权 |
addonHasFileScopePermission |
如果为 |
matchedUrl |
仅在满足以下条件时才会显示:
在 Google 幻灯片中生成预览的链接的网址。如需使用此字段,您必须在插件清单中配置 用户预览链接 |
DocsEventObject
Google 文档事件对象是整个事件对象的一部分,其中包含有关用户文档及其内容的信息。仅当插件扩展了 Google 文档时,此字段才会出现在事件对象中。
| JSON 表示法 |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| 字段 | |
|---|---|
id |
仅在用户已授权 |
title |
仅在用户已授权 |
addonHasFileScopePermission |
如果为 |
matchedUrl |
仅在满足以下条件时才会显示:
在 Google 文档中生成预览的链接的网址。如需使用此字段,您必须在插件清单中配置 用户预览链接 |
ChatEventObject
从 Google 服务器发送到插件的 Google Chat 应用事件对象载荷。载荷可用于识别事件类型。
| JSON 表示法 |
|---|
{ "type": enum ( |
| 字段 | |
|---|---|
type |
事件的类型,仅针对非插件的 Chat 应用中的应用首页事件填充。 |
user |
与 Chat 应用互动的用户。 |
space |
事件发生的聊天室,仅针对非插件的 Chat 应用中的应用首页事件填充。 |
eventTime |
指示事件对象发生时间的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
| 事件对象的载荷。载荷取决于事件对象类型。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段: | |
messagePayload |
用户向 Chat 应用发送消息,或在聊天室中 @提及 Chat 应用。应用命令调用(例如斜杠命令和快捷命令)则通过 |
addedToSpacePayload |
用户将 Chat 应用添加到 Chat 聊天室,或者 Google Workspace 管理员在私信聊天室中为组织中的用户安装 Chat 应用。 |
removedFromSpacePayload |
用户从聊天室中移除 Chat 应用。 |
buttonClickedPayload |
表示当用户与卡片或对话框的互动元素互动时触发 如果用户与对话框互动,ButtonClickedPayload 的 完整载荷还包括 |
widgetUpdatedPayload |
用户更新了信息流内卡片或对话框中的微件。 完整载荷还包含 |
appCommandPayload |
用户调用应用命令。 |
systemCommandPayload |
用户调用系统命令。 |
| 互斥字段结束。 | |
EventType
事件的类型,仅针对非插件的 Chat 应用中的应用首页事件填充。
| 枚举 | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
枚举的默认值。请勿使用。 |
APP_HOME |
用户打开使用应用首页的 Chat 应用发来的私信。此类事件仅包含 type、user 和 space 字段。如需了解详情,请参阅为 Google Chat 应用构建首页。 |
SUBMIT_FORM |
用户在应用首页卡片中提交信息。此类事件仅包含 type、user 和 space 字段。如需了解详情,请参阅 [为 Google Chat 应用构建首页](https://developers.google.com/workspace/chat/send-app-home-card-message))。 |
MessagePayload
用户向 Chat 应用发送消息,或在聊天室中 @提及 Chat 应用。应用命令调用(例如斜杠命令和快捷命令)则使用 AppCommandPayload。
| JSON 表示法 |
|---|
{ "space": { object ( |
| 字段 | |
|---|---|
space |
必需。发生事件对象的 Chat 聊天室。 |
message |
触发事件对象的消息。 |
configCompleteRedirectUri |
可选。用户在 Google Chat 之外完成授权或配置流程后,Chat 应用应将用户重定向到的网址。如需了解详情,请参阅将 Chat 应用与其他服务和工具关联。 |
AddedToSpacePayload
用户将 Chat 应用添加到聊天室,或者在应用和用户之间创建私信。
| JSON 表示法 |
|---|
{
"space": {
object ( |
| 字段 | |
|---|---|
space |
必需。发生事件对象的 Chat 聊天室。 |
interactionAdd |
应用是否通过用户互动(例如,通过 @ 提及 Chat 应用或使用斜杠命令调用)添加到聊天室。如果此字段设置为 true,则会有一个与互动本身关联的单独事件对象分派到 Chat 应用。 |
configCompleteRedirectUri |
可选。用户在 Google Chat 之外完成授权或配置流程后,Chat 应用应将用户重定向到的网址。如需了解详情,请参阅将 Chat 应用与其他服务和工具关联。 |
RemovedFromSpacePayload
用户从聊天室中移除 Chat 应用。
| JSON 表示法 |
|---|
{
"space": {
object ( |
| 字段 | |
|---|---|
space |
必需。发生事件对象的 Chat 聊天室。 |
ButtonClickedPayload
用户与 Chat 插件中的卡片或对话框的互动元素互动,从而触发 Action 回调。尽管名称如此,但此载荷会针对所有卡片和对话框 Action 回调进行填充,包括按钮点击、onChangeAction 触发器、onClick 操作、CardAction 点击以及对话框提交或取消(SUBMIT_DIALOG 和 CANCEL_DIALOG)。
如果用户与对话框互动,ButtonClickedPayload 的 isDialogEvent 字段会设置为 true,并包含 DialogEventType。对于非插件的 Chat 应用,此载荷会映射到 SUBMIT_FORM 和 CARD_CLICKED 事件类型。
完整载荷还包括 CommonEventObject.form_inputs 和 CommonEventObject.parameters。
| JSON 表示法 |
|---|
{ "space": { object ( |
| 字段 | |
|---|---|
space |
必需。发生事件对象的 Chat 聊天室。 |
message |
触发事件对象的消息。 |
isDialogEvent |
对于 |
dialogEventType |
收到的对话事件对象的类型。 |
DialogEventType
对于包含 ButtonClicked 或 AppCommand 事件载荷的事件对象,与对话框的互动类型。
如需详细了解 Google Chat 应用事件对象,请参阅接收和响应与 Google Chat 应用的互动。
| 枚举 | |
|---|---|
DIALOG_EVENT_TYPE_UNSPECIFIED |
默认值。未指定。 |
REQUEST_DIALOG |
用户打开一个对话框。 |
SUBMIT_DIALOG |
用户点击对话框中的互动元素。例如,用户在对话框中填写信息,然后点击按钮提交信息。 |
CANCEL_DIALOG |
用户未提交信息便关闭了对话框,或者对话框被取消。 |
WidgetUpdatedPayload
用户在信息流内卡片或对话框中更新微件。
完整载荷还包含 CommonEventObject.parameters['autocomplete_widget_query']。
| JSON 表示法 |
|---|
{
"space": {
object ( |
| 字段 | |
|---|---|
space |
必需。发生事件对象的 Chat 聊天室。 |
AppCommandPayload
用户调用应用命令。
| JSON 表示法 |
|---|
{ "appCommandMetadata": { object ( |
| 字段 | |
|---|---|
appCommandMetadata |
为应用命令(包括斜杠命令和快速命令)填充。 |
space |
可选。发生事件对象的 Chat 聊天室。 |
thread |
可选。发生事件对象的线程(如果适用)。如果事件对象与特定邮件或会话有关联,则系统会填充此字段。 |
message |
可选。触发事件对象的消息(如果适用)。此字段仅针对斜杠命令进行填充。 |
configCompleteRedirectUri |
可选。用户在 Google Chat 之外完成授权或配置流程后,应重定向到的网址。如需了解详情,请参阅将 Chat 应用与其他服务和工具关联。 |
isDialogEvent |
可选。用户是否正在或即将与对话框互动。 |
dialogEventType |
可选。收到的对话事件对象的类型。此字段仅在 |
AppCommandMetadata
有关 Chat 应用命令的元数据。
| JSON 表示法 |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| 字段 | |
|---|---|
appCommandId |
在 Chat API 配置中指定的命令的 ID。 |
appCommandType |
Chat 应用命令的类型。 |
AppCommandType
Chat 应用命令的类型。如需了解详情,请参阅 Chat 应用命令的类型。
| 枚举 | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
默认值。未指定。 |
SLASH_COMMAND |
斜杠命令。用户在聊天消息中发送命令。 |
QUICK_COMMAND |
快速命令。用户从消息回复区域的 Chat 菜单中选择该命令。 |
MESSAGE_ACTION |
消息操作。用户从 Chat 中的消息上下文菜单中选择该命令。 |
SystemCommandPayload
用户调用系统命令。
| JSON 表示法 |
|---|
{ "systemCommandMetadata": { object ( |
| 字段 | |
|---|---|
systemCommandMetadata |
所调用的系统命令的相关元数据。 |
space |
可选。发生事件对象的 Chat 聊天室。 |
thread |
可选。发生事件对象的线程(如果适用)。如果事件对象与特定邮件或会话有关联,则系统会填充此字段。 |
SystemCommandMetadata
由用户触发的系统命令的相关元数据。
| JSON 表示法 |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"cancelStream": {
object ( |
| 字段 | |
|---|---|
| 调用的系统命令。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段: | |
cancelStream |
用于取消活跃流消息的命令。 |
| 互斥字段结束。 | |
CancelStream
用于取消活跃流消息的命令。
| JSON 表示法 |
|---|
{ "streamMessage": string } |
| 字段 | |
|---|---|
streamMessage |
必需。执行了取消命令的流消息的资源名称。 格式: |
WorkflowEventObject
LINT.IfChange 传递给工作流插件的事件对象。
| JSON 表示法 |
|---|
{ "executionMetadata": { object ( |
| 字段 | |
|---|---|
executionMetadata |
有关工作流执行的元数据。 |
triggerEventSource |
触发事件的来源。 |
| 工作流事件载荷的类型。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段: | |
actionInvocation |
调用工作流操作。 |
triggerCreation |
创建工作流触发器。 |
triggerDeletion |
删除工作流触发器。 |
resourceRetrieval |
检索资源(用于变量膨胀)。 |
elementConfiguration |
工作流元素的配置。 |
resourceFieldsDefinitionRetrieval |
检索资源支持的字段定义。 |
elementUiAutocomplete |
针对当前呈现的卡片的自动补全建议。 |
| 互斥字段结束。 | |
ActionInvocation
调用工作流操作。
| JSON 表示法 |
|---|
{ "inputs": { string: { object ( |
| 字段 | |
|---|---|
inputs |
以输入变量名称为键的输入变量映射。 包含一系列 |
triggerId |
用于异步操作响应的触发器 ID。 |
flowLevelContext |
可选。来自前面步骤的流级上下文。 |
VariableData
表示变量数据,可包含不同类型的多个值。
| JSON 表示法 |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| 字段 | |
|---|---|
booleanValues[] |
布尔值。 |
integerValues[] |
整数值。 |
floatValues[] |
浮点值。 |
stringValues[] |
字符串值。 |
timestampValues[] |
时间戳值。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
resourceReferences[] |
资源引用(ID)。 |
emailAddressValues[] |
邮箱值。 |
googleUserValues[] |
Google 用户值,格式为 |
textFormatValues[] |
工作流文本格式值。 |
ResourceReference
应用特定资源的 ID 值。
| JSON 表示法 |
|---|
{
"resourceType": {
object ( |
| 字段 | |
|---|---|
resourceType |
此 ID 指向的资源类型。 |
resourceId |
资源的 ID。 |
ResourceType
自定义资源类型的名称。
| JSON 表示法 |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| 字段 | |
|---|---|
workflowBundleId |
拥有此资源类型的工作流软件包的 ID。此字段为可选字段,如果留空,则会被视为与使用它的 bundle 相同。 |
workflowResourceDefinitionId |
资源的唯一标识符。此 ID 只需在同一软件包中保持唯一。 |
WorkflowTextFormat
包含丰富格式选项(包括样式、超链接和互动元素)的文本块。
| JSON 表示法 |
|---|
{
"textFormatElements": [
{
object ( |
| 字段 | |
|---|---|
textFormatElements[] |
文本格式元素的集合。 |
TextFormatElement
WorkflowTextFormat 消息中的单个元素,可以是条状标签、样式化文本、超链接或列表容器。
| JSON 表示法 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string, "chip": { object ( |
| 字段 | |
|---|---|
| 表示几种可能的文本格式元素之一的元素。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段: | |
text |
文本格式的文本。 |
chip |
文本格式的可点击条状标签。 |
styledText |
文本格式的样式化文本。 |
hyperlink |
文本格式的超链接。 |
listContainer |
文本格式的列表容器。 |
| 互斥字段结束。 | |
条状标签
文本格式的可点击条状标签。
| JSON 表示法 |
|---|
{
"icon": {
object ( |
| 字段 | |
|---|---|
icon |
条状标签中显示的图标。 |
label |
条状标签中显示的文本。 |
url |
点击条状标签后要导航到的网址。 |
图标
条状标签中的图标。
| JSON 表示法 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "iconUrl": string, "materialIconName": string // End of mutually exclusive fields. } |
| 字段 | |
|---|---|
| 条状标签中显示的图标。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段: | |
iconUrl |
显示托管在 HTTPS 网址上的自定义图标。 例如: 支持的文件类型包括 |
materialIconName |
Google Material 图标中定义的图标名称,例如 |
| 互斥字段结束。 | |
StyledText
具有粗体、斜体和颜色等样式的文本元素。
| JSON 表示法 |
|---|
{ "text": string, "styles": [ enum ( |
| 字段 | |
|---|---|
text |
文本的主要内容。 |
styles[] |
应用于文本的样式集合。 |
fontWeight |
文本的字体粗细。 |
color |
文本的颜色。 |
wrapStyle |
文本的换行样式。 |
样式
不同文本样式(例如斜体、下划线等)的枚举。
| 枚举 | |
|---|---|
STYLE_UNSPECIFIED |
未应用任何样式。请勿使用。 |
ITALIC |
斜体样式。 |
UNDERLINE |
下划线样式。 |
STRIKETHROUGH |
删除线样式。 |
LINE_BREAK |
换行符。 |
UPPERCASE |
大写样式。 |
CODE |
Code. |
CODE_BLOCK |
代码块。 |
FontWeight
不同字体粗细的枚举。
| 枚举 | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
标准重量,厚度正常。请勿使用。 |
LIGHT |
重量更轻,厚度更薄。 |
MEDIUM |
介于细体和粗体之间的字重。 |
BOLD |
重量更重,厚度增加。 |
WrapStyle
不同换行样式的枚举。
| 枚举 | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
未指定换行样式。 |
NO_WRAP |
无换行样式。 |
超链接
包含文本和链接的超链接元素。
| JSON 表示法 |
|---|
{ "link": string, "text": string } |
| 字段 | |
|---|---|
link |
超链接的目标网址。 |
text |
超链接的文本。 |
ListContainer
列表项的容器,其中每个列表项可以包含多个 TextFormatElement。
| JSON 表示法 |
|---|
{ "listNestLevel": string, "listType": enum ( |
| 字段 | |
|---|---|
listNestLevel |
列表的嵌套级别。从 0 开始(表示顶层),然后每个嵌套列表递增 1。 |
listType |
列表的类型。 |
listItems[] |
列表项的集合。 |
ListType
不同列表类型的枚举。
| 枚举 | |
|---|---|
LIST_TYPE_UNSPECIFIED |
未指定列表类型。请勿使用。 |
ORDERED |
有序列表。 |
UNORDERED |
无序列表。 |
BLOCKQUOTE |
表示一个引用块列表。 |
ListItem
列表项。
| JSON 表示法 |
|---|
{
"textFormatElements": [
{
object ( |
| 字段 | |
|---|---|
textFormatElements[] |
文本格式元素的集合。 |
FlowLevelContext
包含前面步骤输出的流级上下文。
| JSON 表示法 |
|---|
{
"stepContexts": [
{
object ( |
| 字段 | |
|---|---|
stepContexts[] |
可选。前面的步骤列表。顺序很重要,因此请确保此列表中保持执行顺序。 |
StepContext
流级上下文的步骤上下文元数据和输出。
| JSON 表示法 |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| 字段 | |
|---|---|
stepId |
可选。工作流图表中步骤的唯一 ID。 |
outputs |
可选。此步骤生成的输出变量的映射,以变量名称为键。 包含一系列 |
TriggerCreation
创建工作流触发器。
| JSON 表示法 |
|---|
{ "triggerId": string, "triggerType": enum ( |
| 字段 | |
|---|---|
triggerId |
创建期间提供的触发器的唯一标识符。 |
triggerType |
触发器类型。 |
inputs |
以输入变量名称为键的输入变量映射。 包含一系列 |
notifyUri |
触发器触发时将调用的端点。 |
TriggerType
触发器类型。
| 枚举 | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
默认值。请勿使用。 |
REPEATING |
每当满足输入条件时,触发器就会触发。 |
TriggerDeletion
删除工作流触发器。
| JSON 表示法 |
|---|
{ "triggerId": string } |
| 字段 | |
|---|---|
triggerId |
创建期间提供的触发器的唯一标识符。 |
ResourceRetrieval
检索资源。
| JSON 表示法 |
|---|
{
"resourceReference": {
object ( |
| 字段 | |
|---|---|
resourceReference |
要检索的资源的类型和 ID。 |
ElementConfiguration
配置工作流元素时调用。
| JSON 表示法 |
|---|
{ "inputs": { string: { object ( |
| 字段 | |
|---|---|
inputs |
输入变量的映射,以输入变量名称为键。此映射可能为空。在工作流首页中配置单个工作流元素(触发器或操作)时使用。 包含一系列 |
displayDestination |
元素配置卡片的目标页面。元素可以使用此字段根据目标平台返回不同的配置卡片布局。 |
nodeId |
正在呈现的基元配置的节点 ID。 |
workflowId |
正在呈现的原语配置的工作流 ID。 |
availableVariables[] |
可用变量按节点位置排序。 |
DisplayDestination
指明返回元素配置卡片的显示位置。
| 枚举 | |
|---|---|
DISPLAY_DESTINATION_UNSPECIFIED |
默认值。请勿使用。 |
DISPLAY_DESTINATION_SIDE_PANEL |
配置卡片将显示在侧边栏中。 |
DISPLAY_DESTINATION_FULL_SCREEN |
配置卡片将显示在全屏应用中。 |
VariableReference
对工作流中变量的变量引用。
| JSON 表示法 |
|---|
{
"parentElementId": string,
"nodeId": string,
"path": string,
"dataType": {
object ( |
| 字段 | |
|---|---|
parentElementId |
生成变量的元素的基元 ID。如果需要,我们可以将其扩展为 WorkflowElement 或更详细的元数据 proto。 |
nodeId |
节点引用 ID |
path |
变量选择器路径签名 |
dataType |
变量数据类型 |
iconUrl |
生成此变量的原语的图标网址。 |
stepNumber |
生成此变量的原语的步骤编号。 |
descriptionText |
变量的说明。 |
displayText |
变量条状标签的显示文本。 |
DataType
变量的类型。
| JSON 表示法 |
|---|
{ "valueMetadata": { object ( |
| 字段 | |
|---|---|
valueMetadata |
有关变量潜在值的元数据。 |
| 数据类型。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段: | |
basicType |
基本数据类型。 |
resourceType |
应用资源 ID 类型。 |
| 互斥字段结束。 | |
BasicType
基本泛型数据类型。
| 枚举 | |
|---|---|
BASIC_TYPE_UNSPECIFIED |
默认值。请勿使用。 |
STRING |
一串字符。 |
INTEGER |
一个整数。 |
FLOAT |
浮点数。 |
TIMESTAMP |
采用 ISO 8601 格式的时间戳。 |
BOOLEAN |
可以为 true 或 false 的值。 |
EMAIL_ADDRESS |
邮箱,即采用邮箱格式的字符串。 |
GOOGLE_USER |
Google 服务用户,格式为 users/{user}。 |
FILE |
文件引用。 |
FORMATTED_TEXT |
包含丰富格式的文本。 |
ValueMetadata
有关变量可能值的信息。
| JSON 表示法 |
|---|
{ "enumValues": [ string ], "dynamicTypes": [ enum ( |
| 字段 | |
|---|---|
enumValues[] |
可选。指定字符串的允许值。只有当 |
dynamicTypes[] |
可选。指定可为变量动态转换的允许类型。仅当 DataType 为 String 且变量为输出时,才能设置此项。 |
semanticDescriptors[] |
可选。有助于描述变量的语义。 |
dynamicSchema |
可选。用于动态解析此变量架构的配置。 |
defaultValue |
可选。指定此变量默认值的字符串。例如,对于布尔值, |
SemanticDescriptor
有关变量语义的元数据。
| JSON 表示法 |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| 字段 | |
|---|---|
resourceAttribute |
表示变量对应于资源的特定属性。这对于表示资源标识符(ID、网址、密钥等)的变量尤其有用。 建议采用以下格式:- 示例:- 客户端将使用此信息向用户提示哪些输出变量与特定输入兼容。 |
disallowedResourceAttributes[] |
可选。仅适用于输入,对于输出则会被忽略。与此语义描述符对应的禁止属性。客户端会明确阻止为与这些不允许的资源属性对应的输出选择变量。 |
DynamicSchema
用于在运行时动态解析此变量架构的配置。
| JSON 表示法 |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| 字段 | |
|---|---|
requiredInputIds[] |
必须先提供同级输入变量的 ID,然后才能动态解析此变量的架构。 |
strictEnum |
如果为 true,则变量的值必须与动态解析的枚举值之一匹配。如果为 false,则动态解析的值会被视为非严格建议。 |
ResourceFieldsDefinitionRetrieval
检索资源支持的字段的定义。
| JSON 表示法 |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| 字段 | |
|---|---|
elementId |
指定要提取其动态资源架构的元素的 ID。 |
inputs |
这包括提供变量的节点的字段输入。以输入变量名称为键的输入变量映射。 包含一系列 |
ElementUiAutocomplete
针对当前呈现的卡片的自动补全建议。
| JSON 表示法 |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| 字段 | |
|---|---|
query |
要自动补全的查询。 |
inputs |
以输入变量名称为键的输入变量映射。 包含一系列 |
invokedFunction |
与微件关联的被调用函数。 |
resourceId |
应自动补全的资源 ID。此字段为可选字段,可能未设置。 |
operationId |
提供要自动补全的资源的操作的 ID。此字段为可选字段,可能未设置。 |
ExecutionMetadata
有关工作流执行的元数据。
| JSON 表示法 |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| 字段 | |
|---|---|
versionId |
所调用的工作流元素的版本。 |
timeZone |
要保存的工作流的时区,例如“America/Los_Angeles”。 |
stepNumber |
表示所调用基元的步骤编号。 |
TriggerEventSource
触发此执行的触发器事件的来源。
| 枚举 | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
默认值。请勿使用。 |
TRIGGER_EVENT_SOURCE_AUTOMATED |
执行由事件自动触发。 |
TRIGGER_EVENT_SOURCE_TEST_RUN |
执行由测试运行触发。 |