GoogleCalendar

class googlecalendar.GoogleCalendar(access_token=None)

Create a Google Calendar service.

Variables:access_token

Calendar

GoogleCalendar.calendar(calendar_id)

Return the resource corresponding to a single calendar

Event

Calendar.event(event_id)

Return the resource corresponding to a single event

Event.delete(sendNotifications=None)

Delete this resource.

Variables:sendNotifications (str) – Whether to send notifications. The default is False.
Event.get(alwaysIncludeEmail=None, maxAttendees=None, timeZone=None)

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Variables:
  • alwaysIncludeEmail (str) – Whether to always include a value in the “email” field for the organizer, creator and attendees, even if no real email is available. The default is False.
  • maxAttendees (int) – The maximum number of attendees to include in the response. If none is indicated, only the participant is returned.
  • timeZone (str) – Time zone used in the response. The default is the time zone of the calendar.
Event.instances(alwaysIncludeEmail=None, maxAttendees=None, maxResults=None, originalStart=None, pageToken=None, showDeleted=None, timeZone=None)

Fetch all instances of the recurring event.

Variables:
  • alwaysIncludeEmail (str) – Whether to always include a value in the “email” field for the organizer, creator and attendees, even if no real email is available. The default is False.
  • maxAttendees (int) – The maximum number of attendees to include in the response. If none is indicated, only the participant is returned.
  • maxResults (int) – Maximum number of instances returned.
  • originalStart (str) – The original start time of the instance in the result.
  • pageToken (str) – Token specifying which result page to return.
  • showDeleted (str) – Whether to include deleted instances. The default is False.
  • timeZone (str) – Time zone used in the response. The default is the time zone of the calendar.
Event.move(destination, sendNotifications=None)

Move an event to another calendar.

Variables:
  • destination (str) – Calendar identifier of the target calendar where the event is to be moved to.
  • sendNotifications (str) – Whether to send notifications. The default is False.
Event.patch(obj, alwaysIncludeEmail=None, sendNotifications=None)

Patch this resource.

Variables:
  • obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
  • alwaysIncludeEmail (str) – Whether to always include a value in the “email” field for the organizer, creator and attendees, even if no real email is available. The default is False.
  • sendNotifications (str) – Whether to send notifications. The default is False.
Event.update(obj, alwaysIncludeEmail=None, sendNotifications=None)

Update this resource.

Variables:
  • obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
  • alwaysIncludeEmail (str) – Whether to always include a value in the “email” field for the organizer, creator and attendees, even if no real email is available. The default is False.
  • sendNotifications (str) – Whether to send notifications. The default is False.

Events

Calendar.events()

Return the resource corresponding to all the events

Events.create(obj, sendNotifications=None)

Create a new resource.

Variables:
  • obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
  • sendNotifications (str) – Whether to send notifications. The default is False.
Events.get(alwaysIncludeEmail=None, iCalUID=None, maxAttendees=None, maxResults=None, orderBy=None, pageToken=None, q=None, showDeleted=None, showHiddenInvitations=None, singleEvents=None, timeMax=None, timeMin=None, timeZone=None, updateMin=None)

Fetch all events on the calendar.

Variables:
  • alwaysIncludeEmail (str) – Whether to always include a value in the “email” field for the organizer, creator and attendees, even if no real email is available. The default is False.
  • iCalUID (str) – Specifies iCalendar UID of events to be included.
  • maxAttendees (int) – The maximum number of attendees to include in the response. If none is indicated, only the participant is returned.
  • maxResults (int) – Maximum number of events returned.
  • orderBy (str) – The order of the events returned in the result. The default is an unspecified, stable order.
  • pageToken (str) – Token specifying which result page to return.
  • q (str) – Free text search terms to find events that match these terms.
  • showDeleted (str) – Whether to include deleted events. The default is False.
  • showHiddenInvitations (str) – Whether to include hidden invitations. The default is False.
  • singleEvents (str) – Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. The default is False.
. :var timeMax: Upper bound for an event’s start time to filter by.
The default is not to filter by start time.
Variables:
  • timeMin (str) – Lower bound for an event’s end time to filter by. The default is not to filter by end time.
  • timeZone (str) – Time zone used in the response. The default is the time zone of the calendar.
  • updatedMin – Lower bound for an event’s last modification timestamp to filter by. Optional. The default is not to filter by last modification time.
Events.importing(obj)

Import an event.

Variables:obj – a Python object representing the imported event.
Events.quick_add(text, sendNotifications=None)

Import an event.

Variables:
  • text (str) – The text describing the event to be created.
  • sendNotifications (str) – Whether to send notifications. The default is False.

Acl

Calendar.rule(rule_id)

Return the resource corresponding to a single rule

Acl.delete()

Delete this resource.

Acl.get()

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Acl.patch(obj)

Update this resource’s metadata.

Variables:obj – a Python object representing the updated resource. Refer to the upstream documentation for details.
Acl.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Acls

Calendar.rules()

Return the resource corresponding to all the rules

Acls.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
Acls.get()

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Calendar.clear()

Clear this calendar.

Calendar.delete()

Delete this resource.

Calendar.get()

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Calendar.patch(obj)

Update this resource’s metadata.

Variables:obj – a Python object representing the updated resource. Refer to the upstream documentation for details.
Calendar.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Calendars

GoogleCalendar.calendars()

Return the resource corresponding to all the calendars

Calendars.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ColorsResource

GoogleCalendar.colors()

Return the resource corresponding to all the colors

ColorsResource.get()

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

FreeBusyResource

GoogleCalendar.freebusy()

Return the resource corresponding to all the free/busy info

FreeBusyResource.query(obj)

Return free/busy info for a set of calendars.

Variables:obj – a Python object representing the query.

User

GoogleCalendar.me()

Return the resource corresponding to the current user

CalendarList

User.calendar_list(calendar_id)

Return the resource corresponding to a single calendar list

CalendarList.delete()

Delete this resource.

CalendarList.get()

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

CalendarList.patch(obj)

Update this resource’s metadata.

Variables:obj – a Python object representing the updated resource. Refer to the upstream documentation for details.
CalendarList.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarLists

User.calendar_lists()

Return the resource corresponding to all the calendar lists

CalendarLists.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
CalendarLists.get()

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

SettingResource

User.setting(setting)

Return the resource corresponding to a single setting

SettingResource.get()

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

SettingResource

User.settings()

Return the resource corresponding to all the settings

SettingResource.get()

For single-object resources, fetch the object’s data. For collections, fetch all of the objects.