当用户查看或修改日历和日历活动时,Google Workspace 插件可以提供自定义界面。这样,您就可以向用户提供其他相关信息、自动执行任务,以及将第三方系统连接到 Google 日历。
为 Google 日历构建插件接口时,您可以提供首页。您可以为多个主持人使用同一首页,也可以为 Google 日历设计一个专用首页。
您的插件还可以定义在用户打开日历活动时显示的界面。
访问插件界面
根据打开方式,Google Workspace 插件可以定义首页界面、Google 日历活动界面、附件选择界面,或这三者中的任意一个:
- 如果用户在日历视图中点击插件图标,插件会执行相应的
calendar.homepageTrigger
函数(如果有)。此函数会构建并返回一个首页卡片,以便返回到 Google 日历进行显示。如果未定义calendar.homepageTrigger
函数,系统会改为显示通用首页卡片。 - 如果用户打开日历活动,然后点击插件图标,或者在用户打开活动时插件处于打开状态,插件会执行相应的
eventOpenTrigger
函数(如果有)。此函数会构建该插件的日历活动界面,并返回 Google 日历进行显示。 - 如果该插件定义了
eventAttachmentTrigger
函数,那么当用户在修改日历活动时点击添加附件时,该插件会显示为附件提供程序。选择该插件后,eventAttachmentTrigger
函数会构建该插件的附件选择界面,并将其返回给 Google 日历以进行显示。
构建插件日历界面
您可以按照以下步骤使用 Google Workspace 插件扩展 Google 日历的功能:
- 确定您是否希望您的插件具有专门针对 Google 日历的首页。此外,还要决定是否要在用户修改日历活动时提供自定义界面。
- 将适当的
addOns.common
和addOns.calendar
字段添加到插件脚本项目清单,包括所需的所有范围。 - 如果您要提供专门的日历首页,请实现
calendar.homepageTrigger
函数以构建此界面。您还可以选择为多个 Google Workspace 主机使用common.homepageTrigger
界面。 - 如果您要提供日历事件接口,则必须实现
calendar.eventOpenTrigger
函数来构建此接口。如需了解详情,请参阅扩展 Google 日历事件接口。 - 实现响应用户界面互动(例如按钮点击)所需的关联回调函数。
日历首页
Google 日历支持显示 Google Workspace 插件首页。
如需在 Google 日历中显示您的插件通用首页,只需确保插件的清单中包含 addOns.calendar
字段即可。
或者,您也可以向插件清单添加 calendar.homepageTrigger
,以提供专门针对 Google 日历的首页。
无论是哪种情况,您都必须在插件脚本项目中提供首页触发器函数的名称。系统会在需要时自动调用此函数来构建 Google 日历首页。您必须实现此函数,以构建并返回一个 Card
或一个由 Card
对象组成的首页数组。系统会将事件对象作为参数传递给首页触发器函数,其中包含一些常规信息,例如客户端的平台。您可以使用事件对象数据来量身定制首页的构建方式。
扩展日历活动接口
Google 日历依赖于上下文触发器来确定在用户修改日历活动时显示哪个界面(如果有)。触发器触发时,它会执行插件清单中的 calendar.eventOpenTrigger
字段指定的内容相关触发器函数。
您必须实现 calendar.eventOpenTrigger
字段中命名的函数。此函数接受 event 对象作为参数,并且必须返回单个 Card
对象或 Card
对象数组,以便 Google 日历在用户打开活动时显示。
事件对象
当用户打开 Google 日历活动时,系统会创建一个事件对象并将其传递给 calendar.eventOpenTrigger
情境触发器函数。触发器函数可以使用此事件对象中的信息来确定如何构建插件卡片或控制插件行为。在首次打开插件以及用户点击或选择 Interactive Widget 时,系统也会创建事件对象并将其传递给 homepageTrigger
函数。
事件对象中介绍了事件对象的完整结构。当日历是插件的实时托管应用时,情境触发器和微件互动事件对象包含包含日历专用客户端信息的 Calendar 事件对象字段。
更新日历活动
除了在用户打开日历活动以进行修改时触发的上下文 calendar.eventOpenTrigger
之外,您还可以定义在用户更新和保存日历活动时触发的 calendar.eventUpdateTrigger
。只有当用户进行以下一项或多项修改时,此触发器才会触发:
- 添加一个或多个参加者。
- 移除一位或多位参加者。
- 添加或改用其他会议解决方案。
当此触发器触发时,它会执行 calendar.eventUpdateTrigger
清单字段指定的触发器函数。该函数会在保存日历活动修改内容之前执行。
calendar.eventUpdateTrigger
通常用于执行以下一项或多项操作:
- 更新插件日历活动界面,以响应用户对日历活动所做的更改。
- 将日历活动数据同步到第三方系统,例如与 Google 日历关联的会议系统。
如果您需要让插件调整 Google 日历活动的数据(例如参加者名单),则必须将插件 calendar.currentEventAccess
清单字段设置为 WRITE
或 READ_WRITE
。这还要求该插件具有 https://www.googleapis.com/auth/calendar.addons.current.event.write
scope。
添加会议解决方案
会议解决方案是指用户可以附加到 Google 日历活动的第三方会议选项。第三方会议概览文档详细介绍了如何构建用于添加新会议解决方案的插件。您无需为此类扩展程序构建界面;添加的解决方案只会作为选项显示在 Google 日历活动界面的下拉菜单中。