As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Apps Script Type Calendar API

class google.apps.script.type.calendar.types.CalendarAddOnManifest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Calendar add-on manifest.

homepage_trigger

Defines an endpoint that will be executed contexts that don’t match a declared contextual trigger. Any cards generated by this function will always be available to the user, but may be eclipsed by contextual content when this add-on declares more targeted triggers.

If present, this overrides the configuration from addOns.common.homepageTrigger.

Type

google.apps.script.type.types.HomepageExtensionPoint

conference_solution

Defines conference solutions provided by this add-on.

Type

MutableSequence[google.apps.script.type.calendar.types.ConferenceSolution]

create_settings_url_function

An endpoint to execute that creates a URL to the add-on’s settings page.

Type

str

event_open_trigger

An endpoint to trigger when an event is opened (viewed/edited).

Type

google.apps.script.type.calendar.types.CalendarExtensionPoint

event_update_trigger

An endpoint to trigger when the open event is updated.

Type

google.apps.script.type.calendar.types.CalendarExtensionPoint

current_event_access

Define the level of data access when an event addon is triggered.

Type

google.apps.script.type.calendar.types.CalendarAddOnManifest.EventAccess

class EventAccess(value)

Bases: proto.enums.Enum

An enum defining the level of data access event triggers require.

Values:

UNSPECIFIED (0):

Default value when nothing is set for EventAccess.

METADATA (1):

METADATA gives event triggers the permission to access the metadata of events such as event id and calendar id.

READ (3):

READ gives event triggers access to all provided event fields including the metadata, attendees, and conference data.

WRITE (4):

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 (5):

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.

class google.apps.script.type.calendar.types.CalendarExtensionPoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

run_function

Required. The endpoint to execute when this extension point is activated.

Type

str

class google.apps.script.type.calendar.types.ConferenceSolution(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Defines conference related values.

on_create_function

Required. The endpoint to call when ConferenceData should be created.

Type

str

id

Required. IDs should be unique across ConferenceSolutions within one add-on, but this is not strictly enforced. It is up to the add-on developer to assign them uniquely, otherwise the wrong ConferenceSolution may be used when the add-on is triggered. While the developer may change the display name of an add-on, the ID should not be changed.

Type

str

name

Required. The display name of the ConferenceSolution.

Type

str

logo_url

Required. The URL for the logo image of the ConferenceSolution.

Type

str