日历清单资源

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

日历

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

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 范围

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

eventOpenTrigger

object (EventOpenTrigger)

日历中事件打开触发器的触发器规范。

eventUpdateTrigger

object (EventUpdateTrigger)

在 Google 日历中提供上下文事件更新界面时是必需的。日历中事件更新触发器的触发器规范。

eventAttachmentTrigger

object (EventAttachmentTrigger)

日历中事件附件触发器的触发器规范。

homepageTrigger

object (HomepageTrigger)

用于在日历主机中创建插件首页的触发器函数规范。它会替换 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 日历活动时触发的上下文触发器的配置。如需了解详情,请参阅扩展日历活动界面

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

string

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

EventUpdateTrigger

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

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

string

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

EventAttachmentTrigger

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

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

string

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

string

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