日历清单资源

用于定义 Google Workspace 插件 在 Google 日历中显示的内容和行为的资源配置。如果 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 范围

如果设置为 WRITEREAD_WRITE, 插件必须包含 https://www.googleapis.com/auth/calendar.addons.current.event.write 范围

eventOpenTrigger

object (EventOpenTrigger)

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

eventUpdateTrigger

object (EventUpdateTrigger)

必须在 日历中提供情境活动更新界面。用于活动更新 触发器的触发器规范。

eventAttachmentTrigger

object (EventAttachmentTrigger)

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

homepageTrigger

object (HomepageTrigger)

用于日历中插件 首页的触发器函数。此函数会替换 addOns.common.homepageTrigger

ConferenceSolution

此清单对象仅适用于使用第三方会议解决方案扩展日历的插件。

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

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

string

必需 。会议解决方案的标识符。它在会议解决方案集中必须是 唯一的。选择后,请勿更改 ID once chosen.
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

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