事件对象

本页面概述了 Google Workspace 插件事件对象的结构。

事件对象是 JSON 结构，当用户与插件互动时，系统会自动构建这些结构并将其作为参数传递给触发器或回调函数。事件对象会将有关宿主应用和当前上下文的客户端信息传递给插件的服务器端回调函数。

Google Workspace 插件会在以下位置使用事件对象：

  • 首页触发器。 当首页触发器函数触发时，系统会自动将一个事件对象传递给您定义的每个 homepageTrigger 函数。您可以在首页触发器函数中使用此对象来识别活跃的主机应用、客户端平台、用户语言区域和其他信息。

    在首页触发器触发时创建的事件对象不包含其他情况中包含的所有字段；与 widget 和上下文信息相关的字段会被省略。

  • 情境触发器。 每个托管应用都提供一组不同的情境触发器，这些触发器会在用户进入特定情境时触发：

    当情境触发器触发时，托管应用会调用插件清单中列出的相应 runFunction，并向其传递一个事件对象作为参数。在情境触发器触发时创建的事件对象包含首页触发器事件对象中包含的所有字段，以及包含情境信息的字段。

  • 微件操作。事件对象使用 Gmail 插件使用的相同操作模型提供微件互动。Google Workspace 插件使用相同的小部件处理程序函数、Action 对象和操作响应。在 Google Workspace 插件中，操作事件对象包含回调函数可以执行的更多信息。

    通过 widget 操作创建的事件对象包含情境触发器事件对象中包含的所有字段，以及包含 widget 信息的字段。

  • 预览链接触发器。 在 Google 文档、表格和幻灯片中，您可以根据特定网址格式为第三方服务配置链接预览。当用户与符合该模式的链接互动时，linkPreviewTriggers 会触发，并且包含该链接的事件对象会传递给触发器的回调函数。您的插件可以使用此事件对象来构建智能条状标签和卡片，以便在托管应用中显示有关链接的信息。您还可以构建微件操作，以便用户可以与预览卡片及其内容进行互动。

  • Google Chat 应用触发器。 在 Google Chat 中，您的插件会作为 Chat 应用显示给用户，用户可以通过将其添加到聊天室、发送消息、使用斜杠命令等方式与其互动。如需构建互动功能，您需要设置并使用各种 Chat 应用触发器。每个触发器都会发送不同的事件对象载荷，以帮助您处理或响应每种类型的互动。

事件对象结构

下表介绍了 Google Workspace 插件事件对象的顶级结构。该结构包含一个 commonEventObject 顶级字段，用于存储与主机无关的信息。每个事件对象还可以具有以下特定于宿主应用的顶级字段之一，具体取决于活跃宿主应用：gmailEventObject、calendarEventObject 或 driveEventObject。

为了向后兼容，Google Workspace 插件事件对象包含 Gmail 插件操作事件对象中使用的原始字段。这些字段位于“原始 Gmail 插件字段”下，不属于 commonEventObject。

原始 Gmail 插件字段已弃用。在开发或迁移 Google Workspace 插件时，请改用较新的事件对象结构。这些字段可能会在未来的更新中移除。

事件对象
eventObject.commonEventObject Common fields object
一个包含所有事件对象通用信息的对象，无论托管应用是什么。
eventObject.calendar Calendar event object
仅当调用主机为 Google 日历时才会显示。一个包含日历和活动信息的对象。
eventObject.chat Chat event object
仅当发起通话的主机是 Google Chat 时才会显示。一个包含 Chat 信息的对象。
eventObject.drive Drive event object
仅当调用主机为 Google 云端硬盘时才会显示。包含云端硬盘信息的对象。
eventObject.gmail Gmail event object
仅当调用主机为 Gmail 时才会显示。一个包含 Gmail 信息的对象。
eventObject.docs Docs event object
仅当调用主机为 Google 文档时才会显示。一个包含 Google 文档信息的对象。
eventObject.sheets Sheets event object
仅当调用主机为 Google 表格时才会显示。一个包含 Google 表格信息的对象。
eventObject.slides Slides event object
仅当调用主机为 Google 幻灯片时才会显示。一个包含幻灯片信息的对象。
原始 Gmail 插件字段
eventObject.messageMetadata.accessToken string
已弃用。访问令牌。您可以使用此功能，通过临时 Gmail 插件范围启用对用户数据的访问权限。

对于 Google Workspace 插件，请在 eventObject.gmail.accessToken 字段中查找此信息。

eventObject.messageMetadata.messageId string
已弃用。在 Gmail 界面中打开的会话串的邮件 ID。

对于 Google Workspace 插件，请在 eventObject.gmail.messageId 字段中查找此信息。

eventObject.clientPlatform string
已弃用。指明事件的发起点（网站、iOS 或 Android）。

对于 Google Workspace 插件，请在 eventObject.commonEventObject.platform 字段中查找此信息。

eventObject.formInput object
已弃用。卡片中所有表单 widget 的当前值的映射，每个 widget 仅限一个值。键是与 widget 关联的字符串 ID，值是字符串。事件对象提供 formInput，以便您在需要从具有预期单数值的多个 widget（例如文本输入和开关）中读取数据时使用。对于多值微件（例如复选框），请改为从 formInputs 中读取每个值。

对于 Google Workspace 插件，请改为在 eventObject.commonEventObject.formInputs 字段中查找此信息；具有单个值的小组件表示为具有单个元素的数组。

eventObject.formInputs object
已弃用。卡片中微件的当前值的映射，以字符串列表的形式呈现。键是与 widget 关联的字符串 ID。对于单值 widget，该值显示在单元素数组中。对于多值 widget（例如复选框组），所有值都会显示在列表中。

对于 Google Workspace 插件，请在 eventObject.commonEventObject.formInputs 字段中查找此信息。

eventObject.parameters object
已弃用。您使用 Action.setParameters 向 Action 提供的任何其他参数的映射。映射键和值是字符串。

对于 Google Workspace 插件，请在 eventObject.commonEventObject.parameters 字段中查找此信息。

eventObject.userCountry string
已弃用且默认处于停用状态。表示用户所在国家/地区的双字母代码。也可以是数字 UN M49 国家/地区代码。

对于 Google Workspace 插件，请在 eventObject.commonEventObject.userLocale 字段中查找此信息。

eventObject.userLocale string
已弃用且默认处于停用状态。表示用户语言的双字母 ISO 639 代码。如需了解详情，请参阅访问用户语言区域和时区。

对于 Google Workspace 插件，请在 eventObject.commonEventObject.userLocale 字段中查找此信息。

eventObject.userTimezone.id string
已弃用且默认处于停用状态。用户所在时区的 时区标识符。例如，America/New_York、Europe/Vienna 和 Asia/Seoul 都指向同一网页。如需了解详情，请参阅 访问用户语言区域和时区。

对于 Google Workspace 插件，请在 eventObject.commonEventObject.timeZone.id 字段中查找此信息。

eventObject.userTimezone.offset string
已弃用且默认处于停用状态。用户时区 相对于世界协调时间 (UTC) 的时间偏移量，以毫秒为单位。如需了解详情，请参阅 访问用户语言区域和时区。

对于 Google Workspace 插件，请在 eventObject.commonEventObject.timeZone.offset 字段中查找此信息。

常见事件对象

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

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

常见事件对象字段
commonEventObject.platform string
指明事件的发起点（“WEB”“IOS”或“ANDROID”）。
commonEventObject.formInputs object
一个映射，其中包含所显示卡片中微件的当前值。映射键是为每个 widget 分配的字符串 ID。

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

  • 单值 widget（例如文本框）：字符串列表（只有一个元素）。

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

  • 多值 widget（例如复选框组）：字符串列表。

    示例：对于 ID 为 participants 的多值 widget，请使用以下代码访问值数组：e.commonEventObject.formInputs.participants.stringInputs.value。

  • A date-time picker：DateTimeInput object。

    示例：对于 ID 为 myDTPicker 的选择器，请使用 e.commonEventObject.formInputs.myDTPicker.dateTimeInput 访问 DateTimeInput 对象。

  • A date-only picker：DateInput object。

    示例：对于 ID 为 myDatePicker 的选择器，请使用 e.commonEventObject.formInputs.myDatePicker.dateInput 访问 DateInput 对象。

  • A time-only picker：TimeInput object。

    示例：对于 ID 为 myTimePicker 的选择器，请使用 e.commonEventObject.formInputs.myTimePicker.timeInput 访问 TimeInput 对象。
commonEventObject.hostApp string
指明生成事件对象时插件在哪个宿主应用中处于活跃状态。可能的值包括下列项：
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
您使用 actionParameters 或 Action.setParameters 为操作提供的任何其他参数。

开发者预览版： 对于 Google Chat 应用，如需根据用户在多选菜单中输入的内容推荐选项，请使用 "autocomplete_widget_query" 键 (event.commonEventObject.parameters["autocomplete_widget_query"]) 的值。您可以使用此值查询数据库，并在用户输入内容时向其推荐可选项。如需了解详情，请参阅收集和处理 Google Chat 用户的信息。
commonEventObject.userLocale string
默认处于停用状态。用户的语言和国家/地区标识符，格式为 ISO 639 语言代码-ISO 3166 国家/地区代码。例如 en-US。

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

commonEventObject.timeZone string
默认处于停用状态。时区 ID 和偏移量。如需启用此字段，您必须在插件清单中将 addOns.common.useLocaleFromApp 设置为 true。 插件的范围列表还必须包含 https://www.googleapis.com/auth/script.locale。 如需了解详情，请参阅 访问用户语言区域和时区。
commonEventObject.timeZone.id string
用户所在时区的 时区标识符。例如，America/New_York、Europe/Vienna 和 Asia/Seoul 都指向同一网页。如需启用此字段，您必须在插件清单中将 addOns.common.useLocaleFromApp 设置为 true。 插件的范围列表还必须包含 https://www.googleapis.com/auth/script.locale。如需了解详情，请参阅 访问用户语言区域和时区。
commonEventObject.timeZone.offset string
用户时区 相对于世界协调时间 (UTC) 的时间偏移量，以毫秒为单位。如需了解详情，请参阅 访问用户语言区域和时区。

日期时间选择器表单输入

操作回调函数可以在 commonEventObject.formInputs 字段中接收当前 widget 值。这包括用户在日期或时间选择器 widget 中选择的日期或时间值。信息结构因微件配置为日期时间选择器、仅日期选择器还是仅时间选择器而异。 下表介绍了结构差异：

DateTimeInput 对象
dateTimeInput.hasDate 如果输入日期时间包含日期，则为 boolean
true；如果仅包含时间，则为 false。
dateTimeInput.hasTime 如果输入日期时间包含时间，则为 boolean
true；如果仅包含日期，则为 false。
dateTimeInput.msSinceEpoch string
用户选择的时间，以自纪元（世界协调时间 [UTC] 1970 年 1 月 1 日 00:00:00）以来的毫秒数表示。
DateInput 对象
dateInput.msSinceEpoch string
用户选择的时间，以自纪元（世界协调时间 [UTC] 1970 年 1 月 1 日 00:00:00）以来的毫秒数表示。
TimeInput 对象
timeInput.hours number
用户选择的小时数。
timeInput.minutes number
用户选择的分钟数。

Chat 事件对象

Chat 事件对象是整个事件对象中携带用户与 Chat 应用互动相关信息的部分。只有在插件扩展 Google Chat 时，它才会出现在事件对象中。

聊天
chat.user object (User)
与 Chat 应用互动的 Chat 用户。
chat.space object (Space)
用户与 Chat 应用互动的 Chat 聊天室。
chat.eventTime

string (Timestamp format)

互动发生的时间。

联合字段 payload。对于 App Home 触发器（当用户打开 Home 标签页时），系统不会设置 payload，并且 chat 包含 chat.user 和 chat.eventTime。

payload 只能是下列其中一项：
chat.messagePayload

object (MessagePayload)

Chat 应用从消息触发器接收的载荷。
chat.addedToSpacePayload

object (AddedToSpacePayload)

Chat 应用从已添加到聊天室触发器接收的载荷。
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Chat 应用从从聊天室中移除触发器接收的载荷。
chat.buttonClickedPayload

object (ButtonClickedPayload)

用户点击消息或卡片中的按钮时，Chat 应用收到的载荷。如果用户点击按钮提交信息，commonEventObject.formInputs 对象会包含从用户那里收集的值。如需了解详情，请参阅 从 Google Chat 用户处收集信息。
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

当用户在 selectionInput widget 的多选菜单中输入文本时，Chat 应用收到的载荷。Chat 应用可以使用此事件对象从动态数据源填充建议的项目。例如，如需从外部数据源填充支持请求，Chat 应用可以根据用户在菜单中输入的内容查询数据源，然后将匹配的支持请求作为可选项返回。

CommonEventObject.parameters['autocomplete_widget_query'] 对象包含用户在菜单中输入的字符串值。

chat.appCommandPayload

object (AppCommandPayload)

用户使用 Chat 应用中的命令时，Chat 应用收到的载荷。

载荷

根据 Chat 应用互动类型，事件包含一个或多个 Chat API 资源的载荷。

消息载荷
MessagePayload
chat.messagePayload.message object (Message)
触发事件的聊天消息。
chat.messagePayload.space object (Space)
用户在其中发送了调用 Chat 应用的消息的 Chat 聊天室。
chat.messagePayload.configCompleteRedirectUri string
用户在 Google Chat 之外完成授权或配置流程后，Chat 应用应将用户重定向到的网址。如需了解详情，请参阅将 Google Workspace 插件与第三方服务相关联。
添加到聊天室载荷
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
用户在其中添加或安装 Chat 应用的 Chat 聊天室。

当管理员安装 Chat 应用时，space.adminInstalled 字段会设置为 true。
chat.addedToSpacePayload.interactionAdd boolean
用户是否使用消息将 Chat 应用添加到聊天室。例如，@提及 Chat 应用或使用命令。 如果为 true，Chat 会发送另一个事件对象，其中包含一个 messagePayload，其中包含有关消息的信息。
chat.addedToSpacePayload.configCompleteRedirectUri string
用户在 Google Chat 之外完成授权或配置流程后，Chat 应用应将用户重定向到的网址。如需了解详情，请参阅将 Google Workspace 插件与第三方服务相关联。
从聊天室中移除载荷
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
用户从中移除或卸载 Chat 应用的 Chat 聊天室。

当管理员卸载 Chat 应用时，space.adminInstalled 字段会设置为 false。

按钮点击载荷
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
包含用户点击的按钮的聊天消息。
chat.buttonClickedPayload.space object (Space)
用户在其中点击了 Chat 应用消息中的按钮的 Chat 聊天室。
chat.buttonClickedPayload.isDialogEvent boolean
用户是否点击了按钮来与对话框互动。
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
如果 isDialogEvent 为 true，则为对话中的互动类型。

枚举 DialogEventType。

dialogEventType 的值只能是以下值之一：
TYPE_UNSPECIFIED 默认值。未指定。
REQUEST_DIALOG 用户请求对话框。例如，他们使用命令或点击消息中的按钮。
SUBMIT_DIALOG 用户点击对话框中的互动元素。例如，用户在对话框中填写信息，然后点击按钮提交信息。
微件更新后的载荷
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
发生互动的 Chat 聊天室。
应用命令载荷
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
有关用户使用了哪个命令以及如何触发该命令的元数据。
chat.appCommandPayload.space object (Space)
用户在其中使用命令的 Chat 聊天室。
chat.appCommandPayload.thread object (Thread)
如果互动发生在话题中，则为用户使用命令的 Chat 话题。
chat.appCommandPayload.message object (Message)
对于斜杠命令，则为包含斜杠命令的消息。
chat.appCommandPayload.configCompleteRedirectUri string
如果命令需要授权或配置，则为用户在 Google Chat 之外完成该流程后要重定向到的网址。
chat.appCommandPayload.isDialogEvent boolean
命令是否会打开对话框。
chat.appCommandPayload.dialogEventType enum (DialogEventType)
与对话框的互动类型。

枚举 DialogEventType。

dialogEventType 的值只能是以下值之一：
TYPE_UNSPECIFIED 默认值。未指定。
REQUEST_DIALOG 用户请求对话框。例如，他们使用命令或点击消息中的按钮。
SUBMIT_DIALOG 用户点击对话框中的互动元素。例如，用户在对话框中填写信息，然后点击按钮提交信息。
应用命令元数据
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

命令 ID。
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
命令的类型。

枚举 AppCommandType。

AppCommandType 的值只能是以下值之一：
APP_COMMAND_TYPE_UNSPECIFIED 默认值。未指定。
SLASH_COMMAND 用户通过发送以斜杠 / 开头的消息来使用该命令。
QUICK_COMMAND 用户从消息回复区域的 Chat 菜单中选择该命令。

日历活动对象

日历事件对象是整个事件对象的一部分，其中包含有关用户日历和日历事件的信息。仅当插件扩展了 Google 日历时，此字段才会出现在事件对象中。

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

对于此对象及其子结构中的许多字段，可以直接映射到同名的 Calendar API 事件资源字段。如果字段说明不同，则以下表格中的信息是正确的。

日历活动对象
calendar.attendees[] list of attendee objects
用户生成的数据。日历活动参加者的列表。
calendar.calendarId string
日历 ID。
calendar.capabilities object
用户生成的数据。一个对象，用于描述插件查看或更新活动信息的功能。
calendar.capabilities.canAddAttendees boolean
用户生成的数据。true（如果插件可以向活动参加者列表添加新的参加者）；false（如果插件无法添加）。
calendar.capabilities.canSeeAttendees boolean
用户生成的数据。如果插件可以读取活动参加者列表，则为 true；否则为 false。
calendar.capabilities.canSeeConferenceData boolean
用户生成的数据。如果插件可以读取活动会议数据，则为 true；否则为 false。
calendar.capabilities.canSetConferenceData boolean
用户生成的数据。如果插件可以更新活动会议数据，则为 true；否则为 false。
calendar.capabilities.canAddAttachments boolean
用户生成的数据。true 如果插件可以向活动添加新附件，则为 true； false 否则为 false。
calendar.conferenceData Conference data object
用户生成的数据。一个对象，表示与此活动关联的所有会议数据，例如 Google Meet 会议详细信息。
calendar.id string
事件 ID。
calendar.organizer object
表示活动组织者的对象。
calendar.organizer.email string
活动组织者的邮箱。
calendar.recurringEventId string
周期性活动的 ID。

参加者

Attendee 对象包含有关 Google 日历活动中各个参加者的信息。当且仅当数据存在于日历活动中，并且插件将其 addOns.calendar.currentEventAccess 清单字段设置为 READ 或 READ_WRITE 时，此信息才会出现在活动对象中。

Attendee 对象
attendee.additionalGuests number
参加者表示要额外携带的宾客人数。默认值为 0。
attendee.comment string
参加者的回复评论（如果有）。
attendee.displayName string
参加者的显示名称。
attendee.email string
参加者的邮箱。
attendee.optional 如果此参加者的出席状态标记为可选，则为 boolean
true；否则为 false。
attendee.organizer boolean
true（如果参加者是此活动的组织者）。
attendee.resource boolean如果参加者代表资源（例如会议室或设备），则为
true；否则为 false。
attendee.responseStatus string
参加者的回复状态。可能的值包括下列项：
  • accepted：参加者已接受活动邀请。
  • declined：参加者已拒绝活动邀请。
  • needsAction：参加者尚未回复活动邀请。
  • tentative：参加者已暂时接受活动邀请。
attendee.self boolean如果此参加者代表显示此活动的日历，则为
true；否则为 false。

会议数据

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

会议数据对象
conferenceData.conferenceId string
会议的 ID。此 ID 旨在让应用能够跟踪会议；您不应向用户显示此 ID。
conferenceData.conferenceSolution object
表示会议解决方案（例如 Hangouts 或 Google Meet）的对象。
conferenceData.conferenceSolution.iconUri string
代表此会议解决方案的用户可见图标的 URI。
conferenceData.conferenceSolution.key object
用于唯一标识此活动的会议解决方案的键。
conferenceData.conferenceSolution.key.type string
会议解决方案类型。可能的值包括：
  • eventHangout（面向消费者的 Hangouts，网址为 http://hangouts.google.com）。
  • Google Workspace 用户的传统版 Hangouts (http://hangouts.google.com) 的 eventNamedHangout。
  • hangoutsMeet for Google Meet (http://meet.google.com)。
conferenceData.conferenceSolution.name string
此会议解决方案的用户可见名称（未本地化）。
conferenceData.entryPoints[] list of entry point objects
会议入口点（例如网址或电话号码）的列表。
conferenceData.notes string
要向用户显示的有关会议的其他备注（例如来自网域管理员的说明或法律声明）。可包含 HTML。长度上限为 2048 个字符。
conferenceData.parameters object
一个对象，其中包含供插件使用的已定义参数数据的映射。
conferenceData.parameters.addOnParameters object
参数字符串键和值的映射。 这些键和值由插件开发者定义，用于将信息附加到特定会议以供插件使用。

入口点

入口点对象包含有关访问给定会议的既定方式（例如通过电话或视频）的信息。当且仅当数据存在于日历活动中，并且插件将其 addOns.calendar.currentEventAccess 清单字段设置为 READ 或 READ_WRITE 时，此信息才会出现在活动对象中。

入口点对象
entryPoint.accessCode string
用于访问会议的访问代码。 长度上限为 128 个字符。会议提供商通常仅使用 {accessCode、meetingCode、passcode、password、pin} 的子集来提供对会议的访问权限。匹配并仅显示会议提供商使用的字段。
entryPoint.entryPointFeatures list
入口点的特征。目前，这些功能仅适用于 phone 入口点：
  • toll：入口点是收费电话。
  • toll_free：入口点是免费电话。
entryPoint.entryPointType string
入口点的类型。可能的值如下：
  • more：其他会议加入说明，例如备用电话号码。一个会议只能有一个 more 入口点；如果存在，则还需要至少一个其他类型的入口点。
  • phone：通过电话号码加入会议。一个会议可以有零个或多个 phone 入口点。 Google 日历仅显示前两个电话入口点（按字母顺序设置格式和排序后）。
  • sip：通过 SIP 加入会议。一个会议最多只能有一个 sip 入口点。
  • video：通过 HTTP 加入会议。一个会议最多只能有一个 video 入口点。
entryPoint.label string
入口点 URI 的用户可见标签（未本地化）。
entryPoint.meetingCode string
用于访问会议的会议代码。 长度上限为 128 个字符。会议提供商通常仅使用 {accessCode、meetingCode、passcode、password、pin} 的子集来提供对会议的访问权限。匹配并仅显示会议提供商使用的字段。
entryPoint.passcode string
用于访问会议的密码。 长度上限为 128 个字符。会议提供商通常仅使用 {accessCode、meetingCode、passcode、password、pin} 的子集来提供对会议的访问权限。匹配并仅显示会议提供商使用的字段。
entryPoint.password string
用于访问会议的密码。 长度上限为 128 个字符。会议提供商通常仅使用 {accessCode、meetingCode、passcode、password、pin} 的子集来提供对会议的访问权限。匹配并仅显示会议提供商使用的字段。
entryPoint.pin string
用于访问会议的 PIN 码。 长度上限为 128 个字符。会议提供商通常仅使用 {accessCode、meetingCode、passcode、password、pin} 的子集来提供对会议的访问权限。匹配并仅显示会议提供商使用的字段。
entryPoint.regionCode string
电话号码的地区代码。如果 URI 不包含国家/地区代码，则用户需要此信息。这些值基于公开的 CLDR 地区代码列表。
entryPoint.uri string
入口点的 URI。长度上限为 1300 个字符。格式取决于入口点类型：
  • more：需要 http: 或 https: 架构。
  • phone：需要 tel: 架构。URI 应包含整个拨号序列（例如“tel:+12345678900,,,12345678;1234”）。
  • sip：需要 sip: 或 sips: 架构。例如“sip:12345678@myprovider.com”。
  • video：需要 http: 或 https: 架构。

云端硬盘事件对象

云端硬盘事件对象是整个事件对象的一部分，其中包含有关用户 Google 云端硬盘及其内容的信息。仅当插件扩展了 Google 云端硬盘时，此对象才会出现在事件对象中。

云端硬盘事件对象
drive.activeCursorItem Drive item object
当前处于活跃状态的云端硬盘内容。
drive.selectedItems[] list of Drive item objects
在云端硬盘中选择的内容（文件或文件夹）列表。

云端硬盘内容

云端硬盘内容对象包含有关特定云端硬盘内容（例如文件或文件夹）的信息。

云端硬盘内容对象
item.addonHasFileScopePermission boolean
如果为 true，则插件已请求并收到此内容的 https://www.googleapis.com/auth/drive.file 范围授权；否则，此字段为 false。
item.id string
所选项的 ID。
item.iconUrl string
表示所选项的图标的网址。
item.mimeType string
所选项的 MIME 类型。
item.title string
所选内容的标题。

Gmail 事件对象

Gmail 事件对象是整个事件对象中携带用户 Gmail 邮件相关信息的部分。仅当托管应用为 Gmail 时，此字段才会出现在事件对象中。

Gmail 事件对象
gmail.accessToken string
Gmail 专用访问令牌。 将此令牌与 GmailApp.setCurrentMessageAccessToken 方法结合使用，可向您的插件授予对用户当前打开的 Gmail 邮件的临时访问权限，或让您的插件撰写新草稿。
gmail.bccRecipients[] list of strings
默认处于停用状态。插件正在撰写的草稿中当前包含的“密送：”收件人邮箱列表。如需启用此字段，请将清单中的 addOns.gmail.composeTrigger.draftAccess 字段设置为 METADATA。
gmail.ccRecipients[] list of strings
默认处于停用状态。插件正在撰写的草稿中当前包含的“抄送：”收件人电子邮件地址列表。如需启用此字段，请将清单中的 addOns.gmail.composeTrigger.draftAccess 字段设置为 METADATA。
gmail.messageId string
当前打开的 Gmail 邮件的 ID。
gmail.threadId string
当前打开的 Gmail 会话串 ID。
gmail.toRecipients[] list of strings
默认处于停用状态。插件正在撰写的草稿中当前包含的“收件人：”收件人电子邮件地址列表。如需启用此字段，请将清单中的 addOns.gmail.composeTrigger.draftAccess 字段设置为 METADATA。

Google 文档事件对象

Google 文档事件对象是整个事件对象中携带用户文档及其内容相关信息的部分。仅当插件扩展了 Google 文档时，此对象才会出现在事件对象中。

Google 文档事件对象
docs.id string
仅当用户已授权 https://www.googleapis.com/auth/drive.file 范围时才会显示。
在 Google 文档界面中打开的文档的 ID。
docs.title string
仅当用户已授权 https://www.googleapis.com/auth/drive.file 范围时才会显示。
在 Google 文档界面中打开的文档的标题。
docs.addonHasFileScopePermission boolean
如果为 true，则插件已请求并收到在 Google 文档界面中打开的文档的 https://www.googleapis.com/auth/drive.file 范围授权；否则，此字段为 false。
docs.matchedUrl.url string
仅在满足以下条件时才存在：
  • https://www.googleapis.com/auth/workspace.linkpreview 已获得用户授权。
  • 该网址与 LinkPreviewTriggers 触发器中指定的主机格式匹配。

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

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

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

Google 表格事件对象

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

Google 表格事件对象
sheets.id string
仅在用户已授权 https://www.googleapis.com/auth/drive.file 范围时存在。在 Google 表格界面中打开的电子表格的 ID。
sheets.title string
仅在用户已授权 https://www.googleapis.com/auth/drive.file 范围时存在。在 Google 表格界面中打开的电子表格的标题。
sheets.addonHasFileScopePermission boolean
如果为 true，则插件已请求并收到在 Google 表格界面中打开的电子表格的 https://www.googleapis.com/auth/drive.file 范围授权；否则，此字段为 false。
sheets.matchedUrl.url string
仅在满足以下条件时才存在：
  • https://www.googleapis.com/auth/workspace.linkpreview 已获得用户授权。
  • 该网址与 LinkPreviewTriggers 触发器中指定的主机格式匹配。

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

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

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

Google 幻灯片事件对象

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

Google 幻灯片事件对象
slides.id string
仅在用户已授权 https://www.googleapis.com/auth/drive.file 范围时存在。在 Google 幻灯片界面中打开的演示文稿的 ID。
slides.title string
仅在用户已授权 https://www.googleapis.com/auth/drive.file 范围时存在。在 Google 幻灯片界面中打开的演示文稿的标题。
slides.addonHasFileScopePermission boolean
如果为 true，则插件已请求并收到在幻灯片界面中打开的演示文稿的 https://www.googleapis.com/auth/drive.file 范围授权；否则，此字段为 false。
slides.matchedUrl.url string
仅在满足以下条件时才存在：
  • https://www.googleapis.com/auth/workspace.linkpreview 已获得用户授权。
  • 该网址与 LinkPreviewTriggers 触发器中指定的主机格式匹配。

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

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

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