构建 Google 日历界面

当用户查看或修改日历和日历活动时，Google Workspace 插件可以提供自定义界面。这样，您就可以向用户提供其他相关信息、自动执行任务，以及将第三方系统连接到 Google 日历。

为 Google 日历构建插件界面时，您可以提供首页。您可以为多个主机使用同一个主页，也可以为 Google 日历设计一个主页。

您的插件还可以定义一个界面，在用户打开日历活动时显示。

访问插件界面

根据打开方式，Google Workspace 插件可以定义首页界面、Google 日历活动界面、附件选择界面或同时定义这三种界面：

  • 如果用户在日历视图中点击插件图标，插件会执行相应的 calendar.homepageTrigger 函数（如果存在）。此函数会构建首页卡片并将其返回到 Google 日历以供显示。如果未定义 calendar.homepageTrigger 函数，则改为显示通用首页卡片。
  • 如果用户打开日历活动并点击插件图标，或者插件在用户打开活动时打开，则插件会执行相应的 eventOpenTrigger 函数（如果存在）。此函数会构建插件的日历活动界面，并返回 Google 日历进行显示。
  • 如果该插件定义了 eventAttachmentTrigger 函数，当用户在编辑日历活动时点击添加附件时，该插件会显示为附件提供程序。选择插件后，eventAttachmentTrigger 函数会构建插件的附件选择界面，并将其返回 Google 日历以供显示。

构建日历插件界面

您可以使用 Google Workspace 插件扩展 Google 日历的功能，具体步骤如下：

  1. 确定您是否希望插件具有特定于日历的首页。 此外，您还需要决定是否要在用户修改日历活动时提供自定义界面。
  2. 将适当的 addOns.common 和 addOns.calendar 字段添加到插件脚本项目清单中，包括所需的任何范围。
  3. 如果您要提供特定于日历的首页，请实现 calendar.homepageTrigger 函数来构建此接口。您还可以选择对多个 Google Workspace 主机使用 common.homepageTrigger 接口。
  4. 如果您提供的是日历活动接口，则必须实现 calendar.eventOpenTrigger 函数来构建此接口。如需了解详情，请参阅扩展日历活动界面。
  5. 实现响应用户的界面交互（例如按钮点击）所需的关联回调函数。

日历首页

Google 日历支持显示 Google Workspace 插件首页。 如需在 Google 日历中显示插件的通用主页，只需确保插件清单中有 addOns.calendar 字段即可。

或者，将 calendar.homepageTrigger 添加到插件清单中，以提供日历专用首页。

无论哪种情况，您都必须在插件的脚本项目中提供首页触发器函数的名称。在需要时，系统会自动调用此函数以构建 Google 日历首页。您必须实现此函数，以构建和返回构成首页的单个 Card 或 Card 对象的数组。系统向首页触发器函数传递事件对象作为参数，其中包含客户端平台等一些常规信息。您可以使用事件对象数据来定制首页的构建。

扩展日历活动界面

Google 日历依靠内容相关触发器来确定当用户修改日历活动时要显示的界面（如果有）。当触发器触发时，会执行插件清单中的 calendar.eventOpenTrigger 字段指定的上下文触发器函数。

您必须实现 calendar.eventOpenTrigger 字段中指定的函数。此函数接受事件对象作为参数，并且必须返回单个 Card 对象或 Card 对象数组，这样 Google 日历才能在用户打开活动时显示。

事件对象

当用户打开日历活动时，系统会创建一个事件对象，并将其传递给 calendar.eventOpenTrigger 上下文触发器函数。触发器函数可以使用此事件对象中的信息来确定如何构建插件卡片或控制插件行为。此外，系统还会在首次打开插件以及用户点击或选择互动式 widget 时创建事件对象，并将其传递给 homepageTrigger 函数。

事件对象中介绍了事件对象的完整结构。当日历是此插件的代理托管应用时，上下文触发器和微件互动事件对象会包含日历活动对象字段，该字段包含日历专用客户端信息。

更新日历活动

除了在用户打开日历活动进行修改时触发的上下文 calendar.eventOpenTrigger，您还可以定义在用户更新并保存日历活动时触发的 calendar.eventUpdateTrigger。此触发器仅在用户进行以下一项或多项修改时触发：

  • 添加一位或多位参加者。
  • 删除一位或多位参加者。
  • 添加或切换到其他会议解决方案。

当此触发器触发时，它会执行 calendar.eventUpdateTrigger 清单字段指定的触发器函数。该函数会在日历活动修改保存之前执行。

calendar.eventUpdateTrigger 通常用于执行以下一项或多项操作：

  • 更新插件的日历活动界面，以响应用户对日历活动的更改。
  • 将日历活动数据与第三方系统（例如连接到 Google 日历的会议系统）同步。

如果您需要使用插件调整日历活动的数据（例如参加者列表），则必须将插件的 calendar.currentEventAccess 清单字段设置为 WRITE 或 READ_WRITE。这还要求该插件具有 https://www.googleapis.com/auth/calendar.addons.current.event.write 范围。

添加会议解决方案

会议解决方案代表第三方会议选项，用户可以将其附加到 Google 日历活动。第三方会议概览文档详细介绍了如何构建用于添加新会议解决方案的插件。您无需为此类扩展程序构建界面；添加的解决方案只是以选项的形式显示在 Google 日历活动界面的下拉菜单中。