1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.events.html">events</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(calendarId, eventId, sendNotifications=None)</a></code></p> 79 <p class="firstline">Deletes an event.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</a></code></p> 82 <p class="firstline">Returns an event.</p> 83 <p class="toc_element"> 84 <code><a href="#import_">import_(calendarId, body, supportsAttachments=None)</a></code></p> 85 <p class="firstline">Imports an event. This operation is used to add a private copy of an existing event to a calendar.</p> 86 <p class="toc_element"> 87 <code><a href="#insert">insert(calendarId, body, sendNotifications=None, supportsAttachments=None, maxAttendees=None)</a></code></p> 88 <p class="firstline">Creates an event.</p> 89 <p class="toc_element"> 90 <code><a href="#instances">instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</a></code></p> 91 <p class="firstline">Returns instances of the specified recurring event.</p> 92 <p class="toc_element"> 93 <code><a href="#instances_next">instances_next(previous_request, previous_response)</a></code></p> 94 <p class="firstline">Retrieves the next page of results.</p> 95 <p class="toc_element"> 96 <code><a href="#list">list(calendarId, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</a></code></p> 97 <p class="firstline">Returns events on the specified calendar.</p> 98 <p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100 <p class="firstline">Retrieves the next page of results.</p> 101 <p class="toc_element"> 102 <code><a href="#move">move(calendarId, eventId, destination, sendNotifications=None)</a></code></p> 103 <p class="firstline">Moves an event to another calendar, i.e. changes an event's organizer.</p> 104 <p class="toc_element"> 105 <code><a href="#patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, supportsAttachments=None, maxAttendees=None)</a></code></p> 106 <p class="firstline">Updates an event. This method supports patch semantics.</p> 107 <p class="toc_element"> 108 <code><a href="#quickAdd">quickAdd(calendarId, text, sendNotifications=None)</a></code></p> 109 <p class="firstline">Creates an event based on a simple text string.</p> 110 <p class="toc_element"> 111 <code><a href="#update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, supportsAttachments=None, maxAttendees=None)</a></code></p> 112 <p class="firstline">Updates an event.</p> 113 <p class="toc_element"> 114 <code><a href="#watch">watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</a></code></p> 115 <p class="firstline">Watch for changes to Events resources.</p> 116 <h3>Method Details</h3> 117 <div class="method"> 118 <code class="details" id="delete">delete(calendarId, eventId, sendNotifications=None)</code> 119 <pre>Deletes an event. 120 121 Args: 122 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) 123 eventId: string, Event identifier. (required) 124 sendNotifications: boolean, Whether to send notifications about the deletion of the event. Optional. The default is False. 125 </pre> 126 </div> 127 128 <div class="method"> 129 <code class="details" id="get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</code> 130 <pre>Returns an event. 131 132 Args: 133 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) 134 eventId: string, Event identifier. (required) 135 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. 136 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. 137 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 138 139 Returns: 140 An object of the form: 141 142 { 143 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 144 # In order to modify attachments the supportsAttachments request parameter should be set to true. 145 # There can be at most 25 attachments per event, 146 { 147 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 148 "title": "A String", # Attachment title. 149 "fileUrl": "A String", # URL link to the attachment. 150 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 151 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 152 "fileId": "A String", # ID of the attached file. Read-only. 153 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 154 }, 155 ], 156 "creator": { # The creator of the event. Read-only. 157 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 158 "displayName": "A String", # The creator's name, if available. 159 "email": "A String", # The creator's email address, if available. 160 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 161 }, 162 "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. 163 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 164 "displayName": "A String", # The organizer's name, if available. 165 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 166 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 167 }, 168 "summary": "A String", # Title of the event. 169 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 170 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 171 # - the length of the ID must be between 5 and 1024 characters 172 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 173 # If you do not specify an ID, it will be automatically generated by the server. 174 # 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. 175 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 176 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 177 { 178 "comment": "A String", # The attendee's response comment. Optional. 179 "displayName": "A String", # The attendee's name, if available. Optional. 180 "responseStatus": "A String", # The attendee's response status. Possible values are: 181 # - "needsAction" - The attendee has not responded to the invitation. 182 # - "declined" - The attendee has declined the invitation. 183 # - "tentative" - The attendee has tentatively accepted the invitation. 184 # - "accepted" - The attendee has accepted the invitation. 185 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 186 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 187 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 188 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 189 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 190 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 191 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 192 }, 193 ], 194 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 195 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 196 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 197 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 198 }, 199 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 200 "recurrence": [ # 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. 201 "A String", 202 ], 203 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 204 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 205 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 206 }, 207 "etag": "A String", # ETag of the resource. 208 "location": "A String", # Geographic location of the event as free-form text. Optional. 209 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 210 "gadget": { # A gadget that extends this event. 211 "preferences": { # Preferences. 212 "a_key": "A String", # The preference name and corresponding value. 213 }, 214 "title": "A String", # The gadget's title. 215 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 216 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 217 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 218 "type": "A String", # The gadget's type. 219 "display": "A String", # The gadget's display mode. Optional. Possible values are: 220 # - "icon" - The gadget displays next to the event's title in the calendar view. 221 # - "chip" - The gadget displays when the event is clicked. 222 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 223 }, 224 "status": "A String", # Status of the event. Optional. Possible values are: 225 # - "confirmed" - The event is confirmed. This is the default status. 226 # - "tentative" - The event is tentatively confirmed. 227 # - "cancelled" - The event is cancelled. 228 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 229 "description": "A String", # Description of the event. Optional. 230 "iCalUID": "A 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. 231 # 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. 232 "extendedProperties": { # Extended properties of the event. 233 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 234 "a_key": "A String", # The name of the shared property and the corresponding value. 235 }, 236 "private": { # Properties that are private to the copy of the event that appears on this calendar. 237 "a_key": "A String", # The name of the private property and the corresponding value. 238 }, 239 }, 240 "endTimeUnspecified": 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. 241 "sequence": 42, # Sequence number as per iCalendar. 242 "visibility": "default", # Visibility of the event. Optional. Possible values are: 243 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 244 # - "public" - The event is public and event details are visible to all readers of the calendar. 245 # - "private" - The event is private and only event attendees may view event details. 246 # - "confidential" - The event is private. This value is provided for compatibility reasons. 247 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 248 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 249 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 250 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 251 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 252 }, 253 "attendeesOmitted": 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. 254 "kind": "calendar#event", # Type of the resource ("calendar#event"). 255 "locked": 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. 256 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 257 "colorId": "A 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. 258 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 259 "reminders": { # Information about the event's reminders for the authenticated user. 260 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 261 { 262 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 263 "method": "A String", # The method used by this reminder. Possible values are: 264 # - "email" - Reminders are sent via email. 265 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 266 # - "popup" - Reminders are sent via a UI popup. 267 }, 268 ], 269 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 270 }, 271 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 272 "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. 273 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 274 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 275 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 276 }, 277 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 278 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 279 # - "opaque" - The event blocks time on the calendar. This is the default value. 280 # - "transparent" - The event does not block time on the calendar. 281 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 282 }</pre> 283 </div> 284 285 <div class="method"> 286 <code class="details" id="import_">import_(calendarId, body, supportsAttachments=None)</code> 287 <pre>Imports an event. This operation is used to add a private copy of an existing event to a calendar. 288 289 Args: 290 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) 291 body: object, The request body. (required) 292 The object takes the form of: 293 294 { 295 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 296 # In order to modify attachments the supportsAttachments request parameter should be set to true. 297 # There can be at most 25 attachments per event, 298 { 299 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 300 "title": "A String", # Attachment title. 301 "fileUrl": "A String", # URL link to the attachment. 302 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 303 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 304 "fileId": "A String", # ID of the attached file. Read-only. 305 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 306 }, 307 ], 308 "creator": { # The creator of the event. Read-only. 309 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 310 "displayName": "A String", # The creator's name, if available. 311 "email": "A String", # The creator's email address, if available. 312 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 313 }, 314 "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. 315 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 316 "displayName": "A String", # The organizer's name, if available. 317 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 318 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 319 }, 320 "summary": "A String", # Title of the event. 321 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 322 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 323 # - the length of the ID must be between 5 and 1024 characters 324 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 325 # If you do not specify an ID, it will be automatically generated by the server. 326 # 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. 327 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 328 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 329 { 330 "comment": "A String", # The attendee's response comment. Optional. 331 "displayName": "A String", # The attendee's name, if available. Optional. 332 "responseStatus": "A String", # The attendee's response status. Possible values are: 333 # - "needsAction" - The attendee has not responded to the invitation. 334 # - "declined" - The attendee has declined the invitation. 335 # - "tentative" - The attendee has tentatively accepted the invitation. 336 # - "accepted" - The attendee has accepted the invitation. 337 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 338 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 339 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 340 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 341 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 342 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 343 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 344 }, 345 ], 346 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 347 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 348 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 349 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 350 }, 351 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 352 "recurrence": [ # 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. 353 "A String", 354 ], 355 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 356 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 357 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 358 }, 359 "etag": "A String", # ETag of the resource. 360 "location": "A String", # Geographic location of the event as free-form text. Optional. 361 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 362 "gadget": { # A gadget that extends this event. 363 "preferences": { # Preferences. 364 "a_key": "A String", # The preference name and corresponding value. 365 }, 366 "title": "A String", # The gadget's title. 367 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 368 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 369 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 370 "type": "A String", # The gadget's type. 371 "display": "A String", # The gadget's display mode. Optional. Possible values are: 372 # - "icon" - The gadget displays next to the event's title in the calendar view. 373 # - "chip" - The gadget displays when the event is clicked. 374 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 375 }, 376 "status": "A String", # Status of the event. Optional. Possible values are: 377 # - "confirmed" - The event is confirmed. This is the default status. 378 # - "tentative" - The event is tentatively confirmed. 379 # - "cancelled" - The event is cancelled. 380 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 381 "description": "A String", # Description of the event. Optional. 382 "iCalUID": "A 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. 383 # 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. 384 "extendedProperties": { # Extended properties of the event. 385 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 386 "a_key": "A String", # The name of the shared property and the corresponding value. 387 }, 388 "private": { # Properties that are private to the copy of the event that appears on this calendar. 389 "a_key": "A String", # The name of the private property and the corresponding value. 390 }, 391 }, 392 "endTimeUnspecified": 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. 393 "sequence": 42, # Sequence number as per iCalendar. 394 "visibility": "default", # Visibility of the event. Optional. Possible values are: 395 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 396 # - "public" - The event is public and event details are visible to all readers of the calendar. 397 # - "private" - The event is private and only event attendees may view event details. 398 # - "confidential" - The event is private. This value is provided for compatibility reasons. 399 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 400 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 401 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 402 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 403 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 404 }, 405 "attendeesOmitted": 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. 406 "kind": "calendar#event", # Type of the resource ("calendar#event"). 407 "locked": 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. 408 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 409 "colorId": "A 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. 410 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 411 "reminders": { # Information about the event's reminders for the authenticated user. 412 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 413 { 414 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 415 "method": "A String", # The method used by this reminder. Possible values are: 416 # - "email" - Reminders are sent via email. 417 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 418 # - "popup" - Reminders are sent via a UI popup. 419 }, 420 ], 421 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 422 }, 423 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 424 "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. 425 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 426 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 427 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 428 }, 429 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 430 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 431 # - "opaque" - The event blocks time on the calendar. This is the default value. 432 # - "transparent" - The event does not block time on the calendar. 433 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 434 } 435 436 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. 437 438 Returns: 439 An object of the form: 440 441 { 442 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 443 # In order to modify attachments the supportsAttachments request parameter should be set to true. 444 # There can be at most 25 attachments per event, 445 { 446 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 447 "title": "A String", # Attachment title. 448 "fileUrl": "A String", # URL link to the attachment. 449 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 450 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 451 "fileId": "A String", # ID of the attached file. Read-only. 452 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 453 }, 454 ], 455 "creator": { # The creator of the event. Read-only. 456 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 457 "displayName": "A String", # The creator's name, if available. 458 "email": "A String", # The creator's email address, if available. 459 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 460 }, 461 "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. 462 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 463 "displayName": "A String", # The organizer's name, if available. 464 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 465 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 466 }, 467 "summary": "A String", # Title of the event. 468 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 469 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 470 # - the length of the ID must be between 5 and 1024 characters 471 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 472 # If you do not specify an ID, it will be automatically generated by the server. 473 # 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. 474 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 475 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 476 { 477 "comment": "A String", # The attendee's response comment. Optional. 478 "displayName": "A String", # The attendee's name, if available. Optional. 479 "responseStatus": "A String", # The attendee's response status. Possible values are: 480 # - "needsAction" - The attendee has not responded to the invitation. 481 # - "declined" - The attendee has declined the invitation. 482 # - "tentative" - The attendee has tentatively accepted the invitation. 483 # - "accepted" - The attendee has accepted the invitation. 484 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 485 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 486 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 487 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 488 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 489 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 490 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 491 }, 492 ], 493 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 494 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 495 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 496 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 497 }, 498 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 499 "recurrence": [ # 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. 500 "A String", 501 ], 502 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 503 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 504 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 505 }, 506 "etag": "A String", # ETag of the resource. 507 "location": "A String", # Geographic location of the event as free-form text. Optional. 508 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 509 "gadget": { # A gadget that extends this event. 510 "preferences": { # Preferences. 511 "a_key": "A String", # The preference name and corresponding value. 512 }, 513 "title": "A String", # The gadget's title. 514 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 515 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 516 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 517 "type": "A String", # The gadget's type. 518 "display": "A String", # The gadget's display mode. Optional. Possible values are: 519 # - "icon" - The gadget displays next to the event's title in the calendar view. 520 # - "chip" - The gadget displays when the event is clicked. 521 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 522 }, 523 "status": "A String", # Status of the event. Optional. Possible values are: 524 # - "confirmed" - The event is confirmed. This is the default status. 525 # - "tentative" - The event is tentatively confirmed. 526 # - "cancelled" - The event is cancelled. 527 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 528 "description": "A String", # Description of the event. Optional. 529 "iCalUID": "A 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. 530 # 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. 531 "extendedProperties": { # Extended properties of the event. 532 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 533 "a_key": "A String", # The name of the shared property and the corresponding value. 534 }, 535 "private": { # Properties that are private to the copy of the event that appears on this calendar. 536 "a_key": "A String", # The name of the private property and the corresponding value. 537 }, 538 }, 539 "endTimeUnspecified": 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. 540 "sequence": 42, # Sequence number as per iCalendar. 541 "visibility": "default", # Visibility of the event. Optional. Possible values are: 542 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 543 # - "public" - The event is public and event details are visible to all readers of the calendar. 544 # - "private" - The event is private and only event attendees may view event details. 545 # - "confidential" - The event is private. This value is provided for compatibility reasons. 546 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 547 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 548 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 549 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 550 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 551 }, 552 "attendeesOmitted": 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. 553 "kind": "calendar#event", # Type of the resource ("calendar#event"). 554 "locked": 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. 555 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 556 "colorId": "A 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. 557 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 558 "reminders": { # Information about the event's reminders for the authenticated user. 559 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 560 { 561 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 562 "method": "A String", # The method used by this reminder. Possible values are: 563 # - "email" - Reminders are sent via email. 564 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 565 # - "popup" - Reminders are sent via a UI popup. 566 }, 567 ], 568 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 569 }, 570 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 571 "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. 572 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 573 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 574 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 575 }, 576 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 577 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 578 # - "opaque" - The event blocks time on the calendar. This is the default value. 579 # - "transparent" - The event does not block time on the calendar. 580 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 581 }</pre> 582 </div> 583 584 <div class="method"> 585 <code class="details" id="insert">insert(calendarId, body, sendNotifications=None, supportsAttachments=None, maxAttendees=None)</code> 586 <pre>Creates an event. 587 588 Args: 589 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) 590 body: object, The request body. (required) 591 The object takes the form of: 592 593 { 594 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 595 # In order to modify attachments the supportsAttachments request parameter should be set to true. 596 # There can be at most 25 attachments per event, 597 { 598 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 599 "title": "A String", # Attachment title. 600 "fileUrl": "A String", # URL link to the attachment. 601 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 602 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 603 "fileId": "A String", # ID of the attached file. Read-only. 604 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 605 }, 606 ], 607 "creator": { # The creator of the event. Read-only. 608 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 609 "displayName": "A String", # The creator's name, if available. 610 "email": "A String", # The creator's email address, if available. 611 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 612 }, 613 "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. 614 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 615 "displayName": "A String", # The organizer's name, if available. 616 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 617 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 618 }, 619 "summary": "A String", # Title of the event. 620 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 621 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 622 # - the length of the ID must be between 5 and 1024 characters 623 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 624 # If you do not specify an ID, it will be automatically generated by the server. 625 # 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. 626 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 627 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 628 { 629 "comment": "A String", # The attendee's response comment. Optional. 630 "displayName": "A String", # The attendee's name, if available. Optional. 631 "responseStatus": "A String", # The attendee's response status. Possible values are: 632 # - "needsAction" - The attendee has not responded to the invitation. 633 # - "declined" - The attendee has declined the invitation. 634 # - "tentative" - The attendee has tentatively accepted the invitation. 635 # - "accepted" - The attendee has accepted the invitation. 636 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 637 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 638 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 639 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 640 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 641 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 642 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 643 }, 644 ], 645 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 646 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 647 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 648 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 649 }, 650 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 651 "recurrence": [ # 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. 652 "A String", 653 ], 654 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 655 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 656 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 657 }, 658 "etag": "A String", # ETag of the resource. 659 "location": "A String", # Geographic location of the event as free-form text. Optional. 660 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 661 "gadget": { # A gadget that extends this event. 662 "preferences": { # Preferences. 663 "a_key": "A String", # The preference name and corresponding value. 664 }, 665 "title": "A String", # The gadget's title. 666 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 667 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 668 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 669 "type": "A String", # The gadget's type. 670 "display": "A String", # The gadget's display mode. Optional. Possible values are: 671 # - "icon" - The gadget displays next to the event's title in the calendar view. 672 # - "chip" - The gadget displays when the event is clicked. 673 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 674 }, 675 "status": "A String", # Status of the event. Optional. Possible values are: 676 # - "confirmed" - The event is confirmed. This is the default status. 677 # - "tentative" - The event is tentatively confirmed. 678 # - "cancelled" - The event is cancelled. 679 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 680 "description": "A String", # Description of the event. Optional. 681 "iCalUID": "A 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. 682 # 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. 683 "extendedProperties": { # Extended properties of the event. 684 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 685 "a_key": "A String", # The name of the shared property and the corresponding value. 686 }, 687 "private": { # Properties that are private to the copy of the event that appears on this calendar. 688 "a_key": "A String", # The name of the private property and the corresponding value. 689 }, 690 }, 691 "endTimeUnspecified": 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. 692 "sequence": 42, # Sequence number as per iCalendar. 693 "visibility": "default", # Visibility of the event. Optional. Possible values are: 694 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 695 # - "public" - The event is public and event details are visible to all readers of the calendar. 696 # - "private" - The event is private and only event attendees may view event details. 697 # - "confidential" - The event is private. This value is provided for compatibility reasons. 698 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 699 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 700 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 701 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 702 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 703 }, 704 "attendeesOmitted": 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. 705 "kind": "calendar#event", # Type of the resource ("calendar#event"). 706 "locked": 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. 707 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 708 "colorId": "A 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. 709 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 710 "reminders": { # Information about the event's reminders for the authenticated user. 711 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 712 { 713 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 714 "method": "A String", # The method used by this reminder. Possible values are: 715 # - "email" - Reminders are sent via email. 716 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 717 # - "popup" - Reminders are sent via a UI popup. 718 }, 719 ], 720 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 721 }, 722 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 723 "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. 724 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 725 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 726 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 727 }, 728 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 729 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 730 # - "opaque" - The event blocks time on the calendar. This is the default value. 731 # - "transparent" - The event does not block time on the calendar. 732 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 733 } 734 735 sendNotifications: boolean, Whether to send notifications about the creation of the new event. Optional. The default is False. 736 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. 737 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 738 739 Returns: 740 An object of the form: 741 742 { 743 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 744 # In order to modify attachments the supportsAttachments request parameter should be set to true. 745 # There can be at most 25 attachments per event, 746 { 747 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 748 "title": "A String", # Attachment title. 749 "fileUrl": "A String", # URL link to the attachment. 750 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 751 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 752 "fileId": "A String", # ID of the attached file. Read-only. 753 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 754 }, 755 ], 756 "creator": { # The creator of the event. Read-only. 757 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 758 "displayName": "A String", # The creator's name, if available. 759 "email": "A String", # The creator's email address, if available. 760 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 761 }, 762 "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. 763 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 764 "displayName": "A String", # The organizer's name, if available. 765 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 766 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 767 }, 768 "summary": "A String", # Title of the event. 769 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 770 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 771 # - the length of the ID must be between 5 and 1024 characters 772 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 773 # If you do not specify an ID, it will be automatically generated by the server. 774 # 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. 775 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 776 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 777 { 778 "comment": "A String", # The attendee's response comment. Optional. 779 "displayName": "A String", # The attendee's name, if available. Optional. 780 "responseStatus": "A String", # The attendee's response status. Possible values are: 781 # - "needsAction" - The attendee has not responded to the invitation. 782 # - "declined" - The attendee has declined the invitation. 783 # - "tentative" - The attendee has tentatively accepted the invitation. 784 # - "accepted" - The attendee has accepted the invitation. 785 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 786 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 787 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 788 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 789 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 790 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 791 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 792 }, 793 ], 794 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 795 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 796 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 797 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 798 }, 799 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 800 "recurrence": [ # 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. 801 "A String", 802 ], 803 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 804 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 805 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 806 }, 807 "etag": "A String", # ETag of the resource. 808 "location": "A String", # Geographic location of the event as free-form text. Optional. 809 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 810 "gadget": { # A gadget that extends this event. 811 "preferences": { # Preferences. 812 "a_key": "A String", # The preference name and corresponding value. 813 }, 814 "title": "A String", # The gadget's title. 815 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 816 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 817 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 818 "type": "A String", # The gadget's type. 819 "display": "A String", # The gadget's display mode. Optional. Possible values are: 820 # - "icon" - The gadget displays next to the event's title in the calendar view. 821 # - "chip" - The gadget displays when the event is clicked. 822 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 823 }, 824 "status": "A String", # Status of the event. Optional. Possible values are: 825 # - "confirmed" - The event is confirmed. This is the default status. 826 # - "tentative" - The event is tentatively confirmed. 827 # - "cancelled" - The event is cancelled. 828 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 829 "description": "A String", # Description of the event. Optional. 830 "iCalUID": "A 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. 831 # 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. 832 "extendedProperties": { # Extended properties of the event. 833 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 834 "a_key": "A String", # The name of the shared property and the corresponding value. 835 }, 836 "private": { # Properties that are private to the copy of the event that appears on this calendar. 837 "a_key": "A String", # The name of the private property and the corresponding value. 838 }, 839 }, 840 "endTimeUnspecified": 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. 841 "sequence": 42, # Sequence number as per iCalendar. 842 "visibility": "default", # Visibility of the event. Optional. Possible values are: 843 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 844 # - "public" - The event is public and event details are visible to all readers of the calendar. 845 # - "private" - The event is private and only event attendees may view event details. 846 # - "confidential" - The event is private. This value is provided for compatibility reasons. 847 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 848 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 849 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 850 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 851 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 852 }, 853 "attendeesOmitted": 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. 854 "kind": "calendar#event", # Type of the resource ("calendar#event"). 855 "locked": 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. 856 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 857 "colorId": "A 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. 858 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 859 "reminders": { # Information about the event's reminders for the authenticated user. 860 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 861 { 862 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 863 "method": "A String", # The method used by this reminder. Possible values are: 864 # - "email" - Reminders are sent via email. 865 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 866 # - "popup" - Reminders are sent via a UI popup. 867 }, 868 ], 869 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 870 }, 871 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 872 "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. 873 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 874 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 875 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 876 }, 877 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 878 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 879 # - "opaque" - The event blocks time on the calendar. This is the default value. 880 # - "transparent" - The event does not block time on the calendar. 881 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 882 }</pre> 883 </div> 884 885 <div class="method"> 886 <code class="details" id="instances">instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</code> 887 <pre>Returns instances of the specified recurring event. 888 889 Args: 890 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) 891 eventId: string, Recurring event identifier. (required) 892 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. 893 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. 894 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. 895 pageToken: string, Token specifying which result page to return. Optional. 896 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 897 maxResults: integer, Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. 898 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. 899 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. 900 originalStart: string, The original start time of the instance in the result. Optional. 901 902 Returns: 903 An object of the form: 904 905 { 906 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. 907 "kind": "calendar#events", # Type of the collection ("calendar#events"). 908 "defaultReminders": [ # 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). 909 { 910 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 911 "method": "A String", # The method used by this reminder. Possible values are: 912 # - "email" - Reminders are sent via email. 913 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 914 # - "popup" - Reminders are sent via a UI popup. 915 }, 916 ], 917 "description": "A String", # Description of the calendar. Read-only. 918 "items": [ # List of events on the calendar. 919 { 920 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 921 # In order to modify attachments the supportsAttachments request parameter should be set to true. 922 # There can be at most 25 attachments per event, 923 { 924 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 925 "title": "A String", # Attachment title. 926 "fileUrl": "A String", # URL link to the attachment. 927 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 928 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 929 "fileId": "A String", # ID of the attached file. Read-only. 930 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 931 }, 932 ], 933 "creator": { # The creator of the event. Read-only. 934 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 935 "displayName": "A String", # The creator's name, if available. 936 "email": "A String", # The creator's email address, if available. 937 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 938 }, 939 "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. 940 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 941 "displayName": "A String", # The organizer's name, if available. 942 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 943 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 944 }, 945 "summary": "A String", # Title of the event. 946 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 947 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 948 # - the length of the ID must be between 5 and 1024 characters 949 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 950 # If you do not specify an ID, it will be automatically generated by the server. 951 # 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. 952 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 953 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 954 { 955 "comment": "A String", # The attendee's response comment. Optional. 956 "displayName": "A String", # The attendee's name, if available. Optional. 957 "responseStatus": "A String", # The attendee's response status. Possible values are: 958 # - "needsAction" - The attendee has not responded to the invitation. 959 # - "declined" - The attendee has declined the invitation. 960 # - "tentative" - The attendee has tentatively accepted the invitation. 961 # - "accepted" - The attendee has accepted the invitation. 962 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 963 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 964 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 965 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 966 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 967 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 968 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 969 }, 970 ], 971 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 972 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 973 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 974 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 975 }, 976 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 977 "recurrence": [ # 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. 978 "A String", 979 ], 980 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 981 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 982 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 983 }, 984 "etag": "A String", # ETag of the resource. 985 "location": "A String", # Geographic location of the event as free-form text. Optional. 986 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 987 "gadget": { # A gadget that extends this event. 988 "preferences": { # Preferences. 989 "a_key": "A String", # The preference name and corresponding value. 990 }, 991 "title": "A String", # The gadget's title. 992 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 993 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 994 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 995 "type": "A String", # The gadget's type. 996 "display": "A String", # The gadget's display mode. Optional. Possible values are: 997 # - "icon" - The gadget displays next to the event's title in the calendar view. 998 # - "chip" - The gadget displays when the event is clicked. 999 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 1000 }, 1001 "status": "A String", # Status of the event. Optional. Possible values are: 1002 # - "confirmed" - The event is confirmed. This is the default status. 1003 # - "tentative" - The event is tentatively confirmed. 1004 # - "cancelled" - The event is cancelled. 1005 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 1006 "description": "A String", # Description of the event. Optional. 1007 "iCalUID": "A 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. 1008 # 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. 1009 "extendedProperties": { # Extended properties of the event. 1010 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 1011 "a_key": "A String", # The name of the shared property and the corresponding value. 1012 }, 1013 "private": { # Properties that are private to the copy of the event that appears on this calendar. 1014 "a_key": "A String", # The name of the private property and the corresponding value. 1015 }, 1016 }, 1017 "endTimeUnspecified": 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. 1018 "sequence": 42, # Sequence number as per iCalendar. 1019 "visibility": "default", # Visibility of the event. Optional. Possible values are: 1020 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 1021 # - "public" - The event is public and event details are visible to all readers of the calendar. 1022 # - "private" - The event is private and only event attendees may view event details. 1023 # - "confidential" - The event is private. This value is provided for compatibility reasons. 1024 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 1025 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 1026 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1027 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1028 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1029 }, 1030 "attendeesOmitted": 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. 1031 "kind": "calendar#event", # Type of the resource ("calendar#event"). 1032 "locked": 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. 1033 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 1034 "colorId": "A 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. 1035 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 1036 "reminders": { # Information about the event's reminders for the authenticated user. 1037 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 1038 { 1039 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 1040 "method": "A String", # The method used by this reminder. Possible values are: 1041 # - "email" - Reminders are sent via email. 1042 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1043 # - "popup" - Reminders are sent via a UI popup. 1044 }, 1045 ], 1046 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 1047 }, 1048 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 1049 "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. 1050 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1051 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1052 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1053 }, 1054 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 1055 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 1056 # - "opaque" - The event blocks time on the calendar. This is the default value. 1057 # - "transparent" - The event does not block time on the calendar. 1058 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 1059 }, 1060 ], 1061 "updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only. 1062 "summary": "A String", # Title of the calendar. Read-only. 1063 "etag": "A String", # ETag of the collection. 1064 "timeZone": "A String", # The time zone of the calendar. Read-only. 1065 "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. 1066 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are: 1067 # - "none" - The user has no access. 1068 # - "freeBusyReader" - The user has read access to free/busy information. 1069 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 1070 # - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. 1071 # - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. 1072 }</pre> 1073 </div> 1074 1075 <div class="method"> 1076 <code class="details" id="instances_next">instances_next(previous_request, previous_response)</code> 1077 <pre>Retrieves the next page of results. 1078 1079 Args: 1080 previous_request: The request for the previous page. (required) 1081 previous_response: The response from the request for the previous page. (required) 1082 1083 Returns: 1084 A request object that you can call 'execute()' on to request the next 1085 page. Returns None if there are no more items in the collection. 1086 </pre> 1087 </div> 1088 1089 <div class="method"> 1090 <code class="details" id="list">list(calendarId, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</code> 1091 <pre>Returns events on the specified calendar. 1092 1093 Args: 1094 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) 1095 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order. 1096 Allowed values 1097 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True) 1098 updated - Order by last modification time (ascending). 1099 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False. 1100 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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. 1101 privateExtendedProperty: string, 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. (repeated) 1102 pageToken: string, Token specifying which result page to return. Optional. 1103 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. 1104 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. 1105 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. 1106 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. 1107 sharedExtendedProperty: string, 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. (repeated) 1108 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 1109 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. 1110 There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. 1111 1112 These are: 1113 - iCalUID 1114 - orderBy 1115 - privateExtendedProperty 1116 - q 1117 - sharedExtendedProperty 1118 - timeMin 1119 - timeMax 1120 - updatedMin 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. 1121 Learn more about incremental synchronization. 1122 Optional. The default is to return all entries. 1123 iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional. 1124 maxResults: integer, Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. 1125 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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. 1126 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional. 1127 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. 1128 1129 Returns: 1130 An object of the form: 1131 1132 { 1133 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. 1134 "kind": "calendar#events", # Type of the collection ("calendar#events"). 1135 "defaultReminders": [ # 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). 1136 { 1137 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 1138 "method": "A String", # The method used by this reminder. Possible values are: 1139 # - "email" - Reminders are sent via email. 1140 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1141 # - "popup" - Reminders are sent via a UI popup. 1142 }, 1143 ], 1144 "description": "A String", # Description of the calendar. Read-only. 1145 "items": [ # List of events on the calendar. 1146 { 1147 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 1148 # In order to modify attachments the supportsAttachments request parameter should be set to true. 1149 # There can be at most 25 attachments per event, 1150 { 1151 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 1152 "title": "A String", # Attachment title. 1153 "fileUrl": "A String", # URL link to the attachment. 1154 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 1155 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 1156 "fileId": "A String", # ID of the attached file. Read-only. 1157 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 1158 }, 1159 ], 1160 "creator": { # The creator of the event. Read-only. 1161 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1162 "displayName": "A String", # The creator's name, if available. 1163 "email": "A String", # The creator's email address, if available. 1164 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1165 }, 1166 "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. 1167 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1168 "displayName": "A String", # The organizer's name, if available. 1169 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 1170 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1171 }, 1172 "summary": "A String", # Title of the event. 1173 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 1174 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 1175 # - the length of the ID must be between 5 and 1024 characters 1176 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 1177 # If you do not specify an ID, it will be automatically generated by the server. 1178 # 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. 1179 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 1180 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 1181 { 1182 "comment": "A String", # The attendee's response comment. Optional. 1183 "displayName": "A String", # The attendee's name, if available. Optional. 1184 "responseStatus": "A String", # The attendee's response status. Possible values are: 1185 # - "needsAction" - The attendee has not responded to the invitation. 1186 # - "declined" - The attendee has declined the invitation. 1187 # - "tentative" - The attendee has tentatively accepted the invitation. 1188 # - "accepted" - The attendee has accepted the invitation. 1189 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 1190 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1191 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 1192 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 1193 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 1194 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 1195 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 1196 }, 1197 ], 1198 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 1199 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1200 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1201 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1202 }, 1203 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 1204 "recurrence": [ # 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. 1205 "A String", 1206 ], 1207 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 1208 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 1209 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 1210 }, 1211 "etag": "A String", # ETag of the resource. 1212 "location": "A String", # Geographic location of the event as free-form text. Optional. 1213 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 1214 "gadget": { # A gadget that extends this event. 1215 "preferences": { # Preferences. 1216 "a_key": "A String", # The preference name and corresponding value. 1217 }, 1218 "title": "A String", # The gadget's title. 1219 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 1220 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 1221 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 1222 "type": "A String", # The gadget's type. 1223 "display": "A String", # The gadget's display mode. Optional. Possible values are: 1224 # - "icon" - The gadget displays next to the event's title in the calendar view. 1225 # - "chip" - The gadget displays when the event is clicked. 1226 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 1227 }, 1228 "status": "A String", # Status of the event. Optional. Possible values are: 1229 # - "confirmed" - The event is confirmed. This is the default status. 1230 # - "tentative" - The event is tentatively confirmed. 1231 # - "cancelled" - The event is cancelled. 1232 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 1233 "description": "A String", # Description of the event. Optional. 1234 "iCalUID": "A 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. 1235 # 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. 1236 "extendedProperties": { # Extended properties of the event. 1237 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 1238 "a_key": "A String", # The name of the shared property and the corresponding value. 1239 }, 1240 "private": { # Properties that are private to the copy of the event that appears on this calendar. 1241 "a_key": "A String", # The name of the private property and the corresponding value. 1242 }, 1243 }, 1244 "endTimeUnspecified": 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. 1245 "sequence": 42, # Sequence number as per iCalendar. 1246 "visibility": "default", # Visibility of the event. Optional. Possible values are: 1247 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 1248 # - "public" - The event is public and event details are visible to all readers of the calendar. 1249 # - "private" - The event is private and only event attendees may view event details. 1250 # - "confidential" - The event is private. This value is provided for compatibility reasons. 1251 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 1252 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 1253 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1254 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1255 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1256 }, 1257 "attendeesOmitted": 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. 1258 "kind": "calendar#event", # Type of the resource ("calendar#event"). 1259 "locked": 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. 1260 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 1261 "colorId": "A 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. 1262 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 1263 "reminders": { # Information about the event's reminders for the authenticated user. 1264 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 1265 { 1266 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 1267 "method": "A String", # The method used by this reminder. Possible values are: 1268 # - "email" - Reminders are sent via email. 1269 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1270 # - "popup" - Reminders are sent via a UI popup. 1271 }, 1272 ], 1273 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 1274 }, 1275 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 1276 "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. 1277 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1278 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1279 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1280 }, 1281 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 1282 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 1283 # - "opaque" - The event blocks time on the calendar. This is the default value. 1284 # - "transparent" - The event does not block time on the calendar. 1285 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 1286 }, 1287 ], 1288 "updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only. 1289 "summary": "A String", # Title of the calendar. Read-only. 1290 "etag": "A String", # ETag of the collection. 1291 "timeZone": "A String", # The time zone of the calendar. Read-only. 1292 "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. 1293 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are: 1294 # - "none" - The user has no access. 1295 # - "freeBusyReader" - The user has read access to free/busy information. 1296 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 1297 # - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. 1298 # - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. 1299 }</pre> 1300 </div> 1301 1302 <div class="method"> 1303 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1304 <pre>Retrieves the next page of results. 1305 1306 Args: 1307 previous_request: The request for the previous page. (required) 1308 previous_response: The response from the request for the previous page. (required) 1309 1310 Returns: 1311 A request object that you can call 'execute()' on to request the next 1312 page. Returns None if there are no more items in the collection. 1313 </pre> 1314 </div> 1315 1316 <div class="method"> 1317 <code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None)</code> 1318 <pre>Moves an event to another calendar, i.e. changes an event's organizer. 1319 1320 Args: 1321 calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required) 1322 eventId: string, Event identifier. (required) 1323 destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required) 1324 sendNotifications: boolean, Whether to send notifications about the change of the event's organizer. Optional. The default is False. 1325 1326 Returns: 1327 An object of the form: 1328 1329 { 1330 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 1331 # In order to modify attachments the supportsAttachments request parameter should be set to true. 1332 # There can be at most 25 attachments per event, 1333 { 1334 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 1335 "title": "A String", # Attachment title. 1336 "fileUrl": "A String", # URL link to the attachment. 1337 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 1338 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 1339 "fileId": "A String", # ID of the attached file. Read-only. 1340 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 1341 }, 1342 ], 1343 "creator": { # The creator of the event. Read-only. 1344 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1345 "displayName": "A String", # The creator's name, if available. 1346 "email": "A String", # The creator's email address, if available. 1347 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1348 }, 1349 "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. 1350 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1351 "displayName": "A String", # The organizer's name, if available. 1352 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 1353 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1354 }, 1355 "summary": "A String", # Title of the event. 1356 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 1357 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 1358 # - the length of the ID must be between 5 and 1024 characters 1359 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 1360 # If you do not specify an ID, it will be automatically generated by the server. 1361 # 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. 1362 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 1363 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 1364 { 1365 "comment": "A String", # The attendee's response comment. Optional. 1366 "displayName": "A String", # The attendee's name, if available. Optional. 1367 "responseStatus": "A String", # The attendee's response status. Possible values are: 1368 # - "needsAction" - The attendee has not responded to the invitation. 1369 # - "declined" - The attendee has declined the invitation. 1370 # - "tentative" - The attendee has tentatively accepted the invitation. 1371 # - "accepted" - The attendee has accepted the invitation. 1372 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 1373 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1374 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 1375 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 1376 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 1377 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 1378 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 1379 }, 1380 ], 1381 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 1382 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1383 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1384 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1385 }, 1386 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 1387 "recurrence": [ # 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. 1388 "A String", 1389 ], 1390 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 1391 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 1392 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 1393 }, 1394 "etag": "A String", # ETag of the resource. 1395 "location": "A String", # Geographic location of the event as free-form text. Optional. 1396 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 1397 "gadget": { # A gadget that extends this event. 1398 "preferences": { # Preferences. 1399 "a_key": "A String", # The preference name and corresponding value. 1400 }, 1401 "title": "A String", # The gadget's title. 1402 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 1403 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 1404 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 1405 "type": "A String", # The gadget's type. 1406 "display": "A String", # The gadget's display mode. Optional. Possible values are: 1407 # - "icon" - The gadget displays next to the event's title in the calendar view. 1408 # - "chip" - The gadget displays when the event is clicked. 1409 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 1410 }, 1411 "status": "A String", # Status of the event. Optional. Possible values are: 1412 # - "confirmed" - The event is confirmed. This is the default status. 1413 # - "tentative" - The event is tentatively confirmed. 1414 # - "cancelled" - The event is cancelled. 1415 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 1416 "description": "A String", # Description of the event. Optional. 1417 "iCalUID": "A 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. 1418 # 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. 1419 "extendedProperties": { # Extended properties of the event. 1420 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 1421 "a_key": "A String", # The name of the shared property and the corresponding value. 1422 }, 1423 "private": { # Properties that are private to the copy of the event that appears on this calendar. 1424 "a_key": "A String", # The name of the private property and the corresponding value. 1425 }, 1426 }, 1427 "endTimeUnspecified": 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. 1428 "sequence": 42, # Sequence number as per iCalendar. 1429 "visibility": "default", # Visibility of the event. Optional. Possible values are: 1430 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 1431 # - "public" - The event is public and event details are visible to all readers of the calendar. 1432 # - "private" - The event is private and only event attendees may view event details. 1433 # - "confidential" - The event is private. This value is provided for compatibility reasons. 1434 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 1435 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 1436 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1437 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1438 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1439 }, 1440 "attendeesOmitted": 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. 1441 "kind": "calendar#event", # Type of the resource ("calendar#event"). 1442 "locked": 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. 1443 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 1444 "colorId": "A 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. 1445 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 1446 "reminders": { # Information about the event's reminders for the authenticated user. 1447 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 1448 { 1449 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 1450 "method": "A String", # The method used by this reminder. Possible values are: 1451 # - "email" - Reminders are sent via email. 1452 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1453 # - "popup" - Reminders are sent via a UI popup. 1454 }, 1455 ], 1456 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 1457 }, 1458 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 1459 "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. 1460 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1461 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1462 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1463 }, 1464 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 1465 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 1466 # - "opaque" - The event blocks time on the calendar. This is the default value. 1467 # - "transparent" - The event does not block time on the calendar. 1468 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 1469 }</pre> 1470 </div> 1471 1472 <div class="method"> 1473 <code class="details" id="patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, supportsAttachments=None, maxAttendees=None)</code> 1474 <pre>Updates an event. This method supports patch semantics. 1475 1476 Args: 1477 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) 1478 eventId: string, Event identifier. (required) 1479 body: object, The request body. (required) 1480 The object takes the form of: 1481 1482 { 1483 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 1484 # In order to modify attachments the supportsAttachments request parameter should be set to true. 1485 # There can be at most 25 attachments per event, 1486 { 1487 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 1488 "title": "A String", # Attachment title. 1489 "fileUrl": "A String", # URL link to the attachment. 1490 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 1491 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 1492 "fileId": "A String", # ID of the attached file. Read-only. 1493 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 1494 }, 1495 ], 1496 "creator": { # The creator of the event. Read-only. 1497 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1498 "displayName": "A String", # The creator's name, if available. 1499 "email": "A String", # The creator's email address, if available. 1500 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1501 }, 1502 "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. 1503 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1504 "displayName": "A String", # The organizer's name, if available. 1505 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 1506 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1507 }, 1508 "summary": "A String", # Title of the event. 1509 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 1510 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 1511 # - the length of the ID must be between 5 and 1024 characters 1512 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 1513 # If you do not specify an ID, it will be automatically generated by the server. 1514 # 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. 1515 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 1516 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 1517 { 1518 "comment": "A String", # The attendee's response comment. Optional. 1519 "displayName": "A String", # The attendee's name, if available. Optional. 1520 "responseStatus": "A String", # The attendee's response status. Possible values are: 1521 # - "needsAction" - The attendee has not responded to the invitation. 1522 # - "declined" - The attendee has declined the invitation. 1523 # - "tentative" - The attendee has tentatively accepted the invitation. 1524 # - "accepted" - The attendee has accepted the invitation. 1525 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 1526 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1527 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 1528 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 1529 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 1530 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 1531 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 1532 }, 1533 ], 1534 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 1535 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1536 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1537 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1538 }, 1539 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 1540 "recurrence": [ # 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. 1541 "A String", 1542 ], 1543 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 1544 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 1545 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 1546 }, 1547 "etag": "A String", # ETag of the resource. 1548 "location": "A String", # Geographic location of the event as free-form text. Optional. 1549 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 1550 "gadget": { # A gadget that extends this event. 1551 "preferences": { # Preferences. 1552 "a_key": "A String", # The preference name and corresponding value. 1553 }, 1554 "title": "A String", # The gadget's title. 1555 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 1556 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 1557 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 1558 "type": "A String", # The gadget's type. 1559 "display": "A String", # The gadget's display mode. Optional. Possible values are: 1560 # - "icon" - The gadget displays next to the event's title in the calendar view. 1561 # - "chip" - The gadget displays when the event is clicked. 1562 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 1563 }, 1564 "status": "A String", # Status of the event. Optional. Possible values are: 1565 # - "confirmed" - The event is confirmed. This is the default status. 1566 # - "tentative" - The event is tentatively confirmed. 1567 # - "cancelled" - The event is cancelled. 1568 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 1569 "description": "A String", # Description of the event. Optional. 1570 "iCalUID": "A 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. 1571 # 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. 1572 "extendedProperties": { # Extended properties of the event. 1573 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 1574 "a_key": "A String", # The name of the shared property and the corresponding value. 1575 }, 1576 "private": { # Properties that are private to the copy of the event that appears on this calendar. 1577 "a_key": "A String", # The name of the private property and the corresponding value. 1578 }, 1579 }, 1580 "endTimeUnspecified": 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. 1581 "sequence": 42, # Sequence number as per iCalendar. 1582 "visibility": "default", # Visibility of the event. Optional. Possible values are: 1583 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 1584 # - "public" - The event is public and event details are visible to all readers of the calendar. 1585 # - "private" - The event is private and only event attendees may view event details. 1586 # - "confidential" - The event is private. This value is provided for compatibility reasons. 1587 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 1588 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 1589 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1590 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1591 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1592 }, 1593 "attendeesOmitted": 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. 1594 "kind": "calendar#event", # Type of the resource ("calendar#event"). 1595 "locked": 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. 1596 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 1597 "colorId": "A 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. 1598 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 1599 "reminders": { # Information about the event's reminders for the authenticated user. 1600 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 1601 { 1602 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 1603 "method": "A String", # The method used by this reminder. Possible values are: 1604 # - "email" - Reminders are sent via email. 1605 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1606 # - "popup" - Reminders are sent via a UI popup. 1607 }, 1608 ], 1609 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 1610 }, 1611 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 1612 "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. 1613 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1614 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1615 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1616 }, 1617 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 1618 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 1619 # - "opaque" - The event blocks time on the calendar. This is the default value. 1620 # - "transparent" - The event does not block time on the calendar. 1621 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 1622 } 1623 1624 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False. 1625 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. 1626 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. 1627 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 1628 1629 Returns: 1630 An object of the form: 1631 1632 { 1633 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 1634 # In order to modify attachments the supportsAttachments request parameter should be set to true. 1635 # There can be at most 25 attachments per event, 1636 { 1637 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 1638 "title": "A String", # Attachment title. 1639 "fileUrl": "A String", # URL link to the attachment. 1640 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 1641 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 1642 "fileId": "A String", # ID of the attached file. Read-only. 1643 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 1644 }, 1645 ], 1646 "creator": { # The creator of the event. Read-only. 1647 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1648 "displayName": "A String", # The creator's name, if available. 1649 "email": "A String", # The creator's email address, if available. 1650 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1651 }, 1652 "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. 1653 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1654 "displayName": "A String", # The organizer's name, if available. 1655 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 1656 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1657 }, 1658 "summary": "A String", # Title of the event. 1659 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 1660 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 1661 # - the length of the ID must be between 5 and 1024 characters 1662 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 1663 # If you do not specify an ID, it will be automatically generated by the server. 1664 # 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. 1665 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 1666 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 1667 { 1668 "comment": "A String", # The attendee's response comment. Optional. 1669 "displayName": "A String", # The attendee's name, if available. Optional. 1670 "responseStatus": "A String", # The attendee's response status. Possible values are: 1671 # - "needsAction" - The attendee has not responded to the invitation. 1672 # - "declined" - The attendee has declined the invitation. 1673 # - "tentative" - The attendee has tentatively accepted the invitation. 1674 # - "accepted" - The attendee has accepted the invitation. 1675 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 1676 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1677 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 1678 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 1679 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 1680 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 1681 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 1682 }, 1683 ], 1684 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 1685 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1686 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1687 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1688 }, 1689 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 1690 "recurrence": [ # 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. 1691 "A String", 1692 ], 1693 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 1694 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 1695 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 1696 }, 1697 "etag": "A String", # ETag of the resource. 1698 "location": "A String", # Geographic location of the event as free-form text. Optional. 1699 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 1700 "gadget": { # A gadget that extends this event. 1701 "preferences": { # Preferences. 1702 "a_key": "A String", # The preference name and corresponding value. 1703 }, 1704 "title": "A String", # The gadget's title. 1705 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 1706 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 1707 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 1708 "type": "A String", # The gadget's type. 1709 "display": "A String", # The gadget's display mode. Optional. Possible values are: 1710 # - "icon" - The gadget displays next to the event's title in the calendar view. 1711 # - "chip" - The gadget displays when the event is clicked. 1712 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 1713 }, 1714 "status": "A String", # Status of the event. Optional. Possible values are: 1715 # - "confirmed" - The event is confirmed. This is the default status. 1716 # - "tentative" - The event is tentatively confirmed. 1717 # - "cancelled" - The event is cancelled. 1718 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 1719 "description": "A String", # Description of the event. Optional. 1720 "iCalUID": "A 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. 1721 # 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. 1722 "extendedProperties": { # Extended properties of the event. 1723 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 1724 "a_key": "A String", # The name of the shared property and the corresponding value. 1725 }, 1726 "private": { # Properties that are private to the copy of the event that appears on this calendar. 1727 "a_key": "A String", # The name of the private property and the corresponding value. 1728 }, 1729 }, 1730 "endTimeUnspecified": 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. 1731 "sequence": 42, # Sequence number as per iCalendar. 1732 "visibility": "default", # Visibility of the event. Optional. Possible values are: 1733 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 1734 # - "public" - The event is public and event details are visible to all readers of the calendar. 1735 # - "private" - The event is private and only event attendees may view event details. 1736 # - "confidential" - The event is private. This value is provided for compatibility reasons. 1737 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 1738 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 1739 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1740 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1741 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1742 }, 1743 "attendeesOmitted": 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. 1744 "kind": "calendar#event", # Type of the resource ("calendar#event"). 1745 "locked": 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. 1746 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 1747 "colorId": "A 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. 1748 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 1749 "reminders": { # Information about the event's reminders for the authenticated user. 1750 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 1751 { 1752 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 1753 "method": "A String", # The method used by this reminder. Possible values are: 1754 # - "email" - Reminders are sent via email. 1755 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1756 # - "popup" - Reminders are sent via a UI popup. 1757 }, 1758 ], 1759 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 1760 }, 1761 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 1762 "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. 1763 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1764 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1765 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1766 }, 1767 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 1768 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 1769 # - "opaque" - The event blocks time on the calendar. This is the default value. 1770 # - "transparent" - The event does not block time on the calendar. 1771 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 1772 }</pre> 1773 </div> 1774 1775 <div class="method"> 1776 <code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None)</code> 1777 <pre>Creates an event based on a simple text string. 1778 1779 Args: 1780 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) 1781 text: string, The text describing the event to be created. (required) 1782 sendNotifications: boolean, Whether to send notifications about the creation of the event. Optional. The default is False. 1783 1784 Returns: 1785 An object of the form: 1786 1787 { 1788 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 1789 # In order to modify attachments the supportsAttachments request parameter should be set to true. 1790 # There can be at most 25 attachments per event, 1791 { 1792 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 1793 "title": "A String", # Attachment title. 1794 "fileUrl": "A String", # URL link to the attachment. 1795 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 1796 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 1797 "fileId": "A String", # ID of the attached file. Read-only. 1798 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 1799 }, 1800 ], 1801 "creator": { # The creator of the event. Read-only. 1802 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1803 "displayName": "A String", # The creator's name, if available. 1804 "email": "A String", # The creator's email address, if available. 1805 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1806 }, 1807 "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. 1808 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1809 "displayName": "A String", # The organizer's name, if available. 1810 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 1811 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1812 }, 1813 "summary": "A String", # Title of the event. 1814 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 1815 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 1816 # - the length of the ID must be between 5 and 1024 characters 1817 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 1818 # If you do not specify an ID, it will be automatically generated by the server. 1819 # 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. 1820 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 1821 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 1822 { 1823 "comment": "A String", # The attendee's response comment. Optional. 1824 "displayName": "A String", # The attendee's name, if available. Optional. 1825 "responseStatus": "A String", # The attendee's response status. Possible values are: 1826 # - "needsAction" - The attendee has not responded to the invitation. 1827 # - "declined" - The attendee has declined the invitation. 1828 # - "tentative" - The attendee has tentatively accepted the invitation. 1829 # - "accepted" - The attendee has accepted the invitation. 1830 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 1831 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1832 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 1833 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 1834 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 1835 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 1836 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 1837 }, 1838 ], 1839 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 1840 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1841 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1842 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1843 }, 1844 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 1845 "recurrence": [ # 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. 1846 "A String", 1847 ], 1848 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 1849 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 1850 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 1851 }, 1852 "etag": "A String", # ETag of the resource. 1853 "location": "A String", # Geographic location of the event as free-form text. Optional. 1854 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 1855 "gadget": { # A gadget that extends this event. 1856 "preferences": { # Preferences. 1857 "a_key": "A String", # The preference name and corresponding value. 1858 }, 1859 "title": "A String", # The gadget's title. 1860 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 1861 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 1862 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 1863 "type": "A String", # The gadget's type. 1864 "display": "A String", # The gadget's display mode. Optional. Possible values are: 1865 # - "icon" - The gadget displays next to the event's title in the calendar view. 1866 # - "chip" - The gadget displays when the event is clicked. 1867 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 1868 }, 1869 "status": "A String", # Status of the event. Optional. Possible values are: 1870 # - "confirmed" - The event is confirmed. This is the default status. 1871 # - "tentative" - The event is tentatively confirmed. 1872 # - "cancelled" - The event is cancelled. 1873 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 1874 "description": "A String", # Description of the event. Optional. 1875 "iCalUID": "A 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. 1876 # 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. 1877 "extendedProperties": { # Extended properties of the event. 1878 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 1879 "a_key": "A String", # The name of the shared property and the corresponding value. 1880 }, 1881 "private": { # Properties that are private to the copy of the event that appears on this calendar. 1882 "a_key": "A String", # The name of the private property and the corresponding value. 1883 }, 1884 }, 1885 "endTimeUnspecified": 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. 1886 "sequence": 42, # Sequence number as per iCalendar. 1887 "visibility": "default", # Visibility of the event. Optional. Possible values are: 1888 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 1889 # - "public" - The event is public and event details are visible to all readers of the calendar. 1890 # - "private" - The event is private and only event attendees may view event details. 1891 # - "confidential" - The event is private. This value is provided for compatibility reasons. 1892 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 1893 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 1894 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1895 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1896 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1897 }, 1898 "attendeesOmitted": 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. 1899 "kind": "calendar#event", # Type of the resource ("calendar#event"). 1900 "locked": 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. 1901 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 1902 "colorId": "A 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. 1903 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 1904 "reminders": { # Information about the event's reminders for the authenticated user. 1905 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 1906 { 1907 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 1908 "method": "A String", # The method used by this reminder. Possible values are: 1909 # - "email" - Reminders are sent via email. 1910 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1911 # - "popup" - Reminders are sent via a UI popup. 1912 }, 1913 ], 1914 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 1915 }, 1916 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 1917 "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. 1918 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1919 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1920 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1921 }, 1922 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 1923 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 1924 # - "opaque" - The event blocks time on the calendar. This is the default value. 1925 # - "transparent" - The event does not block time on the calendar. 1926 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 1927 }</pre> 1928 </div> 1929 1930 <div class="method"> 1931 <code class="details" id="update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, supportsAttachments=None, maxAttendees=None)</code> 1932 <pre>Updates an event. 1933 1934 Args: 1935 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) 1936 eventId: string, Event identifier. (required) 1937 body: object, The request body. (required) 1938 The object takes the form of: 1939 1940 { 1941 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 1942 # In order to modify attachments the supportsAttachments request parameter should be set to true. 1943 # There can be at most 25 attachments per event, 1944 { 1945 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 1946 "title": "A String", # Attachment title. 1947 "fileUrl": "A String", # URL link to the attachment. 1948 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 1949 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 1950 "fileId": "A String", # ID of the attached file. Read-only. 1951 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 1952 }, 1953 ], 1954 "creator": { # The creator of the event. Read-only. 1955 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1956 "displayName": "A String", # The creator's name, if available. 1957 "email": "A String", # The creator's email address, if available. 1958 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1959 }, 1960 "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. 1961 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1962 "displayName": "A String", # The organizer's name, if available. 1963 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 1964 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1965 }, 1966 "summary": "A String", # Title of the event. 1967 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 1968 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 1969 # - the length of the ID must be between 5 and 1024 characters 1970 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 1971 # If you do not specify an ID, it will be automatically generated by the server. 1972 # 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. 1973 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 1974 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 1975 { 1976 "comment": "A String", # The attendee's response comment. Optional. 1977 "displayName": "A String", # The attendee's name, if available. Optional. 1978 "responseStatus": "A String", # The attendee's response status. Possible values are: 1979 # - "needsAction" - The attendee has not responded to the invitation. 1980 # - "declined" - The attendee has declined the invitation. 1981 # - "tentative" - The attendee has tentatively accepted the invitation. 1982 # - "accepted" - The attendee has accepted the invitation. 1983 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 1984 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 1985 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 1986 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 1987 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 1988 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 1989 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 1990 }, 1991 ], 1992 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 1993 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1994 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 1995 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 1996 }, 1997 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 1998 "recurrence": [ # 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. 1999 "A String", 2000 ], 2001 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 2002 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 2003 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 2004 }, 2005 "etag": "A String", # ETag of the resource. 2006 "location": "A String", # Geographic location of the event as free-form text. Optional. 2007 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 2008 "gadget": { # A gadget that extends this event. 2009 "preferences": { # Preferences. 2010 "a_key": "A String", # The preference name and corresponding value. 2011 }, 2012 "title": "A String", # The gadget's title. 2013 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 2014 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 2015 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 2016 "type": "A String", # The gadget's type. 2017 "display": "A String", # The gadget's display mode. Optional. Possible values are: 2018 # - "icon" - The gadget displays next to the event's title in the calendar view. 2019 # - "chip" - The gadget displays when the event is clicked. 2020 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 2021 }, 2022 "status": "A String", # Status of the event. Optional. Possible values are: 2023 # - "confirmed" - The event is confirmed. This is the default status. 2024 # - "tentative" - The event is tentatively confirmed. 2025 # - "cancelled" - The event is cancelled. 2026 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 2027 "description": "A String", # Description of the event. Optional. 2028 "iCalUID": "A 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. 2029 # 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. 2030 "extendedProperties": { # Extended properties of the event. 2031 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 2032 "a_key": "A String", # The name of the shared property and the corresponding value. 2033 }, 2034 "private": { # Properties that are private to the copy of the event that appears on this calendar. 2035 "a_key": "A String", # The name of the private property and the corresponding value. 2036 }, 2037 }, 2038 "endTimeUnspecified": 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. 2039 "sequence": 42, # Sequence number as per iCalendar. 2040 "visibility": "default", # Visibility of the event. Optional. Possible values are: 2041 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 2042 # - "public" - The event is public and event details are visible to all readers of the calendar. 2043 # - "private" - The event is private and only event attendees may view event details. 2044 # - "confidential" - The event is private. This value is provided for compatibility reasons. 2045 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 2046 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 2047 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2048 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 2049 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 2050 }, 2051 "attendeesOmitted": 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. 2052 "kind": "calendar#event", # Type of the resource ("calendar#event"). 2053 "locked": 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. 2054 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 2055 "colorId": "A 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. 2056 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 2057 "reminders": { # Information about the event's reminders for the authenticated user. 2058 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 2059 { 2060 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 2061 "method": "A String", # The method used by this reminder. Possible values are: 2062 # - "email" - Reminders are sent via email. 2063 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 2064 # - "popup" - Reminders are sent via a UI popup. 2065 }, 2066 ], 2067 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 2068 }, 2069 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 2070 "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. 2071 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2072 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 2073 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 2074 }, 2075 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 2076 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 2077 # - "opaque" - The event blocks time on the calendar. This is the default value. 2078 # - "transparent" - The event does not block time on the calendar. 2079 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 2080 } 2081 2082 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False. 2083 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. 2084 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. 2085 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 2086 2087 Returns: 2088 An object of the form: 2089 2090 { 2091 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 2092 # In order to modify attachments the supportsAttachments request parameter should be set to true. 2093 # There can be at most 25 attachments per event, 2094 { 2095 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 2096 "title": "A String", # Attachment title. 2097 "fileUrl": "A String", # URL link to the attachment. 2098 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 2099 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 2100 "fileId": "A String", # ID of the attached file. Read-only. 2101 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 2102 }, 2103 ], 2104 "creator": { # The creator of the event. Read-only. 2105 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 2106 "displayName": "A String", # The creator's name, if available. 2107 "email": "A String", # The creator's email address, if available. 2108 "id": "A String", # The creator's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 2109 }, 2110 "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. 2111 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 2112 "displayName": "A String", # The organizer's name, if available. 2113 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 2114 "id": "A String", # The organizer's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 2115 }, 2116 "summary": "A String", # Title of the event. 2117 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: 2118 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 2119 # - the length of the ID must be between 5 and 1024 characters 2120 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. 2121 # If you do not specify an ID, it will be automatically generated by the server. 2122 # 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. 2123 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 2124 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 2125 { 2126 "comment": "A String", # The attendee's response comment. Optional. 2127 "displayName": "A String", # The attendee's name, if available. Optional. 2128 "responseStatus": "A String", # The attendee's response status. Possible values are: 2129 # - "needsAction" - The attendee has not responded to the invitation. 2130 # - "declined" - The attendee has declined the invitation. 2131 # - "tentative" - The attendee has tentatively accepted the invitation. 2132 # - "accepted" - The attendee has accepted the invitation. 2133 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 2134 "id": "A String", # The attendee's Profile ID, if available. It corresponds to theid field in the People collection of the Google+ API 2135 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 2136 "resource": false, # Whether the attendee is a resource. Read-only. The default is False. 2137 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 2138 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 2139 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. 2140 }, 2141 ], 2142 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 2143 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2144 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 2145 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 2146 }, 2147 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 2148 "recurrence": [ # 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. 2149 "A String", 2150 ], 2151 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. 2152 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 2153 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 2154 }, 2155 "etag": "A String", # ETag of the resource. 2156 "location": "A String", # Geographic location of the event as free-form text. Optional. 2157 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 2158 "gadget": { # A gadget that extends this event. 2159 "preferences": { # Preferences. 2160 "a_key": "A String", # The preference name and corresponding value. 2161 }, 2162 "title": "A String", # The gadget's title. 2163 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 2164 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 2165 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 2166 "type": "A String", # The gadget's type. 2167 "display": "A String", # The gadget's display mode. Optional. Possible values are: 2168 # - "icon" - The gadget displays next to the event's title in the calendar view. 2169 # - "chip" - The gadget displays when the event is clicked. 2170 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 2171 }, 2172 "status": "A String", # Status of the event. Optional. Possible values are: 2173 # - "confirmed" - The event is confirmed. This is the default status. 2174 # - "tentative" - The event is tentatively confirmed. 2175 # - "cancelled" - The event is cancelled. 2176 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 2177 "description": "A String", # Description of the event. Optional. 2178 "iCalUID": "A 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. 2179 # 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. 2180 "extendedProperties": { # Extended properties of the event. 2181 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 2182 "a_key": "A String", # The name of the shared property and the corresponding value. 2183 }, 2184 "private": { # Properties that are private to the copy of the event that appears on this calendar. 2185 "a_key": "A String", # The name of the private property and the corresponding value. 2186 }, 2187 }, 2188 "endTimeUnspecified": 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. 2189 "sequence": 42, # Sequence number as per iCalendar. 2190 "visibility": "default", # Visibility of the event. Optional. Possible values are: 2191 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 2192 # - "public" - The event is public and event details are visible to all readers of the calendar. 2193 # - "private" - The event is private and only event attendees may view event details. 2194 # - "confidential" - The event is private. This value is provided for compatibility reasons. 2195 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 2196 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 2197 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2198 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 2199 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 2200 }, 2201 "attendeesOmitted": 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. 2202 "kind": "calendar#event", # Type of the resource ("calendar#event"). 2203 "locked": 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. 2204 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 2205 "colorId": "A 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. 2206 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 2207 "reminders": { # Information about the event's reminders for the authenticated user. 2208 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. 2209 { 2210 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). 2211 "method": "A String", # The method used by this reminder. Possible values are: 2212 # - "email" - Reminders are sent via email. 2213 # - "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 2214 # - "popup" - Reminders are sent via a UI popup. 2215 }, 2216 ], 2217 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 2218 }, 2219 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 2220 "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. 2221 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2222 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. 2223 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. 2224 }, 2225 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 2226 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 2227 # - "opaque" - The event blocks time on the calendar. This is the default value. 2228 # - "transparent" - The event does not block time on the calendar. 2229 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. 2230 }</pre> 2231 </div> 2232 2233 <div class="method"> 2234 <code class="details" id="watch">watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</code> 2235 <pre>Watch for changes to Events resources. 2236 2237 Args: 2238 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) 2239 body: object, The request body. (required) 2240 The object takes the form of: 2241 2242 { 2243 "resourceUri": "A String", # A version-specific identifier for the watched resource. 2244 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 2245 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 2246 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 2247 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 2248 "params": { # Additional parameters controlling delivery channel behavior. Optional. 2249 "a_key": "A String", # Declares a new parameter by name. 2250 }, 2251 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 2252 "address": "A String", # The address where notifications are delivered for this channel. 2253 "type": "A String", # The type of delivery mechanism used for this channel. 2254 "id": "A String", # A UUID or similar unique string that identifies this channel. 2255 } 2256 2257 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order. 2258 Allowed values 2259 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True) 2260 updated - Order by last modification time (ascending). 2261 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False. 2262 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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. 2263 privateExtendedProperty: string, 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. (repeated) 2264 pageToken: string, Token specifying which result page to return. Optional. 2265 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. 2266 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. 2267 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. 2268 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. 2269 sharedExtendedProperty: string, 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. (repeated) 2270 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 2271 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. 2272 There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. 2273 2274 These are: 2275 - iCalUID 2276 - orderBy 2277 - privateExtendedProperty 2278 - q 2279 - sharedExtendedProperty 2280 - timeMin 2281 - timeMax 2282 - updatedMin 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. 2283 Learn more about incremental synchronization. 2284 Optional. The default is to return all entries. 2285 iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional. 2286 maxResults: integer, Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. 2287 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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. 2288 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional. 2289 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. 2290 2291 Returns: 2292 An object of the form: 2293 2294 { 2295 "resourceUri": "A String", # A version-specific identifier for the watched resource. 2296 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 2297 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 2298 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 2299 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 2300 "params": { # Additional parameters controlling delivery channel behavior. Optional. 2301 "a_key": "A String", # Declares a new parameter by name. 2302 }, 2303 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 2304 "address": "A String", # The address where notifications are delivered for this channel. 2305 "type": "A String", # The type of delivery mechanism used for this channel. 2306 "id": "A String", # A UUID or similar unique string that identifies this channel. 2307 }</pre> 2308 </div> 2309 2310 </body></html>
