Close httplib2 connections.
Removes a calendar from the user's calendar list.
Returns a calendar from the user's calendar list.
insert(body=None, colorRgbFormat=None)
Inserts an existing calendar into the user's calendar list.
Returns the calendars on the user's calendar list.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(calendarId, body=None, colorRgbFormat=None)
Updates an existing calendar on the user's calendar list. This method supports patch semantics.
update(calendarId, body=None, colorRgbFormat=None)
Updates an existing calendar on the user's calendar list.
Watch for changes to CalendarList resources.
close()
Close httplib2 connections.
delete(calendarId)
Removes a calendar from the user's calendar list. 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 a calendar from the user's calendar list.
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:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"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",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}
insert(body=None, colorRgbFormat=None)
Inserts an existing calendar into the user's calendar list.
Args:
body: object, The request body.
The object takes the form of:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"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",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}
colorRgbFormat: boolean, Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
Returns:
An object of the form:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"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",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}
list(maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)
Returns the calendars on the user's calendar list.
Args:
maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
minAccessRole: string, The minimum access role for the user in the returned entries. Optional. The default is no restriction.
Allowed values
freeBusyReader - The user can read free/busy information.
owner - The user can read and modify events and access control lists.
reader - The user can read events that are not private.
writer - The user can read and modify events.
pageToken: string, Token specifying which result page to return. Optional.
showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False.
showHidden: boolean, Whether to show hidden entries. Optional. The default is False.
syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.
To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
Returns:
An object of the form:
{
"etag": "A String", # ETag of the collection.
"items": [ # Calendars that are present on the user's calendar list.
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"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",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
},
],
"kind": "calendar#calendarList", # Type of the collection ("calendar#calendarList").
"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
"nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(calendarId, body=None, colorRgbFormat=None)
Updates an existing calendar on the user's calendar list. 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:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"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",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}
colorRgbFormat: boolean, Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
Returns:
An object of the form:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"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",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}
update(calendarId, body=None, colorRgbFormat=None)
Updates an existing calendar on the user's calendar list.
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:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"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",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}
colorRgbFormat: boolean, Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
Returns:
An object of the form:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"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",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}
watch(body=None, maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)
Watch for changes to CalendarList resources.
Args:
body: object, The request body.
The object takes the form of:
{
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
}
maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
minAccessRole: string, The minimum access role for the user in the returned entries. Optional. The default is no restriction.
Allowed values
freeBusyReader - The user can read free/busy information.
owner - The user can read and modify events and access control lists.
reader - The user can read events that are not private.
writer - The user can read and modify events.
pageToken: string, Token specifying which result page to return. Optional.
showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False.
showHidden: boolean, Whether to show hidden entries. Optional. The default is False.
syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.
To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.
If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
Returns:
An object of the form:
{
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
}