日历清单资源

用于在 Google 日历中定义 Google Workspace 插件内容和行为的资源配置。如果 Google Workspace 插件清单扩展了 Google 日历,则必须将所有组件都标记为必需

日历

Google 日历扩展程序的 Google Workspace 插件清单配置。如需了解详情,请参阅使用 Google Workspace 插件扩展 Google 日历

JSON 表示法
{
  "createSettingsUrlFunction": string,
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "currentEventAccess": string,
  "eventOpenTrigger": {
    object (EventOpenTrigger)
  },
  "eventUpdateTrigger": {
    object (EventUpdateTrigger)
  },
  "eventAttachmentTrigger": {
    object (EventAttachmentTrigger)
  },
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
字段
createSettingsUrlFunction

string

仅当该插件提供 会议解决方案时使用。 可选。用于生成指向该插件设置页面的网址的 Apps 脚本函数的名称。

如需了解详情,请参阅 添加会议插件设置
conferenceSolution[]

object (ConferenceSolution)

仅当插件提供 会议解决方案时才使用;如果是,则必须定义至少一个解决方案。 该插件提供的会议解决方案列表。每个解决方案都有对应的会议选项,会显示在 Google 日历的修改活动界面中。
currentEventAccess

string

确定该插件对用户生成的数据事件数据的访问权限级别。如果未提供,系统将不会将任何事件元数据传递给插件。 有效的设置如下:

  • METADATA 表示该插件只能访问基本活动元数据。
  • READ 表示该插件除了基本事件元数据之外,还可以读取用户生成的事件数据。
  • WRITE 表示该插件可以写入用户生成的事件数据。
  • READ_WRITE 表示该插件可以读取和写入用户生成的事件数据,以及读取基本元数据。

如果设置为 READREAD_WRITE,该插件必须具有 https://www.googleapis.com/auth/calendar.addons.current.event.read scope

如果设置为 WRITEREAD_WRITE,则该插件必须具有 https://www.googleapis.com/auth/calendar.addons.current.event.write 作用域

eventOpenTrigger

object (EventOpenTrigger)

Google 日历中活动打开触发器的触发器规范。

eventUpdateTrigger

object (EventUpdateTrigger)

必须提供此权限,才能在 Google 日历中提供上下文相关的活动更新接口。日历中活动更新触发器的触发器规范。

eventAttachmentTrigger

object (EventAttachmentTrigger)

Google 日历中活动附件触发器的触发器规范。

homepageTrigger

object (HomepageTrigger)

用于在 Google 日历主机中创建插件首页的触发器函数规范。这会替换 addOns.common.homepageTrigger

ConferenceSolution

该插件提供的会议解决方案的配置。每个解决方案都有对应的会议选项,显示在 Google 日历的修改活动界面中。

JSON 表示法
{
  "id": string,
  "logoUrl": string,
  "name": string,
  "onCreateFunction": string
}
字段
id

string

必需。会议解决方案的标识符。在该插件提供的一系列会议解决方案中必须是唯一的。 选择 ID 后,请勿更改。
logoUrl

string

指向表示解决方案的图标的链接。 图片的尺寸应为 96 x 96 dp。

此网址不能是任意网址,图片必须托管在 Google 的基础架构上。如需了解详情,请参阅 提供会议解决方案徽标

如果提供,此图片可能与插件 calendar.logoUrl 不同,该图片用于在扩展的托管应用中表示插件。如果未为特定解决方案提供徽标图片,则系统会改用 calendar.logoUrl
name

string

必需。当用户创建或修改活动时,Google 日历界面中显示的会议解决方案的名称。
onCreateFunction

string

必需。Google 日历尝试创建此类会议时调用的 Apps 脚本函数的名称。您必须为您的插件支持的每个会议解决方案 实现此函数

EventOpenTrigger

情境触发器的配置,该触发器会在用户打开 Google 日历活动时触发。如需了解详情,请参阅扩展 Google 日历活动接口

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

string

当用户打开日历事件以进行查看或修改时运行的 Apps 脚本函数的名称。如果指定了此参数,您必须实现此函数,以构建并返回一个 Card 对象数组,以便在插件界面中显示。

EventUpdateTrigger

上下文触发器的配置,用于在用户修改并保存 Google 日历事件时触发。如需了解详情,请参阅更新 Google 日历活动

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

string

用户修改和保存 Google 日历活动时运行的 Apps 脚本函数的名称。如果指定了此参数,您必须实现此函数,以构建并返回一个 Card 对象数组,以便在插件界面中显示。

EventAttachmentTrigger

上下文触发器的配置,该触发器会在用户点击“日历”下拉菜单中的插件附件提供程序时触发。

JSON 表示法
{
  "runFunction": string,
  "label": string,
}
字段
runFunction

string

必需。当用户在 Google 日历下拉菜单中选择插件附件提供程序时运行的 Apps 脚本函数的名称。您必须实现此函数,以构建并返回 Card 对象的数组,以便在插件界面中显示。
label

string

必需。日历下拉菜单中显示的文本,用于标识此附件提供程序。