日历清单资源

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

日历

日历扩展服务的 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)

仅当插件提供 会议解决方案时使用;必须至少定义一个解决方案。 插件提供的会议解决方案。每种解决方案都会在日历的 **修改活动** 界面中显示为选项。
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)

在日历中提供情境式活动更新界面时需要用到。事件更新触发器的触发规范。

eventAttachmentTrigger

object (EventAttachmentTrigger)

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

homepageTrigger

object (HomepageTrigger)

插件在 Google 日历中的首页的触发函数。这会替换 addOns.common.homepageTrigger

ConferenceSolution

只有使用第三方会议解决方案扩展 Google 日历的插件才需要此清单对象。

插件提供的会议解决方案的配置。每种解决方案都会在 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

必需。用于标识附件提供程序的菜单文本。