Package google.apps.script.type.calendar

Page Summary

The CalendarAddOnManifest defines the properties, triggers, and data access levels for Google Calendar add-ons.
Add-ons can define triggers to execute functions when events are opened, updated, or when users interact with attachments.
Conference solutions can be integrated within add-ons, providing functionalities like creating conference data with a specified endpoint.
CalendarExtensionPoint and ConferenceSolution further detail how add-ons can extend Calendar's features with specific functionalities and triggers.
Different levels of data access, ranging from metadata to read-write permissions, can be defined for event triggers in add-ons using EventAccess .

Properties customizing the appearance and execution of a Calendar add-on.

Fields
homepageTrigger	HomepageExtensionPoint Defines an endpoint that is executed in contexts that don't match a declared contextual trigger. Any cards generated by this function will always be available to the user, but might be eclipsed by contextual content when this add-on declares more targeted triggers. If present, this overrides the configuration from addOns.common.homepageTrigger .
conferenceSolution[]	ConferenceSolution Defines conference solutions provided by this add-on. Third-party conferencing add-ons can only be built in Apps Script .
createSettingsUrlFunction	string An endpoint to execute that creates a URL to the add-on's settings page.
eventOpenTrigger	CalendarExtensionPoint An endpoint that triggers when an event is opened to be viewed or edited.
eventUpdateTrigger	CalendarExtensionPoint An endpoint that triggers when the open event is updated.
eventAttachmentTrigger	MenuItemExtensionPoint A configuration for a contextual trigger that fires when the user clicks on the add-on attachment provider in the Calendar dropdown menu.
currentEventAccess	EventAccess Defines the level of data access when an event add-on is triggered.

An enum that defines the level of data access event triggers require.

Enums
UNSPECIFIED	Default value when nothing is set for eventAccess.
METADATA	Gives event triggers the permission to access the metadata of events, such as event ID and calendar ID.
READ	Gives event triggers access to all provided event fields including the metadata, attendees, and conference data.
WRITE	Gives event triggers access to the metadata of events and the ability to perform all actions, including adding attendees and setting conference data.
READ_WRITE	Gives event triggers access to all provided event fields including the metadata, attendees, and conference data and the ability to perform all actions.

Common format for declaring a calendar add-on's triggers.

Fields
`runFunction`	`string` Required. The endpoint to execute when this extension point is activated.

Defines conference-related values. Third-party conferencing add-ons can only be built in Apps Script .

Fields
onCreateFunction	string Required. The endpoint to call when conference data should be created.
id	string Required. IDs should be uniquely assigned across conference solutions within one add-on, otherwise the wrong conference solution might be used when the add-on is triggered. While you can change the display name of an add-on, the ID shouldn’t be changed.
name	string Required. The display name of the conference solution.
logoUrl	string Required. The URL for the logo image of the conference solution.