calendarId STRING Required

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword

alwaysIncludeEmail BOOLEAN

Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False

iCalUID STRING

Specifies event ID in the iCalendar format to be included in the response. Optional

maxAttendees INTEGER

The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional

maxResults INTEGER

Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional

orderBy ENUMERATION

The order of the events returned in the result. Optional. The default is an unspecified, stable order

pageToken STRING

Token specifying which result page to return. Optional

privateExtendedProperty STRING

Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints

q STRING

Free text search terms to find events that match these terms in any field, except for extended properties. Optional

sharedExtendedProperty STRING

Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints

showDeleted BOOLEAN

Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False

showHiddenInvitations BOOLEAN

Whether to include hidden invitations in the result. Optional. The default is False

singleEvents BOOLEAN

Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False

syncToken STRING

Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

• iCalUID
• orderBy
• privateExtendedProperty
• q
• sharedExtendedProperty
• timeMin
• timeMax
• updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

timeMax DATE_TIME

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin

timeMin DATE_TIME

Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax

timeZone STRING

Time zone used in the response. Optional. The default is the time zone of the calendar

updatedMin DATE_TIME

Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time

address STRING

The address where notifications are delivered for this channel

expiration INTEGER

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional

id STRING

A UUID or similar unique string that identifies this channel

kind STRING

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel"

params OBJECT

Additional parameters controlling delivery channel behavior. Optional

params.customKey.value STRING Required

Additional parameters controlling delivery channel behavior. Optional

payload BOOLEAN

A Boolean value to indicate whether payload is wanted. Optional

resourceId STRING

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions

resourceUri STRING

A version-specific identifier for the watched resource

token STRING

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional

type STRING

The type of delivery mechanism used for this channel

address STRING

The address where notifications are delivered for this channel

expiration INTEGER

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional

id STRING

A UUID or similar unique string that identifies this channel

kind STRING

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel"

params OBJECT

Additional parameters controlling delivery channel behavior. Optional

params.customKey.value STRING

Additional parameters controlling delivery channel behavior. Optional

payload BOOLEAN

A Boolean value to indicate whether payload is wanted. Optional

resourceId STRING

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions

resourceUri STRING

A version-specific identifier for the watched resource

token STRING

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional

type STRING

The type of delivery mechanism used for this channel