►Calendar API v3
1 API Parameters
_
2 Resources
2.1 calendars
calendar-calendars-get
calendar-calendars-insert
calendar-calendars-patch
calendar-calendars-clear
calendar-calendars-delete
calendar-calendars-update
2.2 acl
calendar-acl-list
calendar-acl-get
calendar-acl-insert
calendar-acl-patch
calendar-acl-delete
calendar-acl-update
2.3 calendar List
calendar-calendar List-list
calendar-calendar List-get
calendar-calendar List-insert
calendar-calendar List-patch
calendar-calendar List-delete
calendar-calendar List-update
2.4 colors
calendar-colors-get
2.5 events
calendar-events-list
calendar-events-get
calendar-events-import
calendar-events-insert
calendar-events-patch
calendar-events-instances
calendar-events-move
calendar-events-quick Add
calendar-events-delete
calendar-events-update
2.6 freebusy
calendar-freebusy-query
2.7 settings
calendar-settings-list
calendar-settings-get
Version: 5.3

Calendar API v3

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you manipulate events and other calendar data. Google documentation.

    1 API Parameters

    2 Resources

      2.1 calendars

      2.2 acl

      2.3 calendarList

      2.4 colors

      2.5 events

      2.6 freebusy

      2.7 settings

 (require gapi/macro)
(require-gapi-doc calendar.v3.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure

(_ [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 calendars

procedure

(calendar-calendars-get #:calendarId calendarId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns metadata for a calendar.

calendarId: Calendar identifier.

procedure

(calendar-calendars-insert [#:id id    
  #:description description    
  #:kind kind    
  #:etag etag    
  #:location location    
  #:summary summary    
  #:timeZone timeZone    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  id : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  location : string? = 'N/A
  summary : string? = 'N/A
  timeZone : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Creates a secondary calendar.

id: Identifier of the calendar.

description: Description of the calendar. Optional.

kind: Type of the resource ("calendar#calendar").

etag: ETag of the resource.

location: Geographic location of the calendar as free-form text. Optional.

summary: Title of the calendar.

timeZone: The time zone of the calendar. Optional.

procedure

(calendar-calendars-patch #:calendarId calendarId    
  [#:id id    
  #:description description    
  #:kind kind    
  #:etag etag    
  #:location location    
  #:summary summary    
  #:timeZone timeZone    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  id : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  location : string? = 'N/A
  summary : string? = 'N/A
  timeZone : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Updates metadata for a calendar. This method supports patch semantics.

calendarId: Calendar identifier.

id: Identifier of the calendar.

description: Description of the calendar. Optional.

kind: Type of the resource ("calendar#calendar").

etag: ETag of the resource.

location: Geographic location of the calendar as free-form text. Optional.

summary: Title of the calendar.

timeZone: The time zone of the calendar. Optional.

procedure

(calendar-calendars-clear #:calendarId calendarId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Clears a primary calendar. This operation deletes all data associated with the primary calendar of an account and cannot be undone.

calendarId: Calendar identifier.

procedure

(calendar-calendars-delete #:calendarId calendarId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Deletes a secondary calendar.

calendarId: Calendar identifier.

procedure

(calendar-calendars-update #:calendarId calendarId    
  [#:id id    
  #:description description    
  #:kind kind    
  #:etag etag    
  #:location location    
  #:summary summary    
  #:timeZone timeZone    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  id : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  location : string? = 'N/A
  summary : string? = 'N/A
  timeZone : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Updates metadata for a calendar.

calendarId: Calendar identifier.

id: Identifier of the calendar.

description: Description of the calendar. Optional.

kind: Type of the resource ("calendar#calendar").

etag: ETag of the resource.

location: Geographic location of the calendar as free-form text. Optional.

summary: Title of the calendar.

timeZone: The time zone of the calendar. Optional.

2.2 acl

procedure

(calendar-acl-list #:calendarId calendarId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns the rules in the access control list for the calendar.

calendarId: Calendar identifier.

procedure

(calendar-acl-get #:calendarId calendarId    
  #:ruleId ruleId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  ruleId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns an access control rule.

calendarId: Calendar identifier.

ruleId: ACL rule identifier.

procedure

(calendar-acl-insert #:calendarId calendarId    
  [#:id id    
  #:kind kind    
  #:etag etag    
  #:role role    
  #:scope scope    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  id : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  role : string? = 'N/A
  scope : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Creates an access control rule.

calendarId: Calendar identifier.

id: Identifier of the ACL rule.

kind: Type of the resource ("calendar#aclRule").

etag: ETag of the resource.

role: The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

scope: The scope of the rule.

procedure

(calendar-acl-patch #:calendarId calendarId    
  #:ruleId ruleId    
  [#:id id    
  #:kind kind    
  #:etag etag    
  #:role role    
  #:scope scope    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  ruleId : string?
  id : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  role : string? = 'N/A
  scope : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Updates an access control rule. This method supports patch semantics.

calendarId: Calendar identifier.

ruleId: ACL rule identifier.

id: Identifier of the ACL rule.

kind: Type of the resource ("calendar#aclRule").

etag: ETag of the resource.

role: The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

scope: The scope of the rule.

procedure

(calendar-acl-delete #:calendarId calendarId    
  #:ruleId ruleId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  ruleId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Deletes an access control rule.

calendarId: Calendar identifier.

ruleId: ACL rule identifier.

procedure

(calendar-acl-update #:calendarId calendarId    
  #:ruleId ruleId    
  [#:id id    
  #:kind kind    
  #:etag etag    
  #:role role    
  #:scope scope    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  ruleId : string?
  id : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  role : string? = 'N/A
  scope : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Updates an access control rule.

calendarId: Calendar identifier.

ruleId: ACL rule identifier.

id: Identifier of the ACL rule.

kind: Type of the resource ("calendar#aclRule").

etag: ETag of the resource.

role: The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

scope: The scope of the rule.

2.3 calendarList

procedure

(calendar-calendarList-list [#:maxResults maxResults 
  #:minAccessRole minAccessRole 
  #:pageToken pageToken 
  #:showHidden showHidden 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  maxResults : string? = 'N/A
  minAccessRole : string? = 'N/A
  pageToken : string? = 'N/A
  showHidden : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns entries on the user’s calendar list.

maxResults: Maximum number of entries returned on one result page. Optional.

minAccessRole: The minimum access role for the user in the returned entires. Optional. The default is no restriction.

pageToken: Token specifying which result page to return. Optional.

showHidden: Whether to show hidden entries. Optional. The default is False.

procedure

(calendar-calendarList-get #:calendarId calendarId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  calendarId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns an entry on the user’s calendar list.

calendarId: Calendar identifier.

procedure

(calendar-calendarList-insert 
  [#:colorRgbFormat colorRgbFormat 
  #:id id 
  #:description description 
  #:kind kind 
  #:etag etag 
  #:location location 
  #:summary summary 
  #:timeZone timeZone 
  #:accessRole accessRole 
  #:backgroundColor backgroundColor 
  #:colorId colorId 
  #:defaultReminders defaultReminders 
  #:foregroundColor foregroundColor 
  #:hidden hidden 
  #:selected selected 
  #:summaryOverride summaryOverride 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  colorRgbFormat : string? = 'N/A
  id : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  location : string? = 'N/A
  summary : string? = 'N/A
  timeZone : string? = 'N/A
  accessRole : string? = 'N/A
  backgroundColor : string? = 'N/A
  colorId : string? = 'N/A
  defaultReminders : string? = 'N/A
  foregroundColor : string? = 'N/A
  hidden : string? = 'N/A
  selected : string? = 'N/A
  summaryOverride : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Adds an entry to the user’s calendar list.

colorRgbFormat: Whether to use the ’frontendColor’ and ’backgroundColor’ fields to write the calendar colors (RGB). If this feature is used, the index-based ’color’ field will be set to the best matching option automatically. Optional. The default is False.

id: Identifier of the calendar.

description: Description of the calendar. Optional. Read-only.

kind: Type of the resource ("calendar#calendarListEntry").

etag: ETag of the resource.

location: Geographic location of the calendar as free-form text. Optional. Read-only.

summary: Title of the calendar. Read-only.

timeZone: The time zone of the calendar. Optional. Read-only.

accessRole: The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

backgroundColor: The main color of the calendar in the format ’#0088aa’. This property supersedes the index-based colorId property. Optional.

colorId: 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). Optional.

defaultReminders: The default reminders that the authenticated user has for this calendar.

foregroundColor: The foreground color of the calendar in the format ’#ffffff’. This property supersedes the index-based colorId property. Optional.

hidden: Whether the calendar has been hidden from the list. Optional. The default is False.

selected: Whether the calendar content shows up in the calendar UI. Optional. The default is False.

summaryOverride: The summary that the authenticated user has set for this calendar. Optional.

procedure

(calendar-calendarList-patch 
  #:calendarId calendarId 
  [#:colorRgbFormat colorRgbFormat 
  #:id id 
  #:description description 
  #:kind kind 
  #:etag etag 
  #:location location 
  #:summary summary 
  #:timeZone timeZone 
  #:accessRole accessRole 
  #:backgroundColor backgroundColor 
  #:colorId colorId 
  #:defaultReminders defaultReminders 
  #:foregroundColor foregroundColor 
  #:hidden hidden 
  #:selected selected 
  #:summaryOverride summaryOverride 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  colorRgbFormat : string? = 'N/A
  id : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  location : string? = 'N/A
  summary : string? = 'N/A
  timeZone : string? = 'N/A
  accessRole : string? = 'N/A
  backgroundColor : string? = 'N/A
  colorId : string? = 'N/A
  defaultReminders : string? = 'N/A
  foregroundColor : string? = 'N/A
  hidden : string? = 'N/A
  selected : string? = 'N/A
  summaryOverride : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Updates an entry on the user’s calendar list. This method supports patch semantics.

calendarId: Calendar identifier.

colorRgbFormat: Whether to use the ’frontendColor’ and ’backgroundColor’ fields to write the calendar colors (RGB). If this feature is used, the index-based ’color’ field will be set to the best matching option automatically. Optional. The default is False.

id: Identifier of the calendar.

description: Description of the calendar. Optional. Read-only.

kind: Type of the resource ("calendar#calendarListEntry").

etag: ETag of the resource.

location: Geographic location of the calendar as free-form text. Optional. Read-only.

summary: Title of the calendar. Read-only.

timeZone: The time zone of the calendar. Optional. Read-only.

accessRole: The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

backgroundColor: The main color of the calendar in the format ’#0088aa’. This property supersedes the index-based colorId property. Optional.

colorId: 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). Optional.

defaultReminders: The default reminders that the authenticated user has for this calendar.

foregroundColor: The foreground color of the calendar in the format ’#ffffff’. This property supersedes the index-based colorId property. Optional.

hidden: Whether the calendar has been hidden from the list. Optional. The default is False.

selected: Whether the calendar content shows up in the calendar UI. Optional. The default is False.

summaryOverride: The summary that the authenticated user has set for this calendar. Optional.

procedure

(calendar-calendarList-delete #:calendarId calendarId 
  [#:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Deletes an entry on the user’s calendar list.

calendarId: Calendar identifier.

procedure

(calendar-calendarList-update 
  #:calendarId calendarId 
  [#:colorRgbFormat colorRgbFormat 
  #:id id 
  #:description description 
  #:kind kind 
  #:etag etag 
  #:location location 
  #:summary summary 
  #:timeZone timeZone 
  #:accessRole accessRole 
  #:backgroundColor backgroundColor 
  #:colorId colorId 
  #:defaultReminders defaultReminders 
  #:foregroundColor foregroundColor 
  #:hidden hidden 
  #:selected selected 
  #:summaryOverride summaryOverride 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  colorRgbFormat : string? = 'N/A
  id : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  location : string? = 'N/A
  summary : string? = 'N/A
  timeZone : string? = 'N/A
  accessRole : string? = 'N/A
  backgroundColor : string? = 'N/A
  colorId : string? = 'N/A
  defaultReminders : string? = 'N/A
  foregroundColor : string? = 'N/A
  hidden : string? = 'N/A
  selected : string? = 'N/A
  summaryOverride : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Updates an entry on the user’s calendar list.

calendarId: Calendar identifier.

colorRgbFormat: Whether to use the ’frontendColor’ and ’backgroundColor’ fields to write the calendar colors (RGB). If this feature is used, the index-based ’color’ field will be set to the best matching option automatically. Optional. The default is False.

id: Identifier of the calendar.

description: Description of the calendar. Optional. Read-only.

kind: Type of the resource ("calendar#calendarListEntry").

etag: ETag of the resource.

location: Geographic location of the calendar as free-form text. Optional. Read-only.

summary: Title of the calendar. Read-only.

timeZone: The time zone of the calendar. Optional. Read-only.

accessRole: The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

backgroundColor: The main color of the calendar in the format ’#0088aa’. This property supersedes the index-based colorId property. Optional.

colorId: 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). Optional.

defaultReminders: The default reminders that the authenticated user has for this calendar.

foregroundColor: The foreground color of the calendar in the format ’#ffffff’. This property supersedes the index-based colorId property. Optional.

hidden: Whether the calendar has been hidden from the list. Optional. The default is False.

selected: Whether the calendar content shows up in the calendar UI. Optional. The default is False.

summaryOverride: The summary that the authenticated user has set for this calendar. Optional.

2.4 colors

procedure

(calendar-colors-get [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns the color definitions for calendars and events.

2.5 events

procedure

(calendar-events-list 
  #:calendarId calendarId 
  [#:timeZone timeZone 
  #:iCalUID iCalUID 
  #:timeMax timeMax 
  #:timeMin timeMin 
  #:maxResults maxResults 
  #:pageToken pageToken 
  #:alwaysIncludeEmail alwaysIncludeEmail 
  #:maxAttendees maxAttendees 
  #:showDeleted showDeleted 
  #:orderBy orderBy 
  #:q q 
  #:showHiddenInvitations showHiddenInvitations 
  #:singleEvents singleEvents 
  #:updatedMin updatedMin 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  timeZone : string? = 'N/A
  iCalUID : string? = 'N/A
  timeMax : string? = 'N/A
  timeMin : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alwaysIncludeEmail : string? = 'N/A
  maxAttendees : string? = 'N/A
  showDeleted : string? = 'N/A
  orderBy : string? = 'N/A
  q : string? = 'N/A
  showHiddenInvitations : string? = 'N/A
  singleEvents : string? = 'N/A
  updatedMin : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns events on the specified calendar.

calendarId: Calendar identifier.

timeZone: Time zone used in the response. Optional. The default is the time zone of the calendar.

iCalUID: Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.

timeMax: Upper bound (exclusive) for an event’s start time to filter by. Optional. The default is not to filter by start time.

timeMin: Lower bound (inclusive) for an event’s end time to filter by. Optional. The default is not to filter by end time.

maxResults: Maximum number of events returned on one result page. Optional.

pageToken: Token specifying which result page to return. Optional.

alwaysIncludeEmail: 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.

maxAttendees: 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.

showDeleted: Whether to include deleted single 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.

orderBy: The order of the events returned in the result. Optional. The default is an unspecified, stable order.

q: Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

showHiddenInvitations: Whether to include hidden invitations in the result. Optional. The default is False.

singleEvents: 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.

updatedMin: Lower bound for an event’s last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.

procedure

(calendar-events-get #:calendarId calendarId 
  #:eventId eventId 
  [#:timeZone timeZone 
  #:alwaysIncludeEmail alwaysIncludeEmail 
  #:maxAttendees maxAttendees 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  eventId : string?
  timeZone : string? = 'N/A
  alwaysIncludeEmail : string? = 'N/A
  maxAttendees : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns an event.

calendarId: Calendar identifier.

eventId: Event identifier.

timeZone: Time zone used in the response. Optional. The default is the time zone of the calendar.

alwaysIncludeEmail: 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.

maxAttendees: 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.

procedure

(calendar-events-import 
  #:calendarId calendarId 
  [#:id id 
  #:description description 
  #:created created 
  #:kind kind 
  #:etag etag 
  #:start start 
  #:updated updated 
  #:status status 
  #:location location 
  #:summary summary 
  #:colorId colorId 
  #:anyoneCanAddSelf anyoneCanAddSelf 
  #:attendees attendees 
  #:attendeesOmitted attendeesOmitted 
  #:creator creator 
  #:end end 
  #:endTimeUnspecified endTimeUnspecified 
  #:extendedProperties extendedProperties 
  #:gadget gadget 
  #:guestsCanInviteOthers guestsCanInviteOthers 
  #:guestsCanModify guestsCanModify 
  #:guestsCanSeeOtherGuests guestsCanSeeOtherGuests 
  #:hangoutLink hangoutLink 
  #:htmlLink htmlLink 
  #:iCalUID iCalUID 
  #:locked locked 
  #:organizer organizer 
  #:originalStartTime originalStartTime 
  #:privateCopy privateCopy 
  #:recurrence recurrence 
  #:recurringEventId recurringEventId 
  #:reminders reminders 
  #:sequence sequence 
  #:transparency transparency 
  #:visibility visibility 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  id : string? = 'N/A
  description : string? = 'N/A
  created : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  start : string? = 'N/A
  updated : string? = 'N/A
  status : string? = 'N/A
  location : string? = 'N/A
  summary : string? = 'N/A
  colorId : string? = 'N/A
  anyoneCanAddSelf : string? = 'N/A
  attendees : string? = 'N/A
  attendeesOmitted : string? = 'N/A
  creator : string? = 'N/A
  end : string? = 'N/A
  endTimeUnspecified : string? = 'N/A
  extendedProperties : string? = 'N/A
  gadget : string? = 'N/A
  guestsCanInviteOthers : string? = 'N/A
  guestsCanModify : string? = 'N/A
  guestsCanSeeOtherGuests : string? = 'N/A
  hangoutLink : string? = 'N/A
  htmlLink : string? = 'N/A
  iCalUID : string? = 'N/A
  locked : string? = 'N/A
  organizer : string? = 'N/A
  originalStartTime : string? = 'N/A
  privateCopy : string? = 'N/A
  recurrence : string? = 'N/A
  recurringEventId : string? = 'N/A
  reminders : string? = 'N/A
  sequence : string? = 'N/A
  transparency : string? = 'N/A
  visibility : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Imports an event.

calendarId: Calendar identifier.

id: Identifier of the event.

description: Description of the event. Optional.

created: Creation time of the event (as a RFC 3339 timestamp). Read-only.

kind: Type of the resource ("calendar#event").

etag: ETag of the resource.

start: The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

updated: Last modification time of the event (as a RFC 3339 timestamp). Read-only.

status: Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled.

location: Geographic location of the event as free-form text. Optional.

summary: Title of the event.

colorId: 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.

anyoneCanAddSelf: Whether anyone can invite themselves to the event. Optional. The default is False.

attendees: The attendees of the event.

attendeesOmitted: 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.

creator: The creator of the event. Read-only.

end: The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

endTimeUnspecified: 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.

extendedProperties: Extended properties of the event.

gadget: A gadget that extends this event.

guestsCanInviteOthers: Whether attendees other than the organizer can invite others to the event. Optional. The default is False.

guestsCanModify: Whether attendees other than the organizer can modify the event. Optional. The default is False.

guestsCanSeeOtherGuests: Whether attendees other than the organizer can see who the event’s attendees are. Optional. The default is False.

hangoutLink: An absolute link to the Google+ hangout associated with this event. Read-only.

htmlLink: An absolute link to this event in the Google Calendar Web UI. Read-only.

iCalUID: Event ID in the iCalendar format.

locked: 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.

organizer: The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in ’attendees’ with the ’organizer’ field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.

originalStartTime: 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. Immutable.

privateCopy: Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.

recurrence: List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.

recurringEventId: For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.

reminders: Information about the event’s reminders for the authenticated user.

sequence: Sequence number as per iCalendar.

transparency: Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - The event blocks time on the calendar. This is the default value. - "transparent" - The event does not block time on the calendar.

visibility: Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.

procedure

(calendar-events-insert 
  #:calendarId calendarId 
  [#:sendNotifications sendNotifications 
  #:id id 
  #:description description 
  #:created created 
  #:kind kind 
  #:etag etag 
  #:start start 
  #:updated updated 
  #:status status 
  #:location location 
  #:summary summary 
  #:colorId colorId 
  #:anyoneCanAddSelf anyoneCanAddSelf 
  #:attendees attendees 
  #:attendeesOmitted attendeesOmitted 
  #:creator creator 
  #:end end 
  #:endTimeUnspecified endTimeUnspecified 
  #:extendedProperties extendedProperties 
  #:gadget gadget 
  #:guestsCanInviteOthers guestsCanInviteOthers 
  #:guestsCanModify guestsCanModify 
  #:guestsCanSeeOtherGuests guestsCanSeeOtherGuests 
  #:hangoutLink hangoutLink 
  #:htmlLink htmlLink 
  #:iCalUID iCalUID 
  #:locked locked 
  #:organizer organizer 
  #:originalStartTime originalStartTime 
  #:privateCopy privateCopy 
  #:recurrence recurrence 
  #:recurringEventId recurringEventId 
  #:reminders reminders 
  #:sequence sequence 
  #:transparency transparency 
  #:visibility visibility 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  sendNotifications : string? = 'N/A
  id : string? = 'N/A
  description : string? = 'N/A
  created : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  start : string? = 'N/A
  updated : string? = 'N/A
  status : string? = 'N/A
  location : string? = 'N/A
  summary : string? = 'N/A
  colorId : string? = 'N/A
  anyoneCanAddSelf : string? = 'N/A
  attendees : string? = 'N/A
  attendeesOmitted : string? = 'N/A
  creator : string? = 'N/A
  end : string? = 'N/A
  endTimeUnspecified : string? = 'N/A
  extendedProperties : string? = 'N/A
  gadget : string? = 'N/A
  guestsCanInviteOthers : string? = 'N/A
  guestsCanModify : string? = 'N/A
  guestsCanSeeOtherGuests : string? = 'N/A
  hangoutLink : string? = 'N/A
  htmlLink : string? = 'N/A
  iCalUID : string? = 'N/A
  locked : string? = 'N/A
  organizer : string? = 'N/A
  originalStartTime : string? = 'N/A
  privateCopy : string? = 'N/A
  recurrence : string? = 'N/A
  recurringEventId : string? = 'N/A
  reminders : string? = 'N/A
  sequence : string? = 'N/A
  transparency : string? = 'N/A
  visibility : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Creates an event.

calendarId: Calendar identifier.

sendNotifications: Whether to send notifications about the creation of the new event. Optional. The default is False.

id: Identifier of the event.

description: Description of the event. Optional.

created: Creation time of the event (as a RFC 3339 timestamp). Read-only.

kind: Type of the resource ("calendar#event").

etag: ETag of the resource.

start: The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

updated: Last modification time of the event (as a RFC 3339 timestamp). Read-only.

status: Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled.

location: Geographic location of the event as free-form text. Optional.

summary: Title of the event.

colorId: 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.

anyoneCanAddSelf: Whether anyone can invite themselves to the event. Optional. The default is False.

attendees: The attendees of the event.

attendeesOmitted: 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.

creator: The creator of the event. Read-only.

end: The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

endTimeUnspecified: 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.

extendedProperties: Extended properties of the event.

gadget: A gadget that extends this event.

guestsCanInviteOthers: Whether attendees other than the organizer can invite others to the event. Optional. The default is False.

guestsCanModify: Whether attendees other than the organizer can modify the event. Optional. The default is False.

guestsCanSeeOtherGuests: Whether attendees other than the organizer can see who the event’s attendees are. Optional. The default is False.

hangoutLink: An absolute link to the Google+ hangout associated with this event. Read-only.

htmlLink: An absolute link to this event in the Google Calendar Web UI. Read-only.

iCalUID: Event ID in the iCalendar format.

locked: 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.

organizer: The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in ’attendees’ with the ’organizer’ field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.

originalStartTime: 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. Immutable.

privateCopy: Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.

recurrence: List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.

recurringEventId: For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.

reminders: Information about the event’s reminders for the authenticated user.

sequence: Sequence number as per iCalendar.

transparency: Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - The event blocks time on the calendar. This is the default value. - "transparent" - The event does not block time on the calendar.

visibility: Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.

procedure

(calendar-events-patch 
  #:calendarId calendarId 
  #:eventId eventId 
  [#:sendNotifications sendNotifications 
  #:alwaysIncludeEmail alwaysIncludeEmail 
  #:id id 
  #:description description 
  #:created created 
  #:kind kind 
  #:etag etag 
  #:start start 
  #:updated updated 
  #:status status 
  #:location location 
  #:summary summary 
  #:colorId colorId 
  #:anyoneCanAddSelf anyoneCanAddSelf 
  #:attendees attendees 
  #:attendeesOmitted attendeesOmitted 
  #:creator creator 
  #:end end 
  #:endTimeUnspecified endTimeUnspecified 
  #:extendedProperties extendedProperties 
  #:gadget gadget 
  #:guestsCanInviteOthers guestsCanInviteOthers 
  #:guestsCanModify guestsCanModify 
  #:guestsCanSeeOtherGuests guestsCanSeeOtherGuests 
  #:hangoutLink hangoutLink 
  #:htmlLink htmlLink 
  #:iCalUID iCalUID 
  #:locked locked 
  #:organizer organizer 
  #:originalStartTime originalStartTime 
  #:privateCopy privateCopy 
  #:recurrence recurrence 
  #:recurringEventId recurringEventId 
  #:reminders reminders 
  #:sequence sequence 
  #:transparency transparency 
  #:visibility visibility 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  eventId : string?
  sendNotifications : string? = 'N/A
  alwaysIncludeEmail : string? = 'N/A
  id : string? = 'N/A
  description : string? = 'N/A
  created : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  start : string? = 'N/A
  updated : string? = 'N/A
  status : string? = 'N/A
  location : string? = 'N/A
  summary : string? = 'N/A
  colorId : string? = 'N/A
  anyoneCanAddSelf : string? = 'N/A
  attendees : string? = 'N/A
  attendeesOmitted : string? = 'N/A
  creator : string? = 'N/A
  end : string? = 'N/A
  endTimeUnspecified : string? = 'N/A
  extendedProperties : string? = 'N/A
  gadget : string? = 'N/A
  guestsCanInviteOthers : string? = 'N/A
  guestsCanModify : string? = 'N/A
  guestsCanSeeOtherGuests : string? = 'N/A
  hangoutLink : string? = 'N/A
  htmlLink : string? = 'N/A
  iCalUID : string? = 'N/A
  locked : string? = 'N/A
  organizer : string? = 'N/A
  originalStartTime : string? = 'N/A
  privateCopy : string? = 'N/A
  recurrence : string? = 'N/A
  recurringEventId : string? = 'N/A
  reminders : string? = 'N/A
  sequence : string? = 'N/A
  transparency : string? = 'N/A
  visibility : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Updates an event. This method supports patch semantics.

calendarId: Calendar identifier.

eventId: Event identifier.

sendNotifications: Whether to send notifications about the event update (e.g. attendee’s responses, title changes, etc.). Optional. The default is False.

alwaysIncludeEmail: 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.

id: Identifier of the event.

description: Description of the event. Optional.

created: Creation time of the event (as a RFC 3339 timestamp). Read-only.

kind: Type of the resource ("calendar#event").

etag: ETag of the resource.

start: The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

updated: Last modification time of the event (as a RFC 3339 timestamp). Read-only.

status: Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled.

location: Geographic location of the event as free-form text. Optional.

summary: Title of the event.

colorId: 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.

anyoneCanAddSelf: Whether anyone can invite themselves to the event. Optional. The default is False.

attendees: The attendees of the event.

attendeesOmitted: 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.

creator: The creator of the event. Read-only.

end: The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

endTimeUnspecified: 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.

extendedProperties: Extended properties of the event.

gadget: A gadget that extends this event.

guestsCanInviteOthers: Whether attendees other than the organizer can invite others to the event. Optional. The default is False.

guestsCanModify: Whether attendees other than the organizer can modify the event. Optional. The default is False.

guestsCanSeeOtherGuests: Whether attendees other than the organizer can see who the event’s attendees are. Optional. The default is False.

hangoutLink: An absolute link to the Google+ hangout associated with this event. Read-only.

htmlLink: An absolute link to this event in the Google Calendar Web UI. Read-only.

iCalUID: Event ID in the iCalendar format.

locked: 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.

organizer: The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in ’attendees’ with the ’organizer’ field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.

originalStartTime: 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. Immutable.

privateCopy: Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.

recurrence: List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.

recurringEventId: For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.

reminders: Information about the event’s reminders for the authenticated user.

sequence: Sequence number as per iCalendar.

transparency: Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - The event blocks time on the calendar. This is the default value. - "transparent" - The event does not block time on the calendar.

visibility: Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.

procedure

(calendar-events-instances 
  #:calendarId calendarId 
  #:eventId eventId 
  [#:timeZone timeZone 
  #:maxResults maxResults 
  #:pageToken pageToken 
  #:alwaysIncludeEmail alwaysIncludeEmail 
  #:maxAttendees maxAttendees 
  #:originalStart originalStart 
  #:showDeleted showDeleted 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  eventId : string?
  timeZone : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alwaysIncludeEmail : string? = 'N/A
  maxAttendees : string? = 'N/A
  originalStart : string? = 'N/A
  showDeleted : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns instances of the specified recurring event.

calendarId: Calendar identifier.

eventId: Recurring event identifier.

timeZone: Time zone used in the response. Optional. The default is the time zone of the calendar.

maxResults: Maximum number of events returned on one result page. Optional.

pageToken: Token specifying which result page to return. Optional.

alwaysIncludeEmail: 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.

maxAttendees: 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.

originalStart: The original start time of the instance in the result. Optional.

showDeleted: Whether to include deleted events (with ’eventStatus’ equals ’cancelled’) in the result. Optional. The default is False.

procedure

(calendar-events-move #:calendarId calendarId 
  #:eventId eventId 
  #:destination destination 
  [#:sendNotifications sendNotifications 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  eventId : string?
  destination : string?
  sendNotifications : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Moves an event to another calendar, i.e. changes an event’s organizer.

calendarId: Calendar identifier of the source calendar where the event currently is on.

eventId: Event identifier.

destination: Calendar identifier of the target calendar where the event is to be moved to.

sendNotifications: Whether to send notifications about the change of the event’s organizer. Optional. The default is False.

procedure

(calendar-events-quickAdd 
  #:calendarId calendarId 
  #:text text 
  [#:sendNotifications sendNotifications 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  text : string?
  sendNotifications : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Creates an event based on a simple text string.

calendarId: Calendar identifier.

text: The text describing the event to be created.

sendNotifications: Whether to send notifications about the creation of the event. Optional. The default is False.

procedure

(calendar-events-delete #:calendarId calendarId 
  #:eventId eventId 
  [#:sendNotifications sendNotifications 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  eventId : string?
  sendNotifications : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Deletes an event.

calendarId: Calendar identifier.

eventId: Event identifier.

sendNotifications: Whether to send notifications about the deletion of the event. Optional. The default is False.

procedure

(calendar-events-update 
  #:calendarId calendarId 
  #:eventId eventId 
  [#:sendNotifications sendNotifications 
  #:alwaysIncludeEmail alwaysIncludeEmail 
  #:id id 
  #:description description 
  #:created created 
  #:kind kind 
  #:etag etag 
  #:start start 
  #:updated updated 
  #:status status 
  #:location location 
  #:summary summary 
  #:colorId colorId 
  #:anyoneCanAddSelf anyoneCanAddSelf 
  #:attendees attendees 
  #:attendeesOmitted attendeesOmitted 
  #:creator creator 
  #:end end 
  #:endTimeUnspecified endTimeUnspecified 
  #:extendedProperties extendedProperties 
  #:gadget gadget 
  #:guestsCanInviteOthers guestsCanInviteOthers 
  #:guestsCanModify guestsCanModify 
  #:guestsCanSeeOtherGuests guestsCanSeeOtherGuests 
  #:hangoutLink hangoutLink 
  #:htmlLink htmlLink 
  #:iCalUID iCalUID 
  #:locked locked 
  #:organizer organizer 
  #:originalStartTime originalStartTime 
  #:privateCopy privateCopy 
  #:recurrence recurrence 
  #:recurringEventId recurringEventId 
  #:reminders reminders 
  #:sequence sequence 
  #:transparency transparency 
  #:visibility visibility 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  calendarId : string?
  eventId : string?
  sendNotifications : string? = 'N/A
  alwaysIncludeEmail : string? = 'N/A
  id : string? = 'N/A
  description : string? = 'N/A
  created : string? = 'N/A
  kind : string? = 'N/A
  etag : string? = 'N/A
  start : string? = 'N/A
  updated : string? = 'N/A
  status : string? = 'N/A
  location : string? = 'N/A
  summary : string? = 'N/A
  colorId : string? = 'N/A
  anyoneCanAddSelf : string? = 'N/A
  attendees : string? = 'N/A
  attendeesOmitted : string? = 'N/A
  creator : string? = 'N/A
  end : string? = 'N/A
  endTimeUnspecified : string? = 'N/A
  extendedProperties : string? = 'N/A
  gadget : string? = 'N/A
  guestsCanInviteOthers : string? = 'N/A
  guestsCanModify : string? = 'N/A
  guestsCanSeeOtherGuests : string? = 'N/A
  hangoutLink : string? = 'N/A
  htmlLink : string? = 'N/A
  iCalUID : string? = 'N/A
  locked : string? = 'N/A
  organizer : string? = 'N/A
  originalStartTime : string? = 'N/A
  privateCopy : string? = 'N/A
  recurrence : string? = 'N/A
  recurringEventId : string? = 'N/A
  reminders : string? = 'N/A
  sequence : string? = 'N/A
  transparency : string? = 'N/A
  visibility : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Updates an event.

calendarId: Calendar identifier.

eventId: Event identifier.

sendNotifications: Whether to send notifications about the event update (e.g. attendee’s responses, title changes, etc.). Optional. The default is False.

alwaysIncludeEmail: 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.

id: Identifier of the event.

description: Description of the event. Optional.

created: Creation time of the event (as a RFC 3339 timestamp). Read-only.

kind: Type of the resource ("calendar#event").

etag: ETag of the resource.

start: The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

updated: Last modification time of the event (as a RFC 3339 timestamp). Read-only.

status: Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled.

location: Geographic location of the event as free-form text. Optional.

summary: Title of the event.

colorId: 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.

anyoneCanAddSelf: Whether anyone can invite themselves to the event. Optional. The default is False.

attendees: The attendees of the event.

attendeesOmitted: 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.

creator: The creator of the event. Read-only.

end: The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

endTimeUnspecified: 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.

extendedProperties: Extended properties of the event.

gadget: A gadget that extends this event.

guestsCanInviteOthers: Whether attendees other than the organizer can invite others to the event. Optional. The default is False.

guestsCanModify: Whether attendees other than the organizer can modify the event. Optional. The default is False.

guestsCanSeeOtherGuests: Whether attendees other than the organizer can see who the event’s attendees are. Optional. The default is False.

hangoutLink: An absolute link to the Google+ hangout associated with this event. Read-only.

htmlLink: An absolute link to this event in the Google Calendar Web UI. Read-only.

iCalUID: Event ID in the iCalendar format.

locked: 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.

organizer: The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in ’attendees’ with the ’organizer’ field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.

originalStartTime: 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. Immutable.

privateCopy: Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.

recurrence: List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.

recurringEventId: For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.

reminders: Information about the event’s reminders for the authenticated user.

sequence: Sequence number as per iCalendar.

transparency: Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - The event blocks time on the calendar. This is the default value. - "transparent" - The event does not block time on the calendar.

visibility: Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.

2.6 freebusy

procedure

(calendar-freebusy-query 
  [#:items items 
  #:timeZone timeZone 
  #:calendarExpansionMax calendarExpansionMax 
  #:groupExpansionMax groupExpansionMax 
  #:timeMax timeMax 
  #:timeMin timeMin 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
 → jsexpr?
  items : string? = 'N/A
  timeZone : string? = 'N/A
  calendarExpansionMax : string? = 'N/A
  groupExpansionMax : string? = 'N/A
  timeMax : string? = 'N/A
  timeMin : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns free/busy information for a set of calendars.

items: List of calendars and/or groups to query.

timeZone: Time zone used in the response. Optional. The default is UTC.

calendarExpansionMax: Maximal number of calendars for which FreeBusy information is to be provided. Optional.

groupExpansionMax: Maximal number of calendar identifiers to be provided for a single group. Optional. An error will be returned for a group with more members than this value.

timeMax: The end of the interval for the query.

timeMin: The start of the interval for the query.

2.7 settings

procedure

(calendar-settings-list [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns all user settings for the authenticated user.

procedure

(calendar-settings-get #:setting setting    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp]) → jsexpr?
  setting : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns a single user setting.

setting: Name of the user setting.