Resources
acl
Watch for changes to ACL resources.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
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. 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. |
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. |
pageToken
|
string |
Token specifying which result page to return. Optional. |
maxResults
|
integer Minimum: 1 |
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. |
Body
| Name | Data Type | Description |
|---|---|---|
Channel
|
object |
Properties
type
|
string |
The type of delivery mechanism used for this channel. |
token
|
string |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
resourceUri
|
string |
A version-specific identifier for the watched resource. |
resourceId
|
string |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
payload
|
boolean |
A Boolean value to indicate whether payload is wanted. Optional. |
params
|
object |
Additional parameters controlling delivery channel behavior. Optional. |
kind
|
string Default value: api#channel
|
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
id
|
string |
A UUID or similar unique string that identifies this channel. |
expiration
|
string |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
address
|
string |
The address where notifications are delivered for this channel. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Channel
|
object |
Properties
type
|
string |
The type of delivery mechanism used for this channel. |
token
|
string |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
resourceUri
|
string |
A version-specific identifier for the watched resource. |
resourceId
|
string |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
payload
|
boolean |
A Boolean value to indicate whether payload is wanted. Optional. |
params
|
object |
Additional parameters controlling delivery channel behavior. Optional. |
kind
|
string Default value: api#channel
|
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
id
|
string |
A UUID or similar unique string that identifies this channel. |
expiration
|
string |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
address
|
string |
The address where notifications are delivered for this channel. |
Deletes an access control rule.
Request
Path
| Name | Data Type | Description |
|---|---|---|
ruleId
|
string |
ACL rule identifier. |
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Returns an access control rule.
Request
Path
| Name | Data Type | Description |
|---|---|---|
ruleId
|
string |
ACL rule identifier. |
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AclRule
|
object |
Properties
scope
|
||
role
|
string |
The role assigned to the scope. Possible values are:
|
kind
|
string Default value: calendar#aclRule
|
Type of the resource ("calendar#aclRule"). |
id
|
string |
Identifier of the ACL rule. |
etag
|
string |
ETag of the resource. |
Updates an access control rule. This method supports patch semantics.
Request
Path
| Name | Data Type | Description |
|---|---|---|
ruleId
|
string |
ACL rule identifier. |
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
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
| Name | Data Type | Description |
|---|---|---|
AclRule
|
object |
Properties
scope
|
||
role
|
string |
The role assigned to the scope. Possible values are:
|
kind
|
string Default value: calendar#aclRule
|
Type of the resource ("calendar#aclRule"). |
id
|
string |
Identifier of the ACL rule. |
etag
|
string |
ETag of the resource. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AclRule
|
object |
Properties
scope
|
||
role
|
string |
The role assigned to the scope. Possible values are:
|
kind
|
string Default value: calendar#aclRule
|
Type of the resource ("calendar#aclRule"). |
id
|
string |
Identifier of the ACL rule. |
etag
|
string |
ETag of the resource. |
Updates an access control rule.
Request
Path
| Name | Data Type | Description |
|---|---|---|
ruleId
|
string |
ACL rule identifier. |
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
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
| Name | Data Type | Description |
|---|---|---|
AclRule
|
object |
Properties
scope
|
||
role
|
string |
The role assigned to the scope. Possible values are:
|
kind
|
string Default value: calendar#aclRule
|
Type of the resource ("calendar#aclRule"). |
id
|
string |
Identifier of the ACL rule. |
etag
|
string |
ETag of the resource. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AclRule
|
object |
Properties
scope
|
||
role
|
string |
The role assigned to the scope. Possible values are:
|
kind
|
string Default value: calendar#aclRule
|
Type of the resource ("calendar#aclRule"). |
id
|
string |
Identifier of the ACL rule. |
etag
|
string |
ETag of the resource. |
Returns the rules in the access control list for the calendar.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
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. 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. |
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. |
pageToken
|
string |
Token specifying which result page to return. Optional. |
maxResults
|
integer Minimum: 1 |
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. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Acl
|
object |
Properties
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. |
|||||||||||||||||||
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. |
|||||||||||||||||||
kind
|
string Default value: calendar#acl
|
Type of the collection ("calendar#acl"). |
|||||||||||||||||||
items
|
array [AclRule] |
List of rules on the access control list. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
etag
|
string |
ETag of the collection. |
|||||||||||||||||||
Creates an access control rule.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
sendNotifications
|
boolean |
Whether to send notifications about the calendar sharing change. Optional. The default is True. |
Body
| Name | Data Type | Description |
|---|---|---|
AclRule
|
object |
Properties
scope
|
||
role
|
string |
The role assigned to the scope. Possible values are:
|
kind
|
string Default value: calendar#aclRule
|
Type of the resource ("calendar#aclRule"). |
id
|
string |
Identifier of the ACL rule. |
etag
|
string |
ETag of the resource. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AclRule
|
object |
Properties
scope
|
||
role
|
string |
The role assigned to the scope. Possible values are:
|
kind
|
string Default value: calendar#aclRule
|
Type of the resource ("calendar#aclRule"). |
id
|
string |
Identifier of the ACL rule. |
etag
|
string |
ETag of the resource. |
calendarList
Watch for changes to CalendarList resources.
Request
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
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. |
showHidden
|
boolean |
Whether to show hidden entries. Optional. The default is False. |
showDeleted
|
boolean |
Whether to include deleted calendar list entries in the result. Optional. The default is False. |
pageToken
|
string |
Token specifying which result page to return. Optional. |
minAccessRole
|
string Allowed values: - freeBusyReader- owner- reader- writer |
The minimum access role for the user in the returned entries. Optional. The default is no restriction. |
maxResults
|
integer Minimum: 1 |
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. |
Body
| Name | Data Type | Description |
|---|---|---|
Channel
|
object |
Properties
type
|
string |
The type of delivery mechanism used for this channel. |
token
|
string |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
resourceUri
|
string |
A version-specific identifier for the watched resource. |
resourceId
|
string |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
payload
|
boolean |
A Boolean value to indicate whether payload is wanted. Optional. |
params
|
object |
Additional parameters controlling delivery channel behavior. Optional. |
kind
|
string Default value: api#channel
|
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
id
|
string |
A UUID or similar unique string that identifies this channel. |
expiration
|
string |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
address
|
string |
The address where notifications are delivered for this channel. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Channel
|
object |
Properties
type
|
string |
The type of delivery mechanism used for this channel. |
token
|
string |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
resourceUri
|
string |
A version-specific identifier for the watched resource. |
resourceId
|
string |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
payload
|
boolean |
A Boolean value to indicate whether payload is wanted. Optional. |
params
|
object |
Additional parameters controlling delivery channel behavior. Optional. |
kind
|
string Default value: api#channel
|
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
id
|
string |
A UUID or similar unique string that identifies this channel. |
expiration
|
string |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
address
|
string |
The address where notifications are delivered for this channel. |
Removes a calendar from the user's calendar list.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Returns a calendar from the user's calendar list.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CalendarListEntry
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. Optional. Read-only. |
||||||||||
summaryOverride
|
string |
The summary that the authenticated user has set for this calendar. Optional. |
||||||||||
summary
|
string |
Title of the calendar. Read-only. |
||||||||||
selected
|
boolean Default value: false
|
Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
||||||||||
primary
|
boolean Default value: false
|
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
||||||||||
notificationSettings
|
||||||||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. Read-only. |
||||||||||
kind
|
string Default value: calendar#calendarListEntry
|
Type of the resource ("calendar#calendarListEntry"). |
||||||||||
id
|
string |
Identifier of the calendar. |
||||||||||
hidden
|
boolean Default value: false
|
Whether the calendar has been hidden from the list. Optional. The default is False. |
||||||||||
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 property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. |
||||||||||
etag
|
string |
ETag of the resource. |
||||||||||
description
|
string |
Description of the calendar. Optional. Read-only. |
||||||||||
deleted
|
boolean Default value: false
|
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
||||||||||
defaultReminders
|
array [EventReminder] |
The default reminders that the authenticated user has for this calendar. |
||||||||||
Properties
|
||||||||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
||||||||||
Properties
|
||||||||||||
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. |
||||||||||
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. |
||||||||||
accessRole
|
string |
The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
|
||||||||||
Updates an existing calendar on the user's calendar list. This method supports patch semantics.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
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
| Name | Data Type | Description |
|---|---|---|
CalendarListEntry
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. Optional. Read-only. |
||||||||||
summaryOverride
|
string |
The summary that the authenticated user has set for this calendar. Optional. |
||||||||||
summary
|
string |
Title of the calendar. Read-only. |
||||||||||
selected
|
boolean Default value: false
|
Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
||||||||||
primary
|
boolean Default value: false
|
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
||||||||||
notificationSettings
|
||||||||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. Read-only. |
||||||||||
kind
|
string Default value: calendar#calendarListEntry
|
Type of the resource ("calendar#calendarListEntry"). |
||||||||||
id
|
string |
Identifier of the calendar. |
||||||||||
hidden
|
boolean Default value: false
|
Whether the calendar has been hidden from the list. Optional. The default is False. |
||||||||||
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 property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. |
||||||||||
etag
|
string |
ETag of the resource. |
||||||||||
description
|
string |
Description of the calendar. Optional. Read-only. |
||||||||||
deleted
|
boolean Default value: false
|
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
||||||||||
defaultReminders
|
array [EventReminder] |
The default reminders that the authenticated user has for this calendar. |
||||||||||
Properties
|
||||||||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
||||||||||
Properties
|
||||||||||||
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. |
||||||||||
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. |
||||||||||
accessRole
|
string |
The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
|
||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CalendarListEntry
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. Optional. Read-only. |
||||||||||
summaryOverride
|
string |
The summary that the authenticated user has set for this calendar. Optional. |
||||||||||
summary
|
string |
Title of the calendar. Read-only. |
||||||||||
selected
|
boolean Default value: false
|
Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
||||||||||
primary
|
boolean Default value: false
|
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
||||||||||
notificationSettings
|
||||||||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. Read-only. |
||||||||||
kind
|
string Default value: calendar#calendarListEntry
|
Type of the resource ("calendar#calendarListEntry"). |
||||||||||
id
|
string |
Identifier of the calendar. |
||||||||||
hidden
|
boolean Default value: false
|
Whether the calendar has been hidden from the list. Optional. The default is False. |
||||||||||
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 property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. |
||||||||||
etag
|
string |
ETag of the resource. |
||||||||||
description
|
string |
Description of the calendar. Optional. Read-only. |
||||||||||
deleted
|
boolean Default value: false
|
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
||||||||||
defaultReminders
|
array [EventReminder] |
The default reminders that the authenticated user has for this calendar. |
||||||||||
Properties
|
||||||||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
||||||||||
Properties
|
||||||||||||
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. |
||||||||||
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. |
||||||||||
accessRole
|
string |
The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
|
||||||||||
Updates an existing calendar on the user's calendar list.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
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
| Name | Data Type | Description |
|---|---|---|
CalendarListEntry
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. Optional. Read-only. |
||||||||||
summaryOverride
|
string |
The summary that the authenticated user has set for this calendar. Optional. |
||||||||||
summary
|
string |
Title of the calendar. Read-only. |
||||||||||
selected
|
boolean Default value: false
|
Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
||||||||||
primary
|
boolean Default value: false
|
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
||||||||||
notificationSettings
|
||||||||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. Read-only. |
||||||||||
kind
|
string Default value: calendar#calendarListEntry
|
Type of the resource ("calendar#calendarListEntry"). |
||||||||||
id
|
string |
Identifier of the calendar. |
||||||||||
hidden
|
boolean Default value: false
|
Whether the calendar has been hidden from the list. Optional. The default is False. |
||||||||||
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 property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. |
||||||||||
etag
|
string |
ETag of the resource. |
||||||||||
description
|
string |
Description of the calendar. Optional. Read-only. |
||||||||||
deleted
|
boolean Default value: false
|
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
||||||||||
defaultReminders
|
array [EventReminder] |
The default reminders that the authenticated user has for this calendar. |
||||||||||
Properties
|
||||||||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
||||||||||
Properties
|
||||||||||||
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. |
||||||||||
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. |
||||||||||
accessRole
|
string |
The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
|
||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CalendarListEntry
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. Optional. Read-only. |
||||||||||
summaryOverride
|
string |
The summary that the authenticated user has set for this calendar. Optional. |
||||||||||
summary
|
string |
Title of the calendar. Read-only. |
||||||||||
selected
|
boolean Default value: false
|
Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
||||||||||
primary
|
boolean Default value: false
|
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
||||||||||
notificationSettings
|
||||||||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. Read-only. |
||||||||||
kind
|
string Default value: calendar#calendarListEntry
|
Type of the resource ("calendar#calendarListEntry"). |
||||||||||
id
|
string |
Identifier of the calendar. |
||||||||||
hidden
|
boolean Default value: false
|
Whether the calendar has been hidden from the list. Optional. The default is False. |
||||||||||
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 property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. |
||||||||||
etag
|
string |
ETag of the resource. |
||||||||||
description
|
string |
Description of the calendar. Optional. Read-only. |
||||||||||
deleted
|
boolean Default value: false
|
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
||||||||||
defaultReminders
|
array [EventReminder] |
The default reminders that the authenticated user has for this calendar. |
||||||||||
Properties
|
||||||||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
||||||||||
Properties
|
||||||||||||
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. |
||||||||||
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. |
||||||||||
accessRole
|
string |
The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
|
||||||||||
Returns the calendars on the user's calendar list.
Request
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
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. |
showHidden
|
boolean |
Whether to show hidden entries. Optional. The default is False. |
showDeleted
|
boolean |
Whether to include deleted calendar list entries in the result. Optional. The default is False. |
pageToken
|
string |
Token specifying which result page to return. Optional. |
minAccessRole
|
string Allowed values: - freeBusyReader- owner- reader- writer |
The minimum access role for the user in the returned entries. Optional. The default is no restriction. |
maxResults
|
integer Minimum: 1 |
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. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CalendarList
|
object |
Properties
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: calendar#calendarList
|
Type of the collection ("calendar#calendarList"). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [CalendarListEntry] |
Calendars that are present on the user's calendar list. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of the collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Inserts an existing calendar into the user's calendar list.
Request
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
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
| Name | Data Type | Description |
|---|---|---|
CalendarListEntry
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. Optional. Read-only. |
||||||||||
summaryOverride
|
string |
The summary that the authenticated user has set for this calendar. Optional. |
||||||||||
summary
|
string |
Title of the calendar. Read-only. |
||||||||||
selected
|
boolean Default value: false
|
Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
||||||||||
primary
|
boolean Default value: false
|
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
||||||||||
notificationSettings
|
||||||||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. Read-only. |
||||||||||
kind
|
string Default value: calendar#calendarListEntry
|
Type of the resource ("calendar#calendarListEntry"). |
||||||||||
id
|
string |
Identifier of the calendar. |
||||||||||
hidden
|
boolean Default value: false
|
Whether the calendar has been hidden from the list. Optional. The default is False. |
||||||||||
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 property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. |
||||||||||
etag
|
string |
ETag of the resource. |
||||||||||
description
|
string |
Description of the calendar. Optional. Read-only. |
||||||||||
deleted
|
boolean Default value: false
|
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
||||||||||
defaultReminders
|
array [EventReminder] |
The default reminders that the authenticated user has for this calendar. |
||||||||||
Properties
|
||||||||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
||||||||||
Properties
|
||||||||||||
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. |
||||||||||
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. |
||||||||||
accessRole
|
string |
The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
|
||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CalendarListEntry
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. Optional. Read-only. |
||||||||||
summaryOverride
|
string |
The summary that the authenticated user has set for this calendar. Optional. |
||||||||||
summary
|
string |
Title of the calendar. Read-only. |
||||||||||
selected
|
boolean Default value: false
|
Whether the calendar content shows up in the calendar UI. Optional. The default is False. |
||||||||||
primary
|
boolean Default value: false
|
Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. |
||||||||||
notificationSettings
|
||||||||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. Read-only. |
||||||||||
kind
|
string Default value: calendar#calendarListEntry
|
Type of the resource ("calendar#calendarListEntry"). |
||||||||||
id
|
string |
Identifier of the calendar. |
||||||||||
hidden
|
boolean Default value: false
|
Whether the calendar has been hidden from the list. Optional. The default is False. |
||||||||||
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 property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. |
||||||||||
etag
|
string |
ETag of the resource. |
||||||||||
description
|
string |
Description of the calendar. Optional. Read-only. |
||||||||||
deleted
|
boolean Default value: false
|
Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. |
||||||||||
defaultReminders
|
array [EventReminder] |
The default reminders that the authenticated user has for this calendar. |
||||||||||
Properties
|
||||||||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
||||||||||
Properties
|
||||||||||||
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. |
||||||||||
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. |
||||||||||
accessRole
|
string |
The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
|
||||||||||
calendars
Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Returns metadata for a calendar.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Calendar
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
|||||||
summary
|
string |
Title of the calendar. |
|||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. |
|||||||
kind
|
string Default value: calendar#calendar
|
Type of the resource ("calendar#calendar"). |
|||||||
id
|
string |
Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
|||||||
etag
|
string |
ETag of the resource. |
|||||||
description
|
string |
Description of the calendar. Optional. |
|||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
|||||||
Properties
|
|||||||||
Updates metadata for a calendar. This method supports patch semantics.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
Calendar
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
|||||||
summary
|
string |
Title of the calendar. |
|||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. |
|||||||
kind
|
string Default value: calendar#calendar
|
Type of the resource ("calendar#calendar"). |
|||||||
id
|
string |
Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
|||||||
etag
|
string |
ETag of the resource. |
|||||||
description
|
string |
Description of the calendar. Optional. |
|||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
|||||||
Properties
|
|||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Calendar
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
|||||||
summary
|
string |
Title of the calendar. |
|||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. |
|||||||
kind
|
string Default value: calendar#calendar
|
Type of the resource ("calendar#calendar"). |
|||||||
id
|
string |
Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
|||||||
etag
|
string |
ETag of the resource. |
|||||||
description
|
string |
Description of the calendar. Optional. |
|||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
|||||||
Properties
|
|||||||||
Updates metadata for a calendar.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
Calendar
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
|||||||
summary
|
string |
Title of the calendar. |
|||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. |
|||||||
kind
|
string Default value: calendar#calendar
|
Type of the resource ("calendar#calendar"). |
|||||||
id
|
string |
Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
|||||||
etag
|
string |
ETag of the resource. |
|||||||
description
|
string |
Description of the calendar. Optional. |
|||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
|||||||
Properties
|
|||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Calendar
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
|||||||
summary
|
string |
Title of the calendar. |
|||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. |
|||||||
kind
|
string Default value: calendar#calendar
|
Type of the resource ("calendar#calendar"). |
|||||||
id
|
string |
Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
|||||||
etag
|
string |
ETag of the resource. |
|||||||
description
|
string |
Description of the calendar. Optional. |
|||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
|||||||
Properties
|
|||||||||
Creates a secondary calendar.
Request
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
Calendar
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
|||||||
summary
|
string |
Title of the calendar. |
|||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. |
|||||||
kind
|
string Default value: calendar#calendar
|
Type of the resource ("calendar#calendar"). |
|||||||
id
|
string |
Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
|||||||
etag
|
string |
ETag of the resource. |
|||||||
description
|
string |
Description of the calendar. Optional. |
|||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
|||||||
Properties
|
|||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Calendar
|
object |
Properties
timeZone
|
string |
The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
|||||||
summary
|
string |
Title of the calendar. |
|||||||
location
|
string |
Geographic location of the calendar as free-form text. Optional. |
|||||||
kind
|
string Default value: calendar#calendar
|
Type of the resource ("calendar#calendar"). |
|||||||
id
|
string |
Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
|||||||
etag
|
string |
ETag of the resource. |
|||||||
description
|
string |
Description of the calendar. Optional. |
|||||||
conferenceProperties
|
ConferenceProperties |
Conferencing properties for this calendar, for example what types of conferences are allowed. |
|||||||
Properties
|
|||||||||
channels
Stop watching resources through this channel
Request
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Body
| Name | Data Type | Description |
|---|---|---|
Channel
|
object |
Properties
type
|
string |
The type of delivery mechanism used for this channel. |
token
|
string |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
resourceUri
|
string |
A version-specific identifier for the watched resource. |
resourceId
|
string |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
payload
|
boolean |
A Boolean value to indicate whether payload is wanted. Optional. |
params
|
object |
Additional parameters controlling delivery channel behavior. Optional. |
kind
|
string Default value: api#channel
|
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
id
|
string |
A UUID or similar unique string that identifies this channel. |
expiration
|
string |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
address
|
string |
The address where notifications are delivered for this channel. |
Responses
colors
Returns the color definitions for calendars and events.
Request
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Colors
|
object |
Properties
updated
|
dateTime |
Last modification time of the color palette (as a RFC3339 timestamp). Read-only. |
kind
|
string Default value: calendar#colors
|
Type of the resource ("calendar#colors"). |
event
|
object |
A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only. |
calendar
|
object |
A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only. |
events
Imports an event. This operation is used to add a private copy of an existing event to a calendar.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
supportsAttachments
|
boolean |
Whether API client performing operation supports event attachments. Optional. The default is False. |
conferenceDataVersion
|
integer Minimum: 0 Maximum: 1 |
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. |
Body
| Name | Data Type | Description |
|---|---|---|
Event
|
object |
Properties
visibility
|
string Default value: default
|
Visibility of the event. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated
|
dateTime |
Last modification time of the event (as a RFC3339 timestamp). Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transparency
|
string Default value: opaque
|
Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
summary
|
string |
Title of the event. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string |
Status of the event. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start
|
EventDateTime |
The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sequence
|
integer |
Sequence number as per iCalendar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reminders
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recurringEventId
|
string |
For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recurrence
|
array [string] |
List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateCopy
|
boolean Default value: false
|
If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
originalStartTime
|
EventDateTime |
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
organizer
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locked
|
boolean Default value: false
|
Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location
|
string |
Geographic location of the event as free-form text. Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: calendar#event
|
Type of the resource ("calendar#event"). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iCalUID
|
string |
Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
htmlLink
|
string |
An absolute link to this event in the Google Calendar Web UI. Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hangoutLink
|
string |
An absolute link to the Google+ hangout associated with this event. Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanSeeOtherGuests
|
boolean Default value: true
|
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanModify
|
boolean Default value: false
|
Whether attendees other than the organizer can modify the event. Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanInviteOthers
|
boolean Default value: true
|
Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gadget
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
extendedProperties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of the resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
endTimeUnspecified
|
boolean Default value: false
|
Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
end
|
EventDateTime |
The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
string |
Description of the event. Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creator
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created
|
dateTime |
Creation time of the event (as a RFC3339 timestamp). Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
conferenceData
|
ConferenceData |
The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
colorId
|
string |
The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attendeesOmitted
|
boolean Default value: false
|
Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attendees
|
array [EventAttendee] |
The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attachments
|
array [EventAttachment] |
File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event, |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
anyoneCanAddSelf
|
boolean Default value: false
|
Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Event
|
object |
Properties
visibility
|
string Default value: default
|
Visibility of the event. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated
|
dateTime |
Last modification time of the event (as a RFC3339 timestamp). Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transparency
|
string Default value: opaque
|
Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
summary
|
string |
Title of the event. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string |
Status of the event. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start
|
EventDateTime |
The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sequence
|
integer |
Sequence number as per iCalendar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reminders
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recurringEventId
|
string |
For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recurrence
|
array [string] |
List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateCopy
|
boolean Default value: false
|
If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
originalStartTime
|
EventDateTime |
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
organizer
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locked
|
boolean Default value: false
|
Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location
|
string |
Geographic location of the event as free-form text. Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: calendar#event
|
Type of the resource ("calendar#event"). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iCalUID
|
string |
Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
htmlLink
|
string |
An absolute link to this event in the Google Calendar Web UI. Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hangoutLink
|
string |
An absolute link to the Google+ hangout associated with this event. Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanSeeOtherGuests
|
boolean Default value: true
|
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanModify
|
boolean Default value: false
|
Whether attendees other than the organizer can modify the event. Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanInviteOthers
|
boolean Default value: true
|
Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gadget
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
extendedProperties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of the resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
endTimeUnspecified
|
boolean Default value: false
|
Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
end
|
EventDateTime |
The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
string |
Description of the event. Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creator
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created
|
dateTime |
Creation time of the event (as a RFC3339 timestamp). Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
conferenceData
|
ConferenceData |
The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
colorId
|
string |
The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attendeesOmitted
|
boolean Default value: false
|
Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attendees
|
array [EventAttendee] |
The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attachments
|
array [EventAttachment] |
File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event, |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
anyoneCanAddSelf
|
boolean Default value: false
|
Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Creates an event based on a simple text string.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
text
|
string |
The text describing the event to be created. |
sendUpdates
|
string Allowed values: - all- externalOnly- none |
Guests who should receive notifications about the creation of the new event. |
sendNotifications
|
boolean |
Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Event
|
object |
Properties
visibility
|
string Default value: default
|
Visibility of the event. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated
|
dateTime |
Last modification time of the event (as a RFC3339 timestamp). Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transparency
|
string Default value: opaque
|
Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
summary
|
string |
Title of the event. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string |
Status of the event. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start
|
EventDateTime |
The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sequence
|
integer |
Sequence number as per iCalendar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reminders
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recurringEventId
|
string |
For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recurrence
|
array [string] |
List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateCopy
|
boolean Default value: false
|
If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
originalStartTime
|
EventDateTime |
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
organizer
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locked
|
boolean Default value: false
|
Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location
|
string |
Geographic location of the event as free-form text. Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: calendar#event
|
Type of the resource ("calendar#event"). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iCalUID
|
string |
Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
htmlLink
|
string |
An absolute link to this event in the Google Calendar Web UI. Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hangoutLink
|
string |
An absolute link to the Google+ hangout associated with this event. Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanSeeOtherGuests
|
boolean Default value: true
|
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanModify
|
boolean Default value: false
|
Whether attendees other than the organizer can modify the event. Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanInviteOthers
|
boolean Default value: true
|
Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gadget
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
extendedProperties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of the resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
endTimeUnspecified
|
boolean Default value: false
|
Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
end
|
EventDateTime |
The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
string |
Description of the event. Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creator
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created
|
dateTime |
Creation time of the event (as a RFC3339 timestamp). Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
conferenceData
|
ConferenceData |
The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
colorId
|
string |
The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attendeesOmitted
|
boolean Default value: false
|
Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attendees
|
array [EventAttendee] |
The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attachments
|
array [EventAttachment] |
File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event, |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
anyoneCanAddSelf
|
boolean Default value: false
|
Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Watch for changes to Events resources.
Request
Path
| Name | Data Type | Description |
|---|---|---|
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
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. |
timeZone
|
string |
Time zone used in the response. Optional. The default is the time zone of the calendar. |
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. |
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. |
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. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are:
|
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. |
showHiddenInvitations
|
boolean |
Whether to include hidden invitations in the result. Optional. The default is False. |
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. |
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. |
q
|
string |
Free text search terms to find events that match these terms in any field, except for extended properties. 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. |
pageToken
|
string |
Token specifying which result page to return. Optional. |
orderBy
|
string Allowed values: - startTime- updated |
The order of the events returned in the result. Optional. The default is an unspecified, stable order. |
maxResults
|
integer Default value: 250Minimum: 1 |
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. |
maxAttendees
|
integer Minimum: 1 |
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. |
iCalUID
|
string |
Specifies event ID in the iCalendar format to be included in the response. Optional. |
alwaysIncludeEmail
|
boolean |
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. |
Body
| Name | Data Type | Description |
|---|---|---|
Channel
|
object |
Properties
type
|
string |
The type of delivery mechanism used for this channel. |
token
|
string |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
resourceUri
|
string |
A version-specific identifier for the watched resource. |
resourceId
|
string |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
payload
|
boolean |
A Boolean value to indicate whether payload is wanted. Optional. |
params
|
object |
Additional parameters controlling delivery channel behavior. Optional. |
kind
|
string Default value: api#channel
|
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
id
|
string |
A UUID or similar unique string that identifies this channel. |
expiration
|
string |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
address
|
string |
The address where notifications are delivered for this channel. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Channel
|
object |
Properties
type
|
string |
The type of delivery mechanism used for this channel. |
token
|
string |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
resourceUri
|
string |
A version-specific identifier for the watched resource. |
resourceId
|
string |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
payload
|
boolean |
A Boolean value to indicate whether payload is wanted. Optional. |
params
|
object |
Additional parameters controlling delivery channel behavior. Optional. |
kind
|
string Default value: api#channel
|
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
id
|
string |
A UUID or similar unique string that identifies this channel. |
expiration
|
string |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
address
|
string |
The address where notifications are delivered for this channel. |
Returns instances of the specified recurring event.
Request
Path
| Name | Data Type | Description |
|---|---|---|
eventId
|
string |
Recurring event identifier. |
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
timeZone
|
string |
Time zone used in the response. Optional. The default is the time zone of the calendar. |
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. |
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. |
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. |
pageToken
|
string |
Token specifying which result page to return. Optional. |
originalStart
|
string |
The original start time of the instance in the result. Optional. |
maxResults
|
integer Minimum: 1 |
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. |
maxAttendees
|
integer Minimum: 1 |
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. |
alwaysIncludeEmail
|
boolean |
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Events
|
object |
Properties
updated
|
dateTime |
Last modification time of the calendar (as a RFC3339 timestamp). Read-only. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
timeZone
|
string |
The time zone of the calendar. Read-only. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
summary
|
string |
Title of the calendar. Read-only. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: calendar#events
|
Type of the collection ("calendar#events"). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [Event] |
List of events on the calendar. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of the collection. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
string |
Description of the calendar. Read-only. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
defaultReminders
|
array [EventReminder] |
The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accessRole
|
string |
The user's access role for this calendar. Read-only. Possible values are:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Moves an event to another calendar, i.e. changes an event's organizer.
Request
Path
| Name | Data Type | Description |
|---|---|---|
eventId
|
string |
Event identifier. |
calendarId
|
string |
Calendar identifier of the source calendar where the event currently is on. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
sendUpdates
|
string Allowed values: - all- externalOnly- none |
Guests who should receive notifications about the change of the event's organizer. |
sendNotifications
|
boolean |
Deprecated. Please use sendUpdates instead. Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false. |
destination
|
string |
Calendar identifier of the target calendar where the event is to be moved to. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Event
|
object |
Properties
visibility
|
string Default value: default
|
Visibility of the event. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated
|
dateTime |
Last modification time of the event (as a RFC3339 timestamp). Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transparency
|
string Default value: opaque
|
Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
summary
|
string |
Title of the event. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string |
Status of the event. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start
|
EventDateTime |
The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sequence
|
integer |
Sequence number as per iCalendar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reminders
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recurringEventId
|
string |
For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recurrence
|
array [string] |
List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateCopy
|
boolean Default value: false
|
If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
originalStartTime
|
EventDateTime |
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
organizer
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locked
|
boolean Default value: false
|
Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location
|
string |
Geographic location of the event as free-form text. Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: calendar#event
|
Type of the resource ("calendar#event"). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iCalUID
|
string |
Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
htmlLink
|
string |
An absolute link to this event in the Google Calendar Web UI. Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hangoutLink
|
string |
An absolute link to the Google+ hangout associated with this event. Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanSeeOtherGuests
|
boolean Default value: true
|
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanModify
|
boolean Default value: false
|
Whether attendees other than the organizer can modify the event. Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanInviteOthers
|
boolean Default value: true
|
Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gadget
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
extendedProperties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of the resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
endTimeUnspecified
|
boolean Default value: false
|
Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
end
|
EventDateTime |
The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
string |
Description of the event. Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creator
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created
|
dateTime |
Creation time of the event (as a RFC3339 timestamp). Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
conferenceData
|
ConferenceData |
The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
colorId
|
string |
The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attendeesOmitted
|
boolean Default value: false
|
Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attendees
|
array [EventAttendee] |
The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attachments
|
array [EventAttachment] |
File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event, |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
anyoneCanAddSelf
|
boolean Default value: false
|
Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Deletes an event.
Request
Path
| Name | Data Type | Description |
|---|---|---|
eventId
|
string |
Event identifier. |
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
sendUpdates
|
string Allowed values: - all- externalOnly- none |
Guests who should receive notifications about the deletion of the event. |
sendNotifications
|
boolean |
Deprecated. Please use sendUpdates instead. Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false. |
Responses
Returns an event.
Request
Path
| Name | Data Type | Description |
|---|---|---|
eventId
|
string |
Event identifier. |
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
timeZone
|
string |
Time zone used in the response. Optional. The default is the time zone of the calendar. |
maxAttendees
|
integer Minimum: 1 |
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. |
alwaysIncludeEmail
|
boolean |
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Event
|
object |
Properties
visibility
|
string Default value: default
|
Visibility of the event. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated
|
dateTime |
Last modification time of the event (as a RFC3339 timestamp). Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transparency
|
string Default value: opaque
|
Whether the event blocks time on the calendar. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
summary
|
string |
Title of the event. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string |
Status of the event. Optional. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start
|
EventDateTime |
The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sequence
|
integer |
Sequence number as per iCalendar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reminders
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recurringEventId
|
string |
For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recurrence
|
array [string] |
List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
privateCopy
|
boolean Default value: false
|
If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
originalStartTime
|
EventDateTime |
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
organizer
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locked
|
boolean Default value: false
|
Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location
|
string |
Geographic location of the event as free-form text. Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: calendar#event
|
Type of the resource ("calendar#event"). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iCalUID
|
string |
Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
htmlLink
|
string |
An absolute link to this event in the Google Calendar Web UI. Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hangoutLink
|
string |
An absolute link to the Google+ hangout associated with this event. Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanSeeOtherGuests
|
boolean Default value: true
|
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanModify
|
boolean Default value: false
|
Whether attendees other than the organizer can modify the event. Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
guestsCanInviteOthers
|
boolean Default value: true
|
Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gadget
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
extendedProperties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of the resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
endTimeUnspecified
|
boolean Default value: false
|
Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
end
|
EventDateTime |
The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
string |
Description of the event. Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creator
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created
|
dateTime |
Creation time of the event (as a RFC3339 timestamp). Read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
conferenceData
|
ConferenceData |
The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
colorId
|
string |
The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attendeesOmitted
|
boolean Default value: false
|
Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attendees
|
array [EventAttendee] |
The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attachments
|
array [EventAttachment] |
File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event, |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
anyoneCanAddSelf
|
boolean Default value: false
|
Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Updates an event. This method supports patch semantics.
Request
Path
| Name | Data Type | Description |
|---|---|---|
eventId
|
string |
Event identifier. |
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. |
Query
| Name | Data Type | Description |
|---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
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. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: jsonAllowed values: - json |
Data format for the response. |
supportsAttachments
|
boolean |
Whether API client performing operation supports event attachments. Optional. The default is False. |
sendUpdates
|
string Allowed values: - all- externalOnly- none |
Guests who should receive notifications about the event update (for example, title changes, etc.). |
sendNotifications
|
boolean |
Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false. |
maxAttendees
|
integer Minimum: 1 |
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. |
conferenceDataVersion
|
integer Minimum: 0 Maximum: 1 |
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. |
alwaysIncludeEmail
|
boolean |
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. |
Body
| Name | Data Type | Description |
|---|---|---|
Event
|
object |
Properties
visibility
|
string Default value: default
|
Visibility of the event. Optional. Possible values are:
|
|||||||||||||
updated
|
dateTime |
Last modification time of the event (as a RFC3339 timestamp). Read-only. |
|||||||||||||
transparency
|
string Default value: opaque
|
Whether the event blocks time on the calendar. Optional. Possible values are:
|
|||||||||||||
summary
|
string |
Title of the event. |
|||||||||||||
status
|
string |
Status of the event. Optional. Possible values are:
|
|||||||||||||
start
|
EventDateTime |
The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
|||||||||||||
Properties
|
|||||||||||||||
source
|
|||||||||||||||
sequence
|
integer |
Sequence number as per iCalendar. |
|||||||||||||
reminders
|
|||||||||||||||
recurringEventId
|
string |
For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
|||||||||||||
recurrence
|
array [string] |
List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. |
|||||||||||||
privateCopy
|
boolean Default value: false
|
If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. |
|||||||||||||
originalStartTime
|
EventDateTime |
For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. |
|||||||||||||
Properties
| |||||||||||||||