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)

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:

    {
  "autoAcceptInvitations": True or False, # Whether this calendar automatically accepts invitations. Only valid for resource calendars.
  "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",
    ],
  },
  "dataOwner": "A String", # The email of the owner of the calendar. Set only for secondary calendars. Read-only.
  "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.
The authenticated user for the request is made the data owner of the new calendar.

Note: We recommend to authenticate as the intended data owner of the calendar. You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user. Don't use a service account for authentication. If you use a service account for authentication, the service account is the data owner, which can lead to unexpected behavior. For example, if a service account is the data owner, data ownership cannot be transferred.

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

{
  "autoAcceptInvitations": True or False, # Whether this calendar automatically accepts invitations. Only valid for resource calendars.
  "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",
    ],
  },
  "dataOwner": "A String", # The email of the owner of the calendar. Set only for secondary calendars. Read-only.
  "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:

    {
  "autoAcceptInvitations": True or False, # Whether this calendar automatically accepts invitations. Only valid for resource calendars.
  "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",
    ],
  },
  "dataOwner": "A String", # The email of the owner of the calendar. Set only for secondary calendars. Read-only.
  "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:

{
  "autoAcceptInvitations": True or False, # Whether this calendar automatically accepts invitations. Only valid for resource calendars.
  "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",
    ],
  },
  "dataOwner": "A String", # The email of the owner of the calendar. Set only for secondary calendars. Read-only.
  "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:

    {
  "autoAcceptInvitations": True or False, # Whether this calendar automatically accepts invitations. Only valid for resource calendars.
  "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",
    ],
  },
  "dataOwner": "A String", # The email of the owner of the calendar. Set only for secondary calendars. Read-only.
  "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:

{
  "autoAcceptInvitations": True or False, # Whether this calendar automatically accepts invitations. Only valid for resource calendars.
  "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",
    ],
  },
  "dataOwner": "A String", # The email of the owner of the calendar. Set only for secondary calendars. Read-only.
  "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:

    {
  "autoAcceptInvitations": True or False, # Whether this calendar automatically accepts invitations. Only valid for resource calendars.
  "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",
    ],
  },
  "dataOwner": "A String", # The email of the owner of the calendar. Set only for secondary calendars. Read-only.
  "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.
}