EventObject

EventObject

Google 插件互动事件,其中包含用户与宿主应用中的插件互动的数据。

当用户在宿主应用中与插件互动时,事件对象会以 JSON 格式传递给插件的回调函数或触发器(对于 Apps 脚本),或 https 端点(对于 HTTP)。事件对象会存储由每个宿主应用定义的宿主应用事件对象,以及包含一些与事件相关的通用字段的通用事件对象。

如需了解详情,请参阅事件对象。

JSON 表示法
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
字段
commonEventObject

object (CommonEventObject)

一个包含所有事件对象通用信息的对象,无论托管应用是什么。

authorizationEventObject

object (AuthorizationEventObject)

仅针对向 HTTP 端点发出的请求设置

以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
calendar

object (CalendarEventObject)

仅当调用主机为 Google 日历时才会显示。一个包含日历和活动信息的对象。

drive

object (DriveEventObject)

仅当调用主机为 Google 云端硬盘时才会显示。一个包含云端硬盘信息的对象。

gmail

object (GmailEventObject)

仅当调用主机为 Gmail 时才会显示。一个包含 Gmail 信息的对象。

sheets

object (SheetsEventObject)

仅当调用主机为 Google 表格时才会显示。一个包含 Google 表格信息的对象。

slides

object (SlidesEventObject)

仅当调用主机为 Google 幻灯片时才会显示。一个包含幻灯片信息的对象。

docs

object (DocsEventObject)

仅当调用主机为 Google 文档时才会显示。一个包含 Google 文档信息的对象。

chat

object (ChatEventObject)

仅在调用主机为 Google Chat 时才会显示。一个包含 Chat 信息。

workflow

object (WorkflowEventObject)

仅在调用主机为 Google Workspace Studio 时显示。一个包含工作流信息的对象。

互斥字段结束。

CommonEventObject

通用事件对象是整个事件对象的一部分,用于将不依赖于宿主的一般信息从用户客户端传递到插件。这些信息包括用户的语言区域、宿主应用和平台等详细信息。

除了首页和上下文触发器之外,当用户与 widget 互动时,插件还会构建事件对象并将其传递给操作回调函数。插件的回调函数可以查询通用事件对象,以确定用户客户端中打开的 widget 的内容。例如,您的插件可以在 eventObject.commentEventObject.formInputs 对象中找到用户在 TextInput widget 中输入的文本。

对于 Chat 应用,指用户在与微件互动时调用的函数的名称。

JSON 表示法
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
字段
userLocale

string

默认处于停用状态。用户的语言和国家/地区标识符,格式为 ISO 639 语言代码-ISO 3166 国家/地区代码。例如 en-US。

如需启用此字段,您必须在插件清单中将 addOns.common.useLocaleFromApp 设置为 true。插件的范围列表还必须包含 https://www.googleapis.com/auth/script.locale。如需了解详情,请参阅访问用户语言区域和时区。

hostApp

enum (HostApp)

指明生成事件对象时插件在哪个宿主应用中处于活跃状态。可能的值包括下列项:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

平台枚举,用于指示事件源自哪个平台(WEB、IOS 或 ANDROID)。Chat 应用不支持此字段。

timeZone

object (TimeZone)

默认处于停用状态。时区 ID 以及相对于世界协调时间 (UTC) 的偏移量。如需启用此字段,您必须在插件清单中将 addOns.common.useLocaleFromApp 设置为 true。插件的范围列表还必须包含 https://www.googleapis.com/auth/script.locale。如需了解详情,请参阅访问用户语言区域和时区。

仅支持事件类型 CARD_CLICKED 和 SUBMIT_DIALOG。

formInputs

map (key: string, value: object (Inputs))

一个映射,其中包含所显示卡片中微件的当前值。映射键是分配给每个输入 widget(例如 TextInput.name、SelectionInput.name、DateTimePicker.name 或 DecoratedText.SwitchControl.name)的字符串 name 值。

映射值对象的结构取决于 widget 类型:

注意:以下示例已针对 Apps 脚本的 V8 运行时进行了格式设置。如果您使用的是 Rhino 运行时,则必须在值后面添加 [""]。例如,将事件对象格式设置为 e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0],而不是 e.commonEventObject.formInputs.employeeName.stringInputs.value[0]。如需详细了解 Apps 脚本中的运行时,请参阅 V8 运行时概览。

  • 单值 widget(例如 TextInput widget,或类型为 DROPDOWN 或 RADIO_BUTTON 的 SelectionInput widget):包含单元素列表(如果未进行选择,则为空列表)的 StringInputs 对象。

示例:对于 name 为 employeeName 的文本输入 widget,请使用以下代码访问文本输入值:e.commonEventObject.formInputs.employeeName.stringInputs.value[0]。

  • 多值 widget(例如,类型为 CHECK_BOX、SWITCH 或 MULTI_SELECT 的 SelectionInput widget):包含所选项 value 字符串列表的 StringInputs 对象。

示例:对于 name 为 participants 的多值 widget,请使用 e.commonEventObject.formInputs.participants.stringInputs.value 访问值数组。

  • DecoratedText.SwitchControl widget:StringInputs 对象。当 selected 为 true 时,stringInputs.value 包含开关的 value 字段(如果未指定 value,则为 "";如果多个开关共用同一个 name,则每个所选开关的 value 都会包含在列表中)。如果 selected 为 false,则开关的 value 会从 stringInputs.value 中省略。

  • 日期时间选择器 (DateTimePickerType.DATE_AND_TIME):DateTimeInput object。

示例:对于 name 为 myDTPicker 的选择器,请使用 e.commonEventObject.formInputs.myDTPicker.dateTimeInput 访问 DateTimeInput 对象。

示例:对于 name 为 myDatePicker 的选择器,请使用 e.commonEventObject.formInputs.myDatePicker.dateInput 访问 DateInput 对象。

示例:对于 name 为 myTimePicker 的选择器,请使用 e.commonEventObject.formInputs.myTimePicker.timeInput 访问 TimeInput 对象。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

parameters

map (key: string, value: string)

您使用 actionParameters 或 Action.setParameters() 为操作提供的任何其他参数。

开发者预览版:对于扩展 Google Chat 的插件,如需根据用户在多选菜单中输入的内容推荐选项,请使用 "autocomplete_widget_query" 键 (event.commonEventObject.parameters["autocomplete_widget_query"]) 的值。您可以使用此值查询数据库,并在用户输入内容时向其推荐可选项。如需了解详情,请参阅收集和处理 Google Chat 用户的信息。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

invokedFunction

string

要调用的函数的名称。

对于扩展 Google Chat 的 Google Workspace 插件,此字段不会填充。相反,如需接收标识符等函数数据,扩展 Chat 的插件应使用 parameters 字段。请参阅为 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

string

IANA TZ 时区数据库代码,例如“America/Toronto”。

offset

integer

用户时区相对于世界协调时间 (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)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
字段
以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
stringInputs

object (StringInputs)

一个字符串列表,表示用户在 widget 中输入的值。

如果该 widget 仅接受一个值(例如 TextInput widget),则该列表包含一个字符串对象。如果微件接受多个值(例如复选框的 SelectionInput 微件),则该列表会包含一个字符串对象,对应用户输入或选择的每个值。

dateTimeInput

object (DateTimeInput)

来自 DateTimePicker widget 的日期和时间输入值,该 widget 同时接受日期和时间。

dateInput

object (DateInput)

来自仅接受日期值的 DateTimePicker widget 的日期输入值。

timeInput

object (TimeInput)

来自仅接受时间值的 DateTimePicker widget 的时间输入值。

互斥字段结束。

StringInputs

常规 widget 的输入参数。对于单值 widget,它是一个单值列表。对于多值微件(例如复选框),系统会显示所有值。

JSON 表示法
{
  "value": [
    string
  ]
}
字段
value[]

string

用户输入的字符串列表。

DateTimeInput

日期和时间输入值。

JSON 表示法
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
字段
msSinceEpoch

string (int64 format)

自纪元时间以来的时间(以毫秒为单位)。

hasDate

boolean

datetime 输入是否包含日历日期。

hasTime

boolean

datetime 输入是否包含时间戳。

DateInput

日期输入值。

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

string (int64 format)

自纪元时间以来的时间(以毫秒为单位)。

TimeInput

时间输入值。

JSON 表示法
{
  "hours": integer,
  "minutes": integer
}
字段
hours

integer

24 小时制的小时。

minutes

integer

整点过后的分钟数。有效值为 0 到 59。

AuthorizationEventObject

封装插件请求的授权信息

JSON 表示法
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
字段
userOAuthToken

string

最终用户 OAuth 访问令牌,已获得所请求范围的授权。(在 OAuth 权限请求页面拆分后,系统将使用最终用户授权的范围进行授权)

userIdToken

string

最终用户 ID 令牌(如果请求了适当的 ID 范围)

systemIdToken

string

此部署的 G Suite 插件服务账号的 ID 令牌

authorizedScopes[]

string

用户授权的 OAuth 范围列表。

CalendarEventObject

日历事件对象是整个事件对象的一部分,其中包含有关用户日历和日历活动的信息。仅当宿主应用是 Google 日历时,此字段才会出现在事件对象中。

下表列出了事件对象的 calendar 字段中存在的字段。当且仅当日历活动中存在相应数据,并且插件将其 addOns.calendar.currentEventAccess 清单字段设置为 READ 或 READ_WRITE 时,标记为用户生成的数据的字段才会出现在事件对象中。

JSON 表示法
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
字段
id

string

事件 ID。

recurringEventId

string

周期性活动的 ID。

calendarId

string

日历 ID。

organizer

object (Organizer)

表示活动组织者的对象。

attendees[]

object (Attendee)

用户生成的数据。日历活动参加者的列表。

conferenceData

object (ConferenceData)

用户生成的数据。一个对象,表示与此活动关联的所有会议数据,例如 Google Meet 会议详细信息。

capabilities

object (Capabilities)

用户生成的数据。一个对象,用于描述插件查看或更新活动信息的功能。

组织者

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

string

活动组织者的邮箱。

参加者

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

string

参加者的邮箱。

displayName

string

参加者的显示名称。

organizer

boolean

如果参加者是此活动的组织者,则为 true。

self

boolean

如果此参加者代表显示此活动的日历,则为 true;否则为 false。

resource

boolean

如果参加者代表资源(例如会议室或设备),则为 true;否则为 false。

optional

boolean

如果此参加者的出席状态标记为可选,则为 true;否则为 false。

responseStatus

string

参加者的回复状态。可能的值包括下列项:

  • accepted:参加者已接受活动邀请。
  • declined:参加者已拒绝活动邀请。
  • needsAction:参加者尚未回复活动邀请。
  • tentative:参加者已暂时接受活动邀请。
comment

string

参加者的回复评论(如果有)。

additionalGuests

integer

参加者表示要携带的额外宾客人数。默认值为 0。

ConferenceData

会议数据对象包含与 Google 日历活动关联的会议的相关信息。这些会议可以是 Google 会议解决方案(例如 Google Meet),也可以是第三方会议。当且仅当日历活动中存在数据,并且插件将其 addOns.calendar.currentEventAccess 清单 字段设置为 READ 或 READ_WRITE 时,此信息才会出现在事件对象中。

JSON 表示法
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
字段
conferenceId

string

会议的 ID。此 ID 旨在让应用能够跟踪会议;您不应向用户显示此 ID。

conferenceSolution

object (ConferenceSolution)

表示会议解决方案(例如 Hangouts 或 Google Meet)的对象。

entryPoints[]

object (EntryPoint)

会议入口点(例如网址或电话号码)的列表。

notes

string

要向用户显示的有关会议的其他备注(例如网域管理员的说明或法律声明)。可包含 HTML。长度上限为 2048 个字符。

parameters

object (Parameters)

一个对象,其中包含供插件使用的已定义参数数据的映射。

ConferenceSolution

JSON 表示法
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
字段
iconUri

string

代表此会议解决方案的用户可见图标的 URI。

key

object (Key)

用于唯一标识此活动的会议解决方案的键。

name

string

此会议解决方案的用户可见名称(未本地化)。

键

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

string

会议解决方案类型。可能的值包括下列项:

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

string

用于访问会议的访问代码。长度上限为 128 个字符。会议提供商通常仅使用 {accessCode, meetingCode, passcode, password, pin} 的子集来提供会议访问权限。匹配并仅显示会议提供商使用的字段。

entryPointType

string

入口点的类型。可能的值如下:

  • more:其他会议加入说明,例如备用电话号码。一个会议只能有一个更多入口点;如果存在,则还需要至少一个其他类型的入口点。
  • phone:通过电话号码加入会议。一个会议可以有零个或多个电话入口点。Google 日历仅显示前两个电话入口点(按字母顺序设置格式和排序后)。
  • sip:通过 SIP 加入会议。一个会议最多只能有一个 sip 入口点。
  • video:通过 HTTP 加入会议。一个会议最多只能有一个视频入口点。
label

string

入口点 URI 的用户可见标签(未本地化)。

meetingCode

string

用于访问会议的会议代码。长度上限为 128 个字符。会议提供商通常仅使用 {accessCode, meetingCode, passcode, password, pin} 的子集来提供会议访问权限。匹配并仅显示会议提供商使用的字段。

passcode

string

用于访问会议的密码。长度上限为 128 个字符。会议提供商通常仅使用 {accessCode, meetingCode, passcode, password, pin} 的子集来提供会议访问权限。匹配并仅显示会议提供商使用的字段。

password

string

用于访问会议的密码。长度上限为 128 个字符。会议提供商通常仅使用 {accessCode, meetingCode, passcode, password, pin} 的子集来提供会议访问权限。匹配并仅显示会议提供商使用的字段。

pin

string

用于访问会议的 PIN 码。长度上限为 128 个字符。会议提供商通常仅使用 {accessCode, meetingCode, passcode, password, pin} 的子集来提供会议访问权限。匹配并仅显示会议提供商使用的字段。

uri

string

入口点的 URI。长度上限为 1300 个字符。格式取决于入口点类型:

  • 更多:必须使用 http: 或 https: 架构。
  • phone:必须使用 tel: 架构。URI 应包含整个拨号序列(例如,“tel:+12345678900,,,12345678;1234”)。
  • sip:需要 sip: 或 sips: 架构。例如“sip:12345678@myprovider.com”。
  • video:必须使用 http: 或 https: 架构。
regionCode

string

电话号码的地区代码。如果 URI 不包含国家/地区代码,则用户需要此信息。这些值基于公开的 CLDR 地区代码列表。

entryPointFeatures[]

string

入口点的特征。目前,这些功能仅适用于电话入口点:

  • toll:入口点是收费电话。
  • toll_free:入口点是免费电话。

参数

JSON 表示法
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
字段
addOnParameters

object (AddOnParameters)

参数字符串键和值的映射。这些键和值由插件开发者定义,用于将信息附加到特定会议,以供插件使用。

AddOnParameters

JSON 表示法
{
  "parameters": {
    string: string,
    ...
  }
}
字段
parameters

map (key: string, value: string)

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

功能

JSON 表示法
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
字段
canSeeAttendees

boolean

用户生成的数据。如果插件可以读取活动参加者列表,则为 true;否则为 false。

canAddAttendees

boolean

用户生成的数据。如果插件可以向活动参加者列表添加新参加者,则为 true;否则为 false。

canSeeConferenceData

boolean

用户生成的数据。如果插件可以读取活动会议数据,则为 true;否则为 false。

canSetConferenceData

boolean

用户生成的数据。如果插件可以更新活动会议数据,则为 true;否则为 false。

canAddAttachments

boolean

用户生成的数据。如果插件可以向活动添加新附件,则为 true;否则为 false。

DriveEventObject

云端硬盘事件对象是整个事件对象的一部分,其中包含有关用户 Google 云端硬盘及其内容的信息。仅当宿主应用为 Google 云端硬盘时,此字段才会出现在事件对象中。

JSON 表示法
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
字段
selectedItems[]

object (DriveItemMetadata)

在云端硬盘中选择的内容(文件或文件夹)列表。

activeCursorItem

object (DriveItemMetadata)

当前处于活跃状态的云端硬盘内容。

DriveItemMetadata

云端硬盘内容对象包含特定云端硬盘内容(例如文件或文件夹)的相关信息。

JSON 表示法
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
字段
id

string

所选商品的 ID。

iconUrl

string

代表所选项的图标的网址。

mimeType

string

所选项的 MIME 类型。

title

string

所选项的标题。

addonHasFileScopePermission

boolean

如果为 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

string

当前打开的 Gmail 邮件的 ID。

threadId

string

当前打开的 Gmail 会话串 ID。

accessToken

string

Gmail 专用访问令牌。您可以将此令牌与 GmailApp.setCurrentMessageAccessToken(accessToken) 方法搭配使用,以便向插件授予对用户当前打开的 Gmail 邮件的临时访问权限,或让插件撰写新草稿。

toRecipients[]

string

默认处于停用状态。插件正在撰写的草稿中当前包含的“收件人:”收件人邮箱列表。如需启用此字段,您必须在清单中将 addOns.gmail.composeTrigger.draftAccess 字段设置为 METADATA。

ccRecipients[]

string

默认处于停用状态。插件正在撰写的草稿中当前包含的“抄送:”收件人邮箱列表。如需启用此字段,您必须在清单中将 addOns.gmail.composeTrigger.draftAccess 字段设置为 METADATA。

bccRecipients[]

string

默认处于停用状态。插件正在撰写的草稿中当前包含的“密送:”收件人邮箱列表。如需启用此字段,您必须在清单中将 addOns.gmail.composeTrigger.draftAccess 字段设置为 METADATA。

SheetsEventObject

Google 表格事件对象是整个事件对象的一部分,其中包含有关用户文档及其内容的信息。仅当插件扩展了 Google 表格时,此字段才会出现在事件对象中。

JSON 表示法
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
字段
id

string

仅在用户已授权 https://www.googleapis.com/auth/drive.file 范围时才会显示。在 Google 表格界面中打开的电子表格的 ID。

title

string

仅在用户已授权 https://www.googleapis.com/auth/drive.file 范围时才会显示。在 Google 表格界面中打开的电子表格的标题。

addonHasFileScopePermission

boolean

如果为 true,则表示插件已请求并收到在 Google 表格界面中打开的电子表格的 https://www.googleapis.com/auth/drive.file 范围授权;否则,此字段为 false。

matchedUrl

object (MatchedUrl)

仅在满足以下条件时才会显示:

  • https://www.googleapis.com/auth/workspace.linkpreview已获得用户授权。
  • 网址与 LinkPreviewTriggers 触发器中指定的主机格式匹配。

在 Google 表格中生成预览的链接的网址。如需使用此字段,您必须在插件清单中配置 LinkPreviewTriggers。如需了解详情,请参阅包含智能条状标签的预览链接。

用户预览链接 https://www.example.com/12345 时的载荷示例:

"sheets" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

MatchedUrl

随链接预览请求返回的事件对象。

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

string

匹配的网址。

SlidesEventObject

Google 幻灯片事件对象是整个事件对象的一部分,其中包含有关用户文档及其内容的信息。仅当插件扩展了 Google 幻灯片时,它才会出现在事件对象中。

JSON 表示法
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
字段
id

string

仅在用户已授权 https://www.googleapis.com/auth/drive.file 范围时才会显示。在 Google 幻灯片界面中打开的演示文稿的 ID。

title

string

仅在用户已授权 https://www.googleapis.com/auth/drive.file 范围时才会显示。在 Google 幻灯片界面中打开的演示文稿的标题。

addonHasFileScopePermission

boolean

如果为 true,则表示插件已请求并收到在 Google 幻灯片界面中打开的演示文稿的 https://www.googleapis.com/auth/drive.file 范围授权;否则,此字段为 false。

matchedUrl

object (MatchedUrl)

仅在满足以下条件时才会显示:

  • https://www.googleapis.com/auth/workspace.linkpreview已获得用户授权。
  • 网址与 LinkPreviewTriggers 触发器中指定的主机格式匹配。

在 Google 幻灯片中生成预览的链接的网址。如需使用此字段,您必须在插件清单中配置 LinkPreviewTriggers。如需了解详情,请参阅包含智能条状标签的预览链接。

用户预览链接 https://www.example.com/12345 时的载荷示例:

"slides" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

DocsEventObject

Google 文档事件对象是整个事件对象的一部分,其中包含有关用户文档及其内容的信息。仅当插件扩展了 Google 文档时,此字段才会出现在事件对象中。

JSON 表示法
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
字段
id

string

仅在用户已授权 https://www.googleapis.com/auth/drive.file 范围时才会显示。在 Google 文档界面中打开的文档的 ID。

title

string

仅在用户已授权 https://www.googleapis.com/auth/drive.file 范围时才会显示。在 Google 文档界面中打开的文档的标题。

addonHasFileScopePermission

boolean

如果为 true,则表示插件已请求并获得在 Google 文档界面中打开的文档的 https://www.googleapis.com/auth/drive.file 范围授权;否则,此字段为 false。

matchedUrl

object (MatchedUrl)

仅在满足以下条件时才会显示:

  • https://www.googleapis.com/auth/workspace.linkpreview已获得用户授权。
  • 网址与 LinkPreviewTriggers 触发器中指定的主机格式匹配。

在 Google 文档中生成预览的链接的网址。如需使用此字段,您必须在插件清单中配置 LinkPreviewTriggers。如需了解详情,请参阅包含智能条状标签的预览链接。

用户预览链接 https://www.example.com/12345 时的载荷示例:

"docs" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

ChatEventObject

从 Google 服务器发送到插件的 Google Chat 应用事件对象载荷。载荷可用于识别事件类型。

JSON 表示法
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
字段
type

enum (EventType)

事件的类型,仅针对非插件的 Chat 应用中的应用首页事件填充。

user

object (User)

与 Chat 应用互动的用户。

space

object (Space)

事件发生的聊天室,仅针对非插件的 Chat 应用中的应用首页事件填充。

eventTime

string (Timestamp format)

指示事件对象发生时间的时间戳。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

事件对象的载荷。载荷取决于事件对象类型。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
messagePayload

object (MessagePayload)

用户向 Chat 应用发送消息,或在聊天室中 @提及 Chat 应用。应用命令调用(例如斜杠命令和快捷命令)则通过 appCommandPayload 传递。

addedToSpacePayload

object (AddedToSpacePayload)

用户将 Chat 应用添加到 Chat 聊天室,或者 Google Workspace 管理员在私信聊天室中为组织中的用户安装 Chat 应用。

removedFromSpacePayload

object (RemovedFromSpacePayload)

用户从聊天室中移除 Chat 应用。

buttonClickedPayload

object (ButtonClickedPayload)

表示当用户与卡片或对话框的互动元素互动时触发 Action 回调的载荷数据。尽管名称如此,但此载荷会针对所有卡片和对话框 Action 回调进行填充,不仅包括按钮点击,还包括 onChangeAction 触发器、onClick 操作、CardAction 点击以及对话框提交或取消(SUBMIT_DIALOG 和 CANCEL_DIALOG)。

如果用户与对话框互动,ButtonClickedPayload 的 isDialogEvent 字段会设置为 true,并包含 DialogEventType。

完整载荷还包括 commonEventObject.formInputs 和 commonEventObject.parameters。

widgetUpdatedPayload

object (WidgetUpdatedPayload)

用户更新了信息流内卡片或对话框中的微件。

完整载荷还包含 CommonEventObject.parameters['autocomplete_widget_query']。

appCommandPayload

object (AppCommandPayload)

用户调用应用命令。

systemCommandPayload

object (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)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
字段
space

object (Space)

必需。发生事件对象的 Chat 聊天室。

message

object (Message)

触发事件对象的消息。

configCompleteRedirectUri

string

可选。用户在 Google Chat 之外完成授权或配置流程后,Chat 应用应将用户重定向到的网址。如需了解详情,请参阅将 Chat 应用与其他服务和工具关联。

AddedToSpacePayload

用户将 Chat 应用添加到聊天室,或者在应用和用户之间创建私信。

JSON 表示法
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
字段
space

object (Space)

必需。发生事件对象的 Chat 聊天室。

interactionAdd

boolean

应用是否通过用户互动(例如,通过 @ 提及 Chat 应用或使用斜杠命令调用)添加到聊天室。如果此字段设置为 true,则会有一个与互动本身关联的单独事件对象分派到 Chat 应用。

configCompleteRedirectUri

string

可选。用户在 Google Chat 之外完成授权或配置流程后,Chat 应用应将用户重定向到的网址。如需了解详情,请参阅将 Chat 应用与其他服务和工具关联。

RemovedFromSpacePayload

用户从聊天室中移除 Chat 应用。

JSON 表示法
{
  "space": {
    object (Space)
  }
}
字段
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)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
字段
space

object (Space)

必需。发生事件对象的 Chat 聊天室。

message

object (Message)

触发事件对象的消息。

isDialogEvent

boolean

对于 ButtonClicked 和 Message 事件对象,用户是否正在与对话框互动或即将与其互动。

dialogEventType

enum (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)
  }
}
字段
space

object (Space)

必需。发生事件对象的 Chat 聊天室。

AppCommandPayload

用户调用应用命令。

JSON 表示法
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
字段
appCommandMetadata

object (AppCommandMetadata)

为应用命令(包括斜杠命令和快速命令)填充。

space

object (Space)

可选。发生事件对象的 Chat 聊天室。

thread

object (Thread)

可选。发生事件对象的线程(如果适用)。如果事件对象与特定邮件或会话有关联,则系统会填充此字段。

message

object (Message)

可选。触发事件对象的消息(如果适用)。此字段仅针对斜杠命令进行填充。

configCompleteRedirectUri

string

可选。用户在 Google Chat 之外完成授权或配置流程后,应重定向到的网址。如需了解详情,请参阅将 Chat 应用与其他服务和工具关联。

isDialogEvent

boolean

可选。用户是否正在或即将与对话框互动。

dialogEventType

enum (DialogEventType)

可选。收到的对话事件对象的类型。此字段仅在 isDialogEvent 为 true 时适用。

AppCommandMetadata

有关 Chat 应用命令的元数据。

JSON 表示法
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
字段
appCommandId

integer

在 Chat API 配置中指定的命令的 ID。

appCommandType

enum (AppCommandType)

Chat 应用命令的类型。

AppCommandType

Chat 应用命令的类型。如需了解详情,请参阅 Chat 应用命令的类型。

枚举
APP_COMMAND_TYPE_UNSPECIFIED 默认值。未指定。
SLASH_COMMAND 斜杠命令。用户在聊天消息中发送命令。
QUICK_COMMAND 快速命令。用户从消息回复区域的 Chat 菜单中选择该命令。
MESSAGE_ACTION 消息操作。用户从 Chat 中的消息上下文菜单中选择该命令。

SystemCommandPayload

用户调用系统命令。

JSON 表示法
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
字段
systemCommandMetadata

object (SystemCommandMetadata)

所调用的系统命令的相关元数据。

space

string

可选。发生事件对象的 Chat 聊天室。

thread

object (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)
  }
  // End of mutually exclusive fields.
}
字段
调用的系统命令。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
cancelStream

object (CancelStream)

用于取消活跃流消息的命令。

互斥字段结束。

CancelStream

用于取消活跃流消息的命令。

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

string

必需。执行了取消命令的流消息的资源名称。

格式:spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange 传递给工作流插件的事件对象。

JSON 表示法
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
字段
executionMetadata

object (ExecutionMetadata)

有关工作流执行的元数据。

triggerEventSource

enum (TriggerEventSource)

触发事件的来源。

工作流事件载荷的类型。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
actionInvocation

object (ActionInvocation)

调用工作流操作。

triggerCreation

object (TriggerCreation)

创建工作流触发器。

triggerDeletion

object (TriggerDeletion)

删除工作流触发器。

resourceRetrieval

object (ResourceRetrieval)

检索资源(用于变量膨胀)。

elementConfiguration

object (ElementConfiguration)

工作流元素的配置。

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

检索资源支持的字段定义。

elementUiAutocomplete

object (ElementUiAutocomplete)

针对当前呈现的卡片的自动补全建议。

互斥字段结束。

ActionInvocation

调用工作流操作。

JSON 表示法
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
字段
inputs

map (key: string, value: object (VariableData))

以输入变量名称为键的输入变量映射。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

triggerId

string

用于异步操作响应的触发器 ID。

flowLevelContext

object (FlowLevelContext)

可选。来自前面步骤的流级上下文。

VariableData

表示变量数据,可包含不同类型的多个值。

JSON 表示法
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
字段
booleanValues[]

boolean

布尔值。

integerValues[]

string (int64 format)

整数值。

floatValues[]

number

浮点值。

stringValues[]

string

字符串值。

timestampValues[]

string (Timestamp format)

时间戳值。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

resourceReferences[]

object (ResourceReference)

资源引用(ID)。

emailAddressValues[]

string

邮箱值。

googleUserValues[]

string

Google 用户值,格式为 users/{user}。

textFormatValues[]

object (WorkflowTextFormat)

工作流文本格式值。

ResourceReference

应用特定资源的 ID 值。

JSON 表示法
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
字段
resourceType

object (ResourceType)

此 ID 指向的资源类型。

resourceId

string

资源的 ID。

ResourceType

自定义资源类型的名称。

JSON 表示法
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
字段
workflowBundleId

string

拥有此资源类型的工作流软件包的 ID。此字段为可选字段,如果留空,则会被视为与使用它的 bundle 相同。

workflowResourceDefinitionId

string

资源的唯一标识符。此 ID 只需在同一软件包中保持唯一。

WorkflowTextFormat

包含丰富格式选项(包括样式、超链接和互动元素)的文本块。

JSON 表示法
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
字段
textFormatElements[]

object (TextFormatElement)

文本格式元素的集合。

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 (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
字段
表示几种可能的文本格式元素之一的元素。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
text

string

文本格式的文本。

chip

object (Chip)

文本格式的可点击条状标签。

styledText

object (StyledText)

文本格式的样式化文本。

listContainer

object (ListContainer)

文本格式的列表容器。

互斥字段结束。

条状标签

文本格式的可点击条状标签。

JSON 表示法
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
字段
icon

object (Icon)

条状标签中显示的图标。

label

string

条状标签中显示的文本。

url

string

点击条状标签后要导航到的网址。

图标

条状标签中的图标。

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

string

显示托管在 HTTPS 网址上的自定义图标。

例如:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

支持的文件类型包括 .png 和 .jpg。

materialIconName

string

Google Material 图标中定义的图标名称,例如 check_box。任何无效名称都会被舍弃并替换为空字符串,从而导致图标无法呈现。

互斥字段结束。

StyledText

具有粗体、斜体和颜色等样式的文本元素。

JSON 表示法
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
字段
text

string

文本的主要内容。

styles[]

enum (Style)

应用于文本的样式集合。

fontWeight

enum (FontWeight)

文本的字体粗细。

color

object (Color)

文本的颜色。

wrapStyle

enum (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 无换行样式。

ListContainer

列表项的容器,其中每个列表项可以包含多个 TextFormatElement。

JSON 表示法
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
字段
listNestLevel

string (int64 format)

列表的嵌套级别。从 0 开始(表示顶层),然后每个嵌套列表递增 1。

listType

enum (ListType)

列表的类型。

listItems[]

object (ListItem)

列表项的集合。

ListType

不同列表类型的枚举。

枚举
LIST_TYPE_UNSPECIFIED 未指定列表类型。请勿使用。
ORDERED 有序列表。
UNORDERED 无序列表。
BLOCKQUOTE 表示一个引用块列表。

ListItem

列表项。

JSON 表示法
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
字段
textFormatElements[]

object (TextFormatElement)

文本格式元素的集合。

FlowLevelContext

包含前面步骤输出的流级上下文。

JSON 表示法
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
字段
stepContexts[]

object (StepContext)

可选。前面的步骤列表。顺序很重要,因此请确保此列表中保持执行顺序。

StepContext

流级上下文的步骤上下文元数据和输出。

JSON 表示法
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
字段
stepId

string

可选。工作流图表中步骤的唯一 ID。

outputs

map (key: string, value: object (VariableData))

可选。此步骤生成的输出变量的映射,以变量名称为键。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

TriggerCreation

创建工作流触发器。

JSON 表示法
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
字段
triggerId

string

创建期间提供的触发器的唯一标识符。

triggerType

enum (TriggerType)

触发器类型。

inputs

map (key: string, value: object (VariableData))

以输入变量名称为键的输入变量映射。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

notifyUri

string

触发器触发时将调用的端点。

TriggerType

触发器类型。

枚举
TRIGGER_TYPE_UNDEFINED 默认值。请勿使用。
REPEATING 每当满足输入条件时,触发器就会触发。

TriggerDeletion

删除工作流触发器。

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

string

创建期间提供的触发器的唯一标识符。

ResourceRetrieval

检索资源。

JSON 表示法
{
  "resourceReference": {
    object (ResourceReference)
  }
}
字段
resourceReference

object (ResourceReference)

要检索的资源的类型和 ID。

ElementConfiguration

配置工作流元素时调用。

JSON 表示法
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
字段
inputs

map (key: string, value: object (VariableData))

输入变量的映射,以输入变量名称为键。此映射可能为空。在工作流首页中配置单个工作流元素(触发器或操作)时使用。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

displayDestination

enum (DisplayDestination)

元素配置卡片的目标页面。元素可以使用此字段根据目标平台返回不同的配置卡片布局。

nodeId

string

正在呈现的基元配置的节点 ID。

workflowId

string

正在呈现的原语配置的工作流 ID。

availableVariables[]

object (VariableReference)

可用变量按节点位置排序。

DisplayDestination

指明返回元素配置卡片的显示位置。

枚举
DISPLAY_DESTINATION_UNSPECIFIED 默认值。请勿使用。
DISPLAY_DESTINATION_SIDE_PANEL 配置卡片将显示在侧边栏中。
DISPLAY_DESTINATION_FULL_SCREEN 配置卡片将显示在全屏应用中。

VariableReference

对工作流中变量的变量引用。

JSON 表示法
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
字段
parentElementId

string

生成变量的元素的基元 ID。如果需要,我们可以将其扩展为 WorkflowElement 或更详细的元数据 proto。

nodeId

string

节点引用 ID

path

string

变量选择器路径签名

dataType

object (DataType)

变量数据类型

iconUrl

string

生成此变量的原语的图标网址。

stepNumber

integer

生成此变量的原语的步骤编号。

descriptionText

string

变量的说明。

displayText

string

变量条状标签的显示文本。

DataType

变量的类型。

JSON 表示法
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
字段
valueMetadata

object (ValueMetadata)

有关变量潜在值的元数据。

数据类型。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
basicType

enum (BasicType)

基本数据类型。

resourceType

object (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 (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
字段
enumValues[]

string

可选。指定字符串的允许值。只有当 DataType 为 STRING 时,才能设置此字段。

dynamicTypes[]

enum (BasicType)

可选。指定可为变量动态转换的允许类型。仅当 DataType 为 String 且变量为输出时,才能设置此项。

semanticDescriptors[]

object (SemanticDescriptor)

可选。有助于描述变量的语义。

dynamicSchema

object (DynamicSchema)

可选。用于动态解析此变量架构的配置。

defaultValue

string

可选。指定此变量默认值的字符串。例如,对于布尔值,defaultValue 可以设置为 true 或 false。

SemanticDescriptor

有关变量语义的元数据。

JSON 表示法
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
字段
resourceAttribute

string

表示变量对应于资源的特定属性。这对于表示资源标识符(ID、网址、密钥等)的变量尤其有用。

建议采用以下格式:- "{brand}/{appName}/{resource}:{attribute}" {brand} 是可选的,如果与 {appName} 相同,则应省略。

示例:- "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" 等。

客户端将使用此信息向用户提示哪些输出变量与特定输入兼容。

disallowedResourceAttributes[]

string

可选。仅适用于输入,对于输出则会被忽略。与此语义描述符对应的禁止属性。客户端会明确阻止为与这些不允许的资源属性对应的输出选择变量。

DynamicSchema

用于在运行时动态解析此变量架构的配置。

JSON 表示法
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
字段
requiredInputIds[]

string

必须先提供同级输入变量的 ID,然后才能动态解析此变量的架构。

strictEnum

boolean

如果为 true,则变量的值必须与动态解析的枚举值之一匹配。如果为 false,则动态解析的值会被视为非严格建议。

ResourceFieldsDefinitionRetrieval

检索资源支持的字段的定义。

JSON 表示法
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
字段
elementId

string

指定要提取其动态资源架构的元素的 ID。

inputs

map (key: string, value: object (VariableData))

这包括提供变量的节点的字段输入。以输入变量名称为键的输入变量映射。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

ElementUiAutocomplete

针对当前呈现的卡片的自动补全建议。

JSON 表示法
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
字段
query

string

要自动补全的查询。

inputs

map (key: string, value: object (VariableData))

以输入变量名称为键的输入变量映射。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

invokedFunction

string

与微件关联的被调用函数。

resourceId

string

应自动补全的资源 ID。此字段为可选字段,可能未设置。

operationId

string

提供要自动补全的资源的操作的 ID。此字段为可选字段,可能未设置。

ExecutionMetadata

有关工作流执行的元数据。

JSON 表示法
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
字段
versionId

integer

所调用的工作流元素的版本。

timeZone

string

要保存的工作流的时区,例如“America/Los_Angeles”。

stepNumber

integer

表示所调用基元的步骤编号。

TriggerEventSource

触发此执行的触发器事件的来源。

枚举
TRIGGER_EVENT_SOURCE_UNSPECIFIED 默认值。请勿使用。
TRIGGER_EVENT_SOURCE_AUTOMATED 执行由事件自动触发。
TRIGGER_EVENT_SOURCE_TEST_RUN 执行由测试运行触发。