Calendars

A collection of all existing calendars. See also Calendars vs CalendarList.

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
Property name Value Description Notes
conferenceProperties nested object Conferencing properties for this calendar, for example what types of conferences are allowed.
conferenceProperties.allowedConferenceSolutionTypes[] list The types of conference solutions that are supported for this calendar.

The possible values are:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Optional.

description string Description of the calendar. Optional. writable
etag etag ETag of the resource.
id string Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
kind string Type of the resource ("calendar#calendar").
location string Geographic location of the calendar as free-form text. Optional. writable
summary string Title of the calendar. writable
timeZone string The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. writable

Methods

clear
Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
delete
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
get
Returns metadata for a calendar.
insert
Creates a secondary calendar.
patch
Updates metadata for a calendar. This method supports patch semantics. Note that each patch request consumes three quota units; prefer using a get followed by an update. The field values you specify replace the existing values. Fields that you don't specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements.
update
Updates metadata for a calendar.