Calendar manifest resource

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

Calendar

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

JSON representation
{
  "currentEventAccess": string,
  "eventOpenTrigger": {
    object (EventOpenTrigger)
  },
  "eventUpdateTrigger": {
    object (EventUpdateTrigger)
  },
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
Fields
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.

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.