Google is committed to advancing racial equity for Black communities. See how.

Calendar manifest resource

The resource configuration that is used to define Google Workspace add-on content and behavior within Google Calendar. Google Workspaceadd-on manifests must have all the components marked as Required if they extend Calendar.

Calendar

The Google Workspace add-on manifest configuration for Google Calendar extensions. See Extending Calendar with Google Workspace add-ons for more information.

JSON representation
{
  "createSettingsUrlFunction": string,
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "currentEventAccess": string,
  "eventOpenTrigger": {
    object (EventOpenTrigger)
  },
  "eventUpdateTrigger": {
    object (EventUpdateTrigger)
  },
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
Fields
createSettingsUrlFunction

string

Only used if the add-on provides conferencing solutions. Optional. The name of the Apps Script function that generates a URL leading to a settings page for the add-on.

See Adding conferencing add-on settings for more details.
conferenceSolution[]

object (ConferenceSolution)

Only used if the add-on provides conferencing solutions; if so, at least one solution must be defined. A list of conferencing solutions offered by the add-on. Each solution has a corresponding conferencing option presented in the Google Calendar Edit Event UI.
currentEventAccess

string

Determines what level of access the add-on has to user-generated data event data. If not provided, no event metadata is passed to the add-on. The valid settings are the following:

  • METADATA indicates that the add-on only has access to basic event metadata.
  • READ indicates that the add-on can read user-generated event data in addition to the basic event metadata.
  • WRITE indicates that the add-on can write user-generated event data.
  • READ_WRITE indicates that the add-on can read and write user-generated event data, as well as reading basic metadata.

If set to READ or READ_WRITE, the add-on must have the https://www.googleapis.com/auth/calendar.addons.current.event.read scope.

If set to WRITE or READ_WRITE, the add-on must have the https://www.googleapis.com/auth/calendar.addons.current.event.write scope.

eventOpenTrigger

object (EventOpenTrigger)

The trigger specification for event open triggers in Calendar.

eventUpdateTrigger

object (EventUpdateTrigger)

Required to provide contextual event update interfaces in Google Calendar. The trigger specification for event update triggers in Calendar.

homepageTrigger

object (HomepageTrigger)

The trigger function specification for creating the add-on homepage in the Calendar host. This overrides addOns.common.homepageTrigger.

ConferenceSolution

The configuration of a conferencing solution offered by the add-on. Each solution has a corresponding conferencing option presented in the Google Calendar Edit Event UI.

JSON representation
{
  "id": string,
  "logoUrl": string,
  "name": string,
  "onCreateFunction": string
}
Fields
id

string

Required. An identifier for the conferencing solution. Must be unique in the add-on's set of provided conference solutions. Once an ID is chosen, it shouldn't be changed.
logoUrl

string

A link to the icon representing the solution. The image should be sized to 96 x 96 dp.

This cannot be an arbitrary URL—the image must be hosted on Google's infrastructure. See Providing conference solution logos for details.

If provided, this image may be distinct from the add-on calendar.logoUrl, which the image used to represent the add-on in the host applications it extends. If a logo image is not provided for a specific solution, calendar.logoUrl is used instead.
name

string

Required. The name of the conferencing solution shown in the Google Calendar UI when a user creates or edits an event.
onCreateFunction

string

Required. The name of the Apps Script function called when Google Calendar attempts to create this type of conference. You must implement this function for each conference solution your add-on supports.

EventOpenTrigger

A configuration for a contextual trigger that fires when a Google Calendar event is opened by the user. See Extending the Calendar event interface for more information.

JSON representation
{
  "runFunction": string
}
Fields
runFunction

string

The name of the Apps Script function that runs when a user opens a Calendar event for viewing or editing. If specified, you must implement this function to build and return an array of Card objects for display in the add-on UI.

EventUpdateTrigger

A configuration for a contextual trigger that fires when a Google Calendar event is edited and saved by the user. See Updating Calendar events for more information.

JSON representation
{
  "runFunction": string
}
Fields
runFunction

string

The name of the Apps Script function that runs when a user edits and saves a Calendar event. If specified, you must implement this function to build and return an array of Card objects for display in the add-on UI.