Calendar API . calendars

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)

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:

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

insert(body)

Creates a secondary calendar.

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

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


Returns:
  An object of the form:

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

patch(calendarId, body)

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. (required)
    The object takes the form of:

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


Returns:
  An object of the form:

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

update(calendarId, body)

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. (required)
    The object takes the form of:

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


Returns:
  An object of the form:

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