Default request referring to version v3 of the Calendar API. This contains the host and root path used as a starting point for constructing service requests.

Manage your calendars

View your calendars

Creates a value of CalendarListEntry with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cleSummary
• cleEtag
• cleLocation
• cleKind
• cleNotificationSettings
• cleBackgRoundColor
• cleForegRoundColor
• cleDefaultReminders
• cleSelected
• clePrimary
• cleHidden
• cleId
• cleDeleted
• cleAccessRole
• cleSummaryOverride
• cleColorId
• cleTimeZone
• cleDescription

Title of the calendar. Read-only.

ETag of the resource.

Geographic location of the calendar as free-form text. Optional. Read-only.

Type of the resource ("calendar#calendarListEntry").

The notifications that the authenticated user is receiving for this calendar.

The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

The default reminders that the authenticated user has for this calendar.

Whether the calendar content shows up in the calendar UI. Optional. The default is False.

Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

Whether the calendar has been hidden from the list. Optional. The default is False.

Identifier of the calendar.

Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

The summary that the authenticated user has set for this calendar. Optional.

The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.

The time zone of the calendar. Optional. Read-only.

Description of the calendar. Optional. Read-only.

Creates a value of Event with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eSummary
• eOriginalStartTime
• eCreator
• eStatus
• eGuestsCanModify
• eEtag
• eAttachments
• eLocked
• eLocation
• eAttendees
• eReminders
• eKind
• eCreated
• eTransparency
• eRecurringEventId
• eStart
• ePrivateCopy
• eEndTimeUnspecified
• eExtendedProperties
• eVisibility
• eGuestsCanInviteOthers
• eRecurrence
• eGadget
• eSequence
• eICalUId
• eEnd
• eAttendeesOmitted
• eSource
• eId
• eHTMLLink
• eUpdated
• eColorId
• eAnyoneCanAddSelf
• eGuestsCanSeeOtherGuests
• eHangoutLink
• eDescription
• eOrganizer

Title of the event.

For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.

The creator of the event. Read-only.

Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled.

Whether attendees other than the organizer can modify the event. Optional. The default is False.

ETag of the resource.

File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,

Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.

Geographic location of the event as free-form text. Optional.

The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

Information about the event's reminders for the authenticated user.

Type of the resource ("calendar#event").

Creation time of the event (as a RFC3339 timestamp). Read-only.

Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - The event blocks time on the calendar. This is the default value. - "transparent" - The event does not block time on the calendar.

For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.

Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.

Extended properties of the event.

Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.

Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.

A gadget that extends this event.

Sequence number as per iCalendar.

Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.

Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.

Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

An absolute link to this event in the Google Calendar Web UI. Read-only.

Last modification time of the event (as a RFC3339 timestamp). Read-only.

The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.

Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

An absolute link to the Google+ hangout associated with this event. Read-only.

Description of the event. Optional.

The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

The notifications that the authenticated user is receiving for this calendar.

See: calendarListEntryNotificationSettings smart constructor.

Creates a value of CalendarListEntryNotificationSettings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• clensNotifications

The list of notifications set for this calendar.

The scope of the rule.

See: aclRuleScope smart constructor.

Creates a value of ACLRuleScope with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• arsValue
• arsType

The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

The type of the scope. Possible values are: - "default" - The public scope. This is the default value. - "user" - Limits the scope to a single user. - "group" - Limits the scope to a group. - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only.

See: colorsEvent smart constructor.

Creates a value of ColorsEvent with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ceAddtional

An event color definition.

Creates a value of Settings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sEtag
• sNextPageToken
• sKind
• sItems
• sNextSyncToken

Etag of the collection.

Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

Type of the collection ("calendar#settings").

List of user settings.

Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.

Creates a value of FreeBusyRequestItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fbriId

The identifier of a calendar or a group.

Creates a value of EventAttachment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eaFileURL
• eaIconLink
• eaMimeType
• eaTitle
• eaFileId

URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

URL link to the attachment's icon. Read-only.

Internet media type (MIME type) of the attachment.

Attachment title.

ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

Creates a value of TimePeriod with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tpStart
• tpEnd

The (inclusive) start of the time period.

The (exclusive) end of the time period.

The creator of the event. Read-only.

See: eventCreator smart constructor.

Creates a value of EventCreator with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ecEmail
• ecSelf
• ecDisplayName
• ecId

The creator's email address, if available.

Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

The creator's name, if available.

The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API

Creates a value of Error with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eDomain
• eReason

Domain, or broad category, of the error.

Specific reason for the error. Some of the possible values are: - "groupTooBig" - The group of users requested is too large for a single query. - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query. - "notFound" - The requested resource was not found. - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.

Creates a value of ColorDefinition with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cdForegRound
• cdBackgRound

The foreground color that can be used to write on top of a background with 'background' color.

The background color associated with this color definition.

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