Calendar API . calendars

Instance Methods

clear(calendarId)

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.

close()

Close httplib2 connections.

delete(calendarId)

Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.

get(calendarId)

Returns metadata for a calendar.

insert(body=None)

Creates a secondary calendar.

patch(calendarId, body=None)

Updates metadata for a calendar. This method supports patch semantics.

update(calendarId, body=None)

Updates metadata for a calendar.

Method Details

clear(calendarId)
Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.

Args:
  calendarId: string, 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. (required)
close()
Close httplib2 connections.
delete(calendarId)
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.

Args:
  calendarId: string, 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. (required)
get(calendarId)
Returns metadata for a calendar.

Args:
  calendarId: string, 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. (required)

Returns:
  An object of the form:

    {
  "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
    "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
        # The possible values are:
        # - "eventHangout"
        # - "eventNamedHangout"
        # - "hangoutsMeet"  Optional.
      "A String",
    ],
  },
  "description": "A String", # Description of the calendar. Optional.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
  "location": "A String", # Geographic location of the calendar as free-form text. Optional.
  "summary": "A String", # Title of the calendar.
  "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
}
insert(body=None)
Creates a secondary calendar.

Args:
  body: object, The request body.
    The object takes the form of:

{
  "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
    "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
        # The possible values are:
        # - "eventHangout"
        # - "eventNamedHangout"
        # - "hangoutsMeet"  Optional.
      "A String",
    ],
  },
  "description": "A String", # Description of the calendar. Optional.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
  "location": "A String", # Geographic location of the calendar as free-form text. Optional.
  "summary": "A String", # Title of the calendar.
  "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
}


Returns:
  An object of the form:

    {
  "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
    "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
        # The possible values are:
        # - "eventHangout"
        # - "eventNamedHangout"
        # - "hangoutsMeet"  Optional.
      "A String",
    ],
  },
  "description": "A String", # Description of the calendar. Optional.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
  "location": "A String", # Geographic location of the calendar as free-form text. Optional.
  "summary": "A String", # Title of the calendar.
  "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
}
patch(calendarId, body=None)
Updates metadata for a calendar. This method supports patch semantics.

Args:
  calendarId: string, 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. (required)
  body: object, The request body.
    The object takes the form of:

{
  "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
    "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
        # The possible values are:
        # - "eventHangout"
        # - "eventNamedHangout"
        # - "hangoutsMeet"  Optional.
      "A String",
    ],
  },
  "description": "A String", # Description of the calendar. Optional.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
  "location": "A String", # Geographic location of the calendar as free-form text. Optional.
  "summary": "A String", # Title of the calendar.
  "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
}


Returns:
  An object of the form:

    {
  "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
    "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
        # The possible values are:
        # - "eventHangout"
        # - "eventNamedHangout"
        # - "hangoutsMeet"  Optional.
      "A String",
    ],
  },
  "description": "A String", # Description of the calendar. Optional.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
  "location": "A String", # Geographic location of the calendar as free-form text. Optional.
  "summary": "A String", # Title of the calendar.
  "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
}
update(calendarId, body=None)
Updates metadata for a calendar.

Args:
  calendarId: string, 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. (required)
  body: object, The request body.
    The object takes the form of:

{
  "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
    "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
        # The possible values are:
        # - "eventHangout"
        # - "eventNamedHangout"
        # - "hangoutsMeet"  Optional.
      "A String",
    ],
  },
  "description": "A String", # Description of the calendar. Optional.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
  "location": "A String", # Geographic location of the calendar as free-form text. Optional.
  "summary": "A String", # Title of the calendar.
  "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
}


Returns:
  An object of the form:

    {
  "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
    "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
        # The possible values are:
        # - "eventHangout"
        # - "eventNamedHangout"
        # - "hangoutsMeet"  Optional.
      "A String",
    ],
  },
  "description": "A String", # Description of the calendar. Optional.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
  "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
  "location": "A String", # Geographic location of the calendar as free-form text. Optional.
  "summary": "A String", # Title of the calendar.
  "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
}