@datafire/google_calendar v6.0.0
@datafire/google_calendar
Client library for Calendar API
Installation and Usage
npm install --save @datafire/google_calendar
let google_calendar = require('@datafire/google_calendar').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Manipulates events and other calendar data.
Actions
oauthCallback
Exchange the code passed to your redirect URI for an access_token
google_calendar.oauthCallback({
"code": ""
}, context)
Input
- input
object
- code required
string
- code required
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
oauthRefresh
Exchange a refresh_token for an access_token
google_calendar.oauthRefresh(null, context)
Input
This action has no parameters
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
calendar.calendars.insert
Creates a secondary calendar.
google_calendar.calendar.calendars.insert({}, context)
Input
- input
object
- body Calendar
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
Output
- output Calendar
calendar.calendars.delete
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
google_calendar.calendar.calendars.delete({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
Output schema unknown
calendar.calendars.get
Returns metadata for a calendar.
google_calendar.calendar.calendars.get({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Calendar
calendar.calendars.patch
Updates metadata for a calendar. This method supports patch semantics.
google_calendar.calendar.calendars.patch({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - body Calendar
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Calendar
calendar.calendars.update
Updates metadata for a calendar.
google_calendar.calendar.calendars.update({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - body Calendar
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Calendar
calendar.acl.list
Returns the rules in the access control list for the calendar.
google_calendar.calendar.acl.list({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - 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. - pageToken
string
: Token specifying which result page to return. Optional. - showDeleted
boolean
: Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. 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. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Acl
calendar.acl.insert
Creates an access control rule.
google_calendar.calendar.acl.insert({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - sendNotifications
boolean
: Whether to send notifications about the calendar sharing change. Optional. The default is True. - body AclRule
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output AclRule
calendar.acl.watch
Watch for changes to ACL resources.
google_calendar.calendar.acl.watch({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - 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. - pageToken
string
: Token specifying which result page to return. Optional. - showDeleted
boolean
: Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. 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. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. - body Channel
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Channel
calendar.acl.delete
Deletes an access control rule.
google_calendar.calendar.acl.delete({
"calendarId": "",
"ruleId": ""
}, context)
Input
- input
object
- calendarId required
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. - ruleId required
string
: ACL rule identifier. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
Output schema unknown
calendar.acl.get
Returns an access control rule.
google_calendar.calendar.acl.get({
"calendarId": "",
"ruleId": ""
}, context)
Input
- input
object
- calendarId required
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. - ruleId required
string
: ACL rule identifier. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output AclRule
calendar.acl.patch
Updates an access control rule. This method supports patch semantics.
google_calendar.calendar.acl.patch({
"calendarId": "",
"ruleId": ""
}, context)
Input
- input
object
- calendarId required
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. - ruleId required
string
: ACL rule identifier. - sendNotifications
boolean
: Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. - body AclRule
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output AclRule
calendar.acl.update
Updates an access control rule.
google_calendar.calendar.acl.update({
"calendarId": "",
"ruleId": ""
}, context)
Input
- input
object
- calendarId required
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. - ruleId required
string
: ACL rule identifier. - sendNotifications
boolean
: Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. - body AclRule
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output AclRule
calendar.calendars.clear
Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
google_calendar.calendar.calendars.clear({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
Output schema unknown
calendar.events.list
Returns events on the specified calendar.
google_calendar.calendar.events.list({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - alwaysIncludeEmail
boolean
: Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). - iCalUID
string
: Specifies event ID in the iCalendar format to be included in the response. Optional. - maxAttendees
integer
: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. - maxResults
integer
: Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. - orderBy
string
(values: startTime, updated): The order of the events returned in the result. Optional. The default is an unspecified, stable order. - pageToken
string
: Token specifying which result page to return. Optional. - privateExtendedProperty
array
: Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. - q
string
: Free text search terms to find events that match these terms in any field, except for extended properties. Optional. - sharedExtendedProperty
array
: Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. - showDeleted
boolean
: Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. - showHiddenInvitations
boolean
: Whether to include hidden invitations in the result. Optional. The default is False. - singleEvents
boolean
: 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. 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. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. - timeMax
string
: Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. - timeMin
string
: Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. - timeZone
string
: Time zone used in the response. Optional. The default is the time zone of the calendar. - updatedMin
string
: Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Events
calendar.events.insert
Creates an event.
google_calendar.calendar.events.insert({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - conferenceDataVersion
integer
: Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. - maxAttendees
integer
: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. - sendNotifications
boolean
: Deprecated. Please use sendUpdates instead. - sendUpdates
string
(values: all, externalOnly, none): Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. - supportsAttachments
boolean
: Whether API client performing operation supports event attachments. Optional. The default is False. - body Event
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Event
calendar.events.import
Imports an event. This operation is used to add a private copy of an existing event to a calendar.
google_calendar.calendar.events.import({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - conferenceDataVersion
integer
: Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. - supportsAttachments
boolean
: Whether API client performing operation supports event attachments. Optional. The default is False. - body Event
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Event
calendar.events.quickAdd
Creates an event based on a simple text string.
google_calendar.calendar.events.quickAdd({
"calendarId": "",
"text": ""
}, context)
Input
- input
object
- calendarId required
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. - text required
string
: The text describing the event to be created. - sendNotifications
boolean
: Deprecated. Please use sendUpdates instead. - sendUpdates
string
(values: all, externalOnly, none): Guests who should receive notifications about the creation of the new event. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Event
calendar.events.watch
Watch for changes to Events resources.
google_calendar.calendar.events.watch({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - alwaysIncludeEmail
boolean
: Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). - iCalUID
string
: Specifies event ID in the iCalendar format to be included in the response. Optional. - maxAttendees
integer
: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. - maxResults
integer
: Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. - orderBy
string
(values: startTime, updated): The order of the events returned in the result. Optional. The default is an unspecified, stable order. - pageToken
string
: Token specifying which result page to return. Optional. - privateExtendedProperty
array
: Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. - q
string
: Free text search terms to find events that match these terms in any field, except for extended properties. Optional. - sharedExtendedProperty
array
: Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. - showDeleted
boolean
: Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. - showHiddenInvitations
boolean
: Whether to include hidden invitations in the result. Optional. The default is False. - singleEvents
boolean
: 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. 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. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. - timeMax
string
: Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. - timeMin
string
: Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. - timeZone
string
: Time zone used in the response. Optional. The default is the time zone of the calendar. - updatedMin
string
: Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. - body Channel
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Channel
calendar.events.delete
Deletes an event.
google_calendar.calendar.events.delete({
"calendarId": "",
"eventId": ""
}, context)
Input
- input
object
- calendarId required
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. - eventId required
string
: Event identifier. - sendNotifications
boolean
: Deprecated. Please use sendUpdates instead. - sendUpdates
string
(values: all, externalOnly, none): Guests who should receive notifications about the deletion of the event. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
Output schema unknown
calendar.events.get
Returns an event.
google_calendar.calendar.events.get({
"calendarId": "",
"eventId": ""
}, context)
Input
- input
object
- calendarId required
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. - eventId required
string
: Event identifier. - alwaysIncludeEmail
boolean
: Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). - maxAttendees
integer
: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. - timeZone
string
: Time zone used in the response. Optional. The default is the time zone of the calendar. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Event
calendar.events.patch
Updates an event. This method supports patch semantics.
google_calendar.calendar.events.patch({
"calendarId": "",
"eventId": ""
}, context)
Input
- input
object
- calendarId required
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. - eventId required
string
: Event identifier. - alwaysIncludeEmail
boolean
: Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). - conferenceDataVersion
integer
: Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. - maxAttendees
integer
: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. - sendNotifications
boolean
: Deprecated. Please use sendUpdates instead. - sendUpdates
string
(values: all, externalOnly, none): Guests who should receive notifications about the event update (for example, title changes, etc.). - supportsAttachments
boolean
: Whether API client performing operation supports event attachments. Optional. The default is False. - body Event
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Event
calendar.events.update
Updates an event.
google_calendar.calendar.events.update({
"calendarId": "",
"eventId": ""
}, context)
Input
- input
object
- calendarId required
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. - eventId required
string
: Event identifier. - alwaysIncludeEmail
boolean
: Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). - conferenceDataVersion
integer
: Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. - maxAttendees
integer
: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. - sendNotifications
boolean
: Deprecated. Please use sendUpdates instead. - sendUpdates
string
(values: all, externalOnly, none): Guests who should receive notifications about the event update (for example, title changes, etc.). - supportsAttachments
boolean
: Whether API client performing operation supports event attachments. Optional. The default is False. - body Event
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Event
calendar.events.instances
Returns instances of the specified recurring event.
google_calendar.calendar.events.instances({
"calendarId": "",
"eventId": ""
}, context)
Input
- input
object
- calendarId required
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. - eventId required
string
: Recurring event identifier. - alwaysIncludeEmail
boolean
: Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). - maxAttendees
integer
: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. - maxResults
integer
: Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. - originalStart
string
: The original start time of the instance in the result. Optional. - pageToken
string
: Token specifying which result page to return. Optional. - showDeleted
boolean
: Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False. - timeMax
string
: Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset. - timeMin
string
: Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset. - timeZone
string
: Time zone used in the response. Optional. The default is the time zone of the calendar. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Events
calendar.events.move
Moves an event to another calendar, i.e. changes an event's organizer.
google_calendar.calendar.events.move({
"calendarId": "",
"eventId": "",
"destination": ""
}, context)
Input
- input
object
- calendarId required
string
: Calendar identifier of the source calendar where the event currently is on. - eventId required
string
: Event identifier. - destination required
string
: Calendar identifier of the target calendar where the event is to be moved to. - sendNotifications
boolean
: Deprecated. Please use sendUpdates instead. - sendUpdates
string
(values: all, externalOnly, none): Guests who should receive notifications about the change of the event's organizer. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output Event
calendar.channels.stop
Stop watching resources through this channel
google_calendar.calendar.channels.stop({}, context)
Input
- input
object
- body Channel
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
Output
Output schema unknown
calendar.colors.get
Returns the color definitions for calendars and events.
google_calendar.calendar.colors.get({}, context)
Input
- input
object
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- alt
Output
- output Colors
calendar.freebusy.query
Returns free/busy information for a set of calendars.
google_calendar.calendar.freebusy.query({}, context)
Input
- input
object
- body FreeBusyRequest
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
Output
- output FreeBusyResponse
calendar.calendarList.list
Returns the calendars on the user's calendar list.
google_calendar.calendar.calendarList.list({}, context)
Input
- input
object
- 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
(values: freeBusyReader, owner, reader, writer): The minimum access role for the user in the returned entries. Optional. The default is no restriction. - 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. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- maxResults
Output
- output CalendarList
calendar.calendarList.insert
Inserts an existing calendar into the user's calendar list.
google_calendar.calendar.calendarList.insert({}, context)
Input
- input
object
- 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. - body CalendarListEntry
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- colorRgbFormat
Output
- output CalendarListEntry
calendar.calendarList.watch
Watch for changes to CalendarList resources.
google_calendar.calendar.calendarList.watch({}, context)
Input
- input
object
- 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
(values: freeBusyReader, owner, reader, writer): The minimum access role for the user in the returned entries. Optional. The default is no restriction. - 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. - body Channel
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- maxResults
Output
- output Channel
calendar.calendarList.delete
Removes a calendar from the user's calendar list.
google_calendar.calendar.calendarList.delete({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
Output schema unknown
calendar.calendarList.get
Returns a calendar from the user's calendar list.
google_calendar.calendar.calendarList.get({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output CalendarListEntry
calendar.calendarList.patch
Updates an existing calendar on the user's calendar list. This method supports patch semantics.
google_calendar.calendar.calendarList.patch({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - 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. - body CalendarListEntry
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output CalendarListEntry
calendar.calendarList.update
Updates an existing calendar on the user's calendar list.
google_calendar.calendar.calendarList.update({
"calendarId": ""
}, context)
Input
- input
object
- calendarId required
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. - 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. - body CalendarListEntry
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- calendarId required
Output
- output CalendarListEntry
calendar.settings.list
Returns all user settings for the authenticated user.
google_calendar.calendar.settings.list({}, context)
Input
- input
object
- 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. - pageToken
string
: Token specifying which result page to return. Optional. - 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. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- maxResults
Output
- output Settings
calendar.settings.watch
Watch for changes to Settings resources.
google_calendar.calendar.settings.watch({}, context)
Input
- input
object
- 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. - pageToken
string
: Token specifying which result page to return. Optional. - 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. - body Channel
- alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- maxResults
Output
- output Channel
calendar.settings.get
Returns a single user setting.
google_calendar.calendar.settings.get({
"setting": ""
}, context)
Input
- input
object
- setting required
string
: The id of the user setting. - alt
string
(values: json): Data format for the response. - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - userIp
string
: Deprecated. Please use quotaUser instead.
- setting required
Output
- output Setting
Definitions
Acl
- Acl
object
- etag
string
: ETag of the collection. - items
array
: List of rules on the access control list.- items AclRule
- kind
string
: Type of the collection ("calendar#acl"). - nextPageToken
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
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.
- etag
AclRule
- AclRule
object
- etag
string
: ETag of the resource. - id
string
: Identifier of the ACL rule. - kind
string
: Type of the resource ("calendar#aclRule"). - role
string
: The role assigned to the scope. Possible values are: - scope
object
: The scope of the rule.- type
string
: The type of the scope. Possible values are: - value
string
: The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- type
- etag
Calendar
- Calendar
object
- conferenceProperties ConferenceProperties
- description
string
: Description of the calendar. Optional. - etag
string
: ETag of the resource. - id
string
: Identifier of the calendar. To retrieve IDs call the calendarList.list() method. - kind
string
: Type of the resource ("calendar#calendar"). - location
string
: Geographic location of the calendar as free-form text. Optional. - summary
string
: Title of the calendar. - timeZone
string
: The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
CalendarList
- CalendarList
object
- etag
string
: ETag of the collection. - items
array
: Calendars that are present on the user's calendar list.- items CalendarListEntry
- kind
string
: Type of the collection ("calendar#calendarList"). - nextPageToken
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
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.
- etag
CalendarListEntry
- CalendarListEntry
object
- accessRole
string
: The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - backgroundColor
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
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 ConferenceProperties
- defaultReminders
array
: The default reminders that the authenticated user has for this calendar.- items EventReminder
- deleted
boolean
: Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. - description
string
: Description of the calendar. Optional. Read-only. - etag
string
: ETag of the resource. - foregroundColor
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 pro
- accessRole