日历清单资源

用于定义 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 scope

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

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

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