1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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, sendUpdates=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, conferenceDataVersion=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, sendUpdates=None, conferenceDataVersion=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, sendUpdates=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, conferenceDataVersion=None, sendUpdates=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, sendUpdates=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, conferenceDataVersion=None, sendUpdates=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, sendUpdates=None)</code> 119 <pre>Deletes an event. 120 121Args: 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, Deprecated. Please use sendUpdates instead. 125 126Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false. 127 sendUpdates: string, Guests who should receive notifications about the deletion of the event. 128 Allowed values 129 all - Notifications are sent to all guests. 130 externalOnly - Notifications are sent to non-Google Calendar guests only. 131 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used). 132</pre> 133</div> 134 135<div class="method"> 136 <code class="details" id="get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</code> 137 <pre>Returns an event. 138 139Args: 140 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) 141 eventId: string, Event identifier. (required) 142 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. 143 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. 144 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. 145 146Returns: 147 An object of the form: 148 149 { 150 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 151 # In order to modify attachments the supportsAttachments request parameter should be set to true. 152 # There can be at most 25 attachments per event, 153 { 154 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 155 "title": "A String", # Attachment title. 156 "fileUrl": "A String", # URL link to the attachment. 157 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 158 # Required when adding an attachment. 159 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 160 "fileId": "A String", # ID of the attached file. Read-only. 161 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 162 }, 163 ], 164 "creator": { # The creator of the event. Read-only. 165 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 166 "displayName": "A String", # The creator's name, if available. 167 "email": "A String", # The creator's email address, if available. 168 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 169 }, 170 "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. 171 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 172 "displayName": "A String", # The organizer's name, if available. 173 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 174 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 175 }, 176 "summary": "A String", # Title of the event. 177 "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: 178 # - 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 179 # - the length of the ID must be between 5 and 1024 characters 180 # - 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. 181 # If you do not specify an ID, it will be automatically generated by the server. 182 # 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. 183 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 184 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 185 { 186 "comment": "A String", # The attendee's response comment. Optional. 187 "displayName": "A String", # The attendee's name, if available. Optional. 188 "responseStatus": "A String", # The attendee's response status. Possible values are: 189 # - "needsAction" - The attendee has not responded to the invitation. 190 # - "declined" - The attendee has declined the invitation. 191 # - "tentative" - The attendee has tentatively accepted the invitation. 192 # - "accepted" - The attendee has accepted the invitation. 193 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 194 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 195 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 196 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 197 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 198 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 199 "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. 200 # Required when adding an attendee. 201 }, 202 ], 203 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 204 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 205 "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. 206 "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. 207 }, 208 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 209 "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. 210 "A String", 211 ], 212 "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. 213 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 214 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 215 }, 216 "etag": "A String", # ETag of the resource. 217 "location": "A String", # Geographic location of the event as free-form text. Optional. 218 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 219 "gadget": { # A gadget that extends this event. 220 "preferences": { # Preferences. 221 "a_key": "A String", # The preference name and corresponding value. 222 }, 223 "title": "A String", # The gadget's title. 224 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 225 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 226 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 227 "type": "A String", # The gadget's type. 228 "display": "A String", # The gadget's display mode. Optional. Possible values are: 229 # - "icon" - The gadget displays next to the event's title in the calendar view. 230 # - "chip" - The gadget displays when the event is clicked. 231 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 232 }, 233 "status": "A String", # Status of the event. Optional. Possible values are: 234 # - "confirmed" - The event is confirmed. This is the default status. 235 # - "tentative" - The event is tentatively confirmed. 236 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 237 # A cancelled status represents two different states depending on the event type: 238 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 239 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 240 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 241 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 242 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 243 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 244 "description": "A String", # Description of the event. Optional. 245 "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. 246 # 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. 247 "extendedProperties": { # Extended properties of the event. 248 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 249 "a_key": "A String", # The name of the shared property and the corresponding value. 250 }, 251 "private": { # Properties that are private to the copy of the event that appears on this calendar. 252 "a_key": "A String", # The name of the private property and the corresponding value. 253 }, 254 }, 255 "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. 256 "sequence": 42, # Sequence number as per iCalendar. 257 "visibility": "default", # Visibility of the event. Optional. Possible values are: 258 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 259 # - "public" - The event is public and event details are visible to all readers of the calendar. 260 # - "private" - The event is private and only event attendees may view event details. 261 # - "confidential" - The event is private. This value is provided for compatibility reasons. 262 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 263 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 264 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 265 "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. 266 "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. 267 }, 268 "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. 269 "kind": "calendar#event", # Type of the resource ("calendar#event"). 270 "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. 271 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 272 "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. 273 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 274 "reminders": { # Information about the event's reminders for the authenticated user. 275 "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. 276 { 277 "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). 278 # Required when adding a reminder. 279 "method": "A String", # The method used by this reminder. Possible values are: 280 # - "email" - Reminders are sent via email. 281 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 282 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 283 # - "popup" - Reminders are sent via a UI popup. 284 # Required when adding a reminder. 285 }, 286 ], 287 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 288 }, 289 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 290 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 291 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 292 "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. 293 "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. 294 }, 295 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 296 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 297 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 298 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 299 "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. 300 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 301 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 302 # All of them must belong to the same conference. 303 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 304 { 305 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 306 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 307 # Optional. 308 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 309 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 310 # Optional. 311 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 312 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 313 # Optional. 314 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 315 # Format: 316 # - for video, http: or https: schema is required. 317 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 318 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 319 # - for more, http: or https: schema is required. 320 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 321 "A String", 322 ], 323 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 324 # Examples: 325 # - for video: meet.google.com/aaa-bbbb-ccc 326 # - for phone: +1 123 268 2601 327 # - for sip: 12345678@altostrat.com 328 # - for more: should not be filled 329 # Optional. 330 "entryPointType": "A String", # The type of the conference entry point. 331 # Possible values are: 332 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 333 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 334 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 335 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 336 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 337 # Calendar backend will populate this field only for EntryPointType.PHONE. 338 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 339 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 340 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 341 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 342 # Optional. 343 }, 344 ], 345 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 346 "addOnParameters": { # Additional add-on specific data. 347 "parameters": { 348 "a_key": "A String", 349 }, 350 }, 351 }, 352 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 353 "conferenceId": "A String", # The ID of the conference. 354 # Can be used by developers to keep track of conferences, should not be displayed to users. 355 # Values for solution types: 356 # - "eventHangout": unset. 357 # - "eventNamedHangout": the name of the Hangout. 358 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 359 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 360 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 361 "status": { # The status of the conference create request. 362 "statusCode": "A String", # The current status of the conference create request. Read-only. 363 # The possible values are: 364 # - "pending": the conference create request is still being processed. 365 # - "success": the conference create request succeeded, the entry points are populated. 366 # - "failure": the conference create request failed, there are no entry points. 367 }, 368 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 369 "type": "A String", # The conference solution type. 370 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 371 # The possible values are: 372 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 373 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 374 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 375 }, 376 "requestId": "A String", # The client-generated unique ID for this request. 377 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 378 }, 379 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 380 # Unset for a conference with a failed create request. 381 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 382 "iconUri": "A String", # The user-visible icon for this solution. 383 "name": "A String", # The user-visible name of this solution. Not localized. 384 "key": { # The key which can uniquely identify the conference solution for this event. 385 "type": "A String", # The conference solution type. 386 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 387 # The possible values are: 388 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 389 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 390 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 391 }, 392 }, 393 "signature": "A String", # The signature of the conference data. 394 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 395 # Unset for a conference with a failed create request. 396 # Optional for a conference with a pending create request. 397 }, 398 }</pre> 399</div> 400 401<div class="method"> 402 <code class="details" id="import_">import_(calendarId, body, supportsAttachments=None, conferenceDataVersion=None)</code> 403 <pre>Imports an event. This operation is used to add a private copy of an existing event to a calendar. 404 405Args: 406 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) 407 body: object, The request body. (required) 408 The object takes the form of: 409 410{ 411 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 412 # In order to modify attachments the supportsAttachments request parameter should be set to true. 413 # There can be at most 25 attachments per event, 414 { 415 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 416 "title": "A String", # Attachment title. 417 "fileUrl": "A String", # URL link to the attachment. 418 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 419 # Required when adding an attachment. 420 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 421 "fileId": "A String", # ID of the attached file. Read-only. 422 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 423 }, 424 ], 425 "creator": { # The creator of the event. Read-only. 426 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 427 "displayName": "A String", # The creator's name, if available. 428 "email": "A String", # The creator's email address, if available. 429 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 430 }, 431 "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. 432 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 433 "displayName": "A String", # The organizer's name, if available. 434 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 435 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 436 }, 437 "summary": "A String", # Title of the event. 438 "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: 439 # - 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 440 # - the length of the ID must be between 5 and 1024 characters 441 # - 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. 442 # If you do not specify an ID, it will be automatically generated by the server. 443 # 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. 444 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 445 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 446 { 447 "comment": "A String", # The attendee's response comment. Optional. 448 "displayName": "A String", # The attendee's name, if available. Optional. 449 "responseStatus": "A String", # The attendee's response status. Possible values are: 450 # - "needsAction" - The attendee has not responded to the invitation. 451 # - "declined" - The attendee has declined the invitation. 452 # - "tentative" - The attendee has tentatively accepted the invitation. 453 # - "accepted" - The attendee has accepted the invitation. 454 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 455 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 456 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 457 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 458 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 459 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 460 "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. 461 # Required when adding an attendee. 462 }, 463 ], 464 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 465 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 466 "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. 467 "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. 468 }, 469 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 470 "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. 471 "A String", 472 ], 473 "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. 474 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 475 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 476 }, 477 "etag": "A String", # ETag of the resource. 478 "location": "A String", # Geographic location of the event as free-form text. Optional. 479 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 480 "gadget": { # A gadget that extends this event. 481 "preferences": { # Preferences. 482 "a_key": "A String", # The preference name and corresponding value. 483 }, 484 "title": "A String", # The gadget's title. 485 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 486 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 487 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 488 "type": "A String", # The gadget's type. 489 "display": "A String", # The gadget's display mode. Optional. Possible values are: 490 # - "icon" - The gadget displays next to the event's title in the calendar view. 491 # - "chip" - The gadget displays when the event is clicked. 492 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 493 }, 494 "status": "A String", # Status of the event. Optional. Possible values are: 495 # - "confirmed" - The event is confirmed. This is the default status. 496 # - "tentative" - The event is tentatively confirmed. 497 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 498 # A cancelled status represents two different states depending on the event type: 499 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 500 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 501 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 502 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 503 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 504 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 505 "description": "A String", # Description of the event. Optional. 506 "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. 507 # 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. 508 "extendedProperties": { # Extended properties of the event. 509 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 510 "a_key": "A String", # The name of the shared property and the corresponding value. 511 }, 512 "private": { # Properties that are private to the copy of the event that appears on this calendar. 513 "a_key": "A String", # The name of the private property and the corresponding value. 514 }, 515 }, 516 "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. 517 "sequence": 42, # Sequence number as per iCalendar. 518 "visibility": "default", # Visibility of the event. Optional. Possible values are: 519 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 520 # - "public" - The event is public and event details are visible to all readers of the calendar. 521 # - "private" - The event is private and only event attendees may view event details. 522 # - "confidential" - The event is private. This value is provided for compatibility reasons. 523 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 524 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 525 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 526 "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. 527 "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. 528 }, 529 "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. 530 "kind": "calendar#event", # Type of the resource ("calendar#event"). 531 "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. 532 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 533 "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. 534 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 535 "reminders": { # Information about the event's reminders for the authenticated user. 536 "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. 537 { 538 "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). 539 # Required when adding a reminder. 540 "method": "A String", # The method used by this reminder. Possible values are: 541 # - "email" - Reminders are sent via email. 542 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 543 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 544 # - "popup" - Reminders are sent via a UI popup. 545 # Required when adding a reminder. 546 }, 547 ], 548 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 549 }, 550 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 551 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 552 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 553 "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. 554 "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. 555 }, 556 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 557 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 558 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 559 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 560 "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. 561 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 562 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 563 # All of them must belong to the same conference. 564 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 565 { 566 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 567 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 568 # Optional. 569 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 570 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 571 # Optional. 572 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 573 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 574 # Optional. 575 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 576 # Format: 577 # - for video, http: or https: schema is required. 578 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 579 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 580 # - for more, http: or https: schema is required. 581 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 582 "A String", 583 ], 584 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 585 # Examples: 586 # - for video: meet.google.com/aaa-bbbb-ccc 587 # - for phone: +1 123 268 2601 588 # - for sip: 12345678@altostrat.com 589 # - for more: should not be filled 590 # Optional. 591 "entryPointType": "A String", # The type of the conference entry point. 592 # Possible values are: 593 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 594 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 595 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 596 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 597 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 598 # Calendar backend will populate this field only for EntryPointType.PHONE. 599 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 600 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 601 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 602 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 603 # Optional. 604 }, 605 ], 606 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 607 "addOnParameters": { # Additional add-on specific data. 608 "parameters": { 609 "a_key": "A String", 610 }, 611 }, 612 }, 613 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 614 "conferenceId": "A String", # The ID of the conference. 615 # Can be used by developers to keep track of conferences, should not be displayed to users. 616 # Values for solution types: 617 # - "eventHangout": unset. 618 # - "eventNamedHangout": the name of the Hangout. 619 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 620 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 621 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 622 "status": { # The status of the conference create request. 623 "statusCode": "A String", # The current status of the conference create request. Read-only. 624 # The possible values are: 625 # - "pending": the conference create request is still being processed. 626 # - "success": the conference create request succeeded, the entry points are populated. 627 # - "failure": the conference create request failed, there are no entry points. 628 }, 629 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 630 "type": "A String", # The conference solution type. 631 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 632 # The possible values are: 633 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 634 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 635 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 636 }, 637 "requestId": "A String", # The client-generated unique ID for this request. 638 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 639 }, 640 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 641 # Unset for a conference with a failed create request. 642 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 643 "iconUri": "A String", # The user-visible icon for this solution. 644 "name": "A String", # The user-visible name of this solution. Not localized. 645 "key": { # The key which can uniquely identify the conference solution for this event. 646 "type": "A String", # The conference solution type. 647 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 648 # The possible values are: 649 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 650 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 651 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 652 }, 653 }, 654 "signature": "A String", # The signature of the conference data. 655 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 656 # Unset for a conference with a failed create request. 657 # Optional for a conference with a pending create request. 658 }, 659 } 660 661 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. 662 conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. 663 664Returns: 665 An object of the form: 666 667 { 668 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 669 # In order to modify attachments the supportsAttachments request parameter should be set to true. 670 # There can be at most 25 attachments per event, 671 { 672 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 673 "title": "A String", # Attachment title. 674 "fileUrl": "A String", # URL link to the attachment. 675 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 676 # Required when adding an attachment. 677 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 678 "fileId": "A String", # ID of the attached file. Read-only. 679 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 680 }, 681 ], 682 "creator": { # The creator of the event. Read-only. 683 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 684 "displayName": "A String", # The creator's name, if available. 685 "email": "A String", # The creator's email address, if available. 686 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 687 }, 688 "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. 689 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 690 "displayName": "A String", # The organizer's name, if available. 691 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 692 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 693 }, 694 "summary": "A String", # Title of the event. 695 "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: 696 # - 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 697 # - the length of the ID must be between 5 and 1024 characters 698 # - 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. 699 # If you do not specify an ID, it will be automatically generated by the server. 700 # 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. 701 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 702 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 703 { 704 "comment": "A String", # The attendee's response comment. Optional. 705 "displayName": "A String", # The attendee's name, if available. Optional. 706 "responseStatus": "A String", # The attendee's response status. Possible values are: 707 # - "needsAction" - The attendee has not responded to the invitation. 708 # - "declined" - The attendee has declined the invitation. 709 # - "tentative" - The attendee has tentatively accepted the invitation. 710 # - "accepted" - The attendee has accepted the invitation. 711 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 712 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 713 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 714 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 715 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 716 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 717 "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. 718 # Required when adding an attendee. 719 }, 720 ], 721 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 722 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 723 "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. 724 "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. 725 }, 726 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 727 "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. 728 "A String", 729 ], 730 "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. 731 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 732 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 733 }, 734 "etag": "A String", # ETag of the resource. 735 "location": "A String", # Geographic location of the event as free-form text. Optional. 736 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 737 "gadget": { # A gadget that extends this event. 738 "preferences": { # Preferences. 739 "a_key": "A String", # The preference name and corresponding value. 740 }, 741 "title": "A String", # The gadget's title. 742 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 743 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 744 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 745 "type": "A String", # The gadget's type. 746 "display": "A String", # The gadget's display mode. Optional. Possible values are: 747 # - "icon" - The gadget displays next to the event's title in the calendar view. 748 # - "chip" - The gadget displays when the event is clicked. 749 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 750 }, 751 "status": "A String", # Status of the event. Optional. Possible values are: 752 # - "confirmed" - The event is confirmed. This is the default status. 753 # - "tentative" - The event is tentatively confirmed. 754 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 755 # A cancelled status represents two different states depending on the event type: 756 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 757 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 758 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 759 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 760 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 761 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 762 "description": "A String", # Description of the event. Optional. 763 "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. 764 # 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. 765 "extendedProperties": { # Extended properties of the event. 766 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 767 "a_key": "A String", # The name of the shared property and the corresponding value. 768 }, 769 "private": { # Properties that are private to the copy of the event that appears on this calendar. 770 "a_key": "A String", # The name of the private property and the corresponding value. 771 }, 772 }, 773 "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. 774 "sequence": 42, # Sequence number as per iCalendar. 775 "visibility": "default", # Visibility of the event. Optional. Possible values are: 776 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 777 # - "public" - The event is public and event details are visible to all readers of the calendar. 778 # - "private" - The event is private and only event attendees may view event details. 779 # - "confidential" - The event is private. This value is provided for compatibility reasons. 780 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 781 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 782 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 783 "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. 784 "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. 785 }, 786 "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. 787 "kind": "calendar#event", # Type of the resource ("calendar#event"). 788 "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. 789 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 790 "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. 791 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 792 "reminders": { # Information about the event's reminders for the authenticated user. 793 "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. 794 { 795 "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). 796 # Required when adding a reminder. 797 "method": "A String", # The method used by this reminder. Possible values are: 798 # - "email" - Reminders are sent via email. 799 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 800 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 801 # - "popup" - Reminders are sent via a UI popup. 802 # Required when adding a reminder. 803 }, 804 ], 805 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 806 }, 807 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 808 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 809 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 810 "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. 811 "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. 812 }, 813 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 814 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 815 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 816 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 817 "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. 818 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 819 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 820 # All of them must belong to the same conference. 821 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 822 { 823 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 824 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 825 # Optional. 826 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 827 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 828 # Optional. 829 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 830 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 831 # Optional. 832 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 833 # Format: 834 # - for video, http: or https: schema is required. 835 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 836 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 837 # - for more, http: or https: schema is required. 838 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 839 "A String", 840 ], 841 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 842 # Examples: 843 # - for video: meet.google.com/aaa-bbbb-ccc 844 # - for phone: +1 123 268 2601 845 # - for sip: 12345678@altostrat.com 846 # - for more: should not be filled 847 # Optional. 848 "entryPointType": "A String", # The type of the conference entry point. 849 # Possible values are: 850 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 851 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 852 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 853 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 854 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 855 # Calendar backend will populate this field only for EntryPointType.PHONE. 856 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 857 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 858 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 859 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 860 # Optional. 861 }, 862 ], 863 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 864 "addOnParameters": { # Additional add-on specific data. 865 "parameters": { 866 "a_key": "A String", 867 }, 868 }, 869 }, 870 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 871 "conferenceId": "A String", # The ID of the conference. 872 # Can be used by developers to keep track of conferences, should not be displayed to users. 873 # Values for solution types: 874 # - "eventHangout": unset. 875 # - "eventNamedHangout": the name of the Hangout. 876 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 877 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 878 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 879 "status": { # The status of the conference create request. 880 "statusCode": "A String", # The current status of the conference create request. Read-only. 881 # The possible values are: 882 # - "pending": the conference create request is still being processed. 883 # - "success": the conference create request succeeded, the entry points are populated. 884 # - "failure": the conference create request failed, there are no entry points. 885 }, 886 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 887 "type": "A String", # The conference solution type. 888 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 889 # The possible values are: 890 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 891 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 892 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 893 }, 894 "requestId": "A String", # The client-generated unique ID for this request. 895 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 896 }, 897 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 898 # Unset for a conference with a failed create request. 899 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 900 "iconUri": "A String", # The user-visible icon for this solution. 901 "name": "A String", # The user-visible name of this solution. Not localized. 902 "key": { # The key which can uniquely identify the conference solution for this event. 903 "type": "A String", # The conference solution type. 904 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 905 # The possible values are: 906 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 907 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 908 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 909 }, 910 }, 911 "signature": "A String", # The signature of the conference data. 912 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 913 # Unset for a conference with a failed create request. 914 # Optional for a conference with a pending create request. 915 }, 916 }</pre> 917</div> 918 919<div class="method"> 920 <code class="details" id="insert">insert(calendarId, body, sendNotifications=None, supportsAttachments=None, sendUpdates=None, conferenceDataVersion=None, maxAttendees=None)</code> 921 <pre>Creates an event. 922 923Args: 924 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) 925 body: object, The request body. (required) 926 The object takes the form of: 927 928{ 929 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 930 # In order to modify attachments the supportsAttachments request parameter should be set to true. 931 # There can be at most 25 attachments per event, 932 { 933 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 934 "title": "A String", # Attachment title. 935 "fileUrl": "A String", # URL link to the attachment. 936 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 937 # Required when adding an attachment. 938 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 939 "fileId": "A String", # ID of the attached file. Read-only. 940 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 941 }, 942 ], 943 "creator": { # The creator of the event. Read-only. 944 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 945 "displayName": "A String", # The creator's name, if available. 946 "email": "A String", # The creator's email address, if available. 947 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 948 }, 949 "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. 950 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 951 "displayName": "A String", # The organizer's name, if available. 952 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 953 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 954 }, 955 "summary": "A String", # Title of the event. 956 "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: 957 # - 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 958 # - the length of the ID must be between 5 and 1024 characters 959 # - 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. 960 # If you do not specify an ID, it will be automatically generated by the server. 961 # 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. 962 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 963 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 964 { 965 "comment": "A String", # The attendee's response comment. Optional. 966 "displayName": "A String", # The attendee's name, if available. Optional. 967 "responseStatus": "A String", # The attendee's response status. Possible values are: 968 # - "needsAction" - The attendee has not responded to the invitation. 969 # - "declined" - The attendee has declined the invitation. 970 # - "tentative" - The attendee has tentatively accepted the invitation. 971 # - "accepted" - The attendee has accepted the invitation. 972 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 973 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 974 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 975 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 976 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 977 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 978 "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. 979 # Required when adding an attendee. 980 }, 981 ], 982 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 983 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 984 "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. 985 "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. 986 }, 987 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 988 "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. 989 "A String", 990 ], 991 "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. 992 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 993 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 994 }, 995 "etag": "A String", # ETag of the resource. 996 "location": "A String", # Geographic location of the event as free-form text. Optional. 997 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 998 "gadget": { # A gadget that extends this event. 999 "preferences": { # Preferences. 1000 "a_key": "A String", # The preference name and corresponding value. 1001 }, 1002 "title": "A String", # The gadget's title. 1003 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 1004 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 1005 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 1006 "type": "A String", # The gadget's type. 1007 "display": "A String", # The gadget's display mode. Optional. Possible values are: 1008 # - "icon" - The gadget displays next to the event's title in the calendar view. 1009 # - "chip" - The gadget displays when the event is clicked. 1010 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 1011 }, 1012 "status": "A String", # Status of the event. Optional. Possible values are: 1013 # - "confirmed" - The event is confirmed. This is the default status. 1014 # - "tentative" - The event is tentatively confirmed. 1015 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 1016 # A cancelled status represents two different states depending on the event type: 1017 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 1018 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 1019 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 1020 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 1021 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 1022 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 1023 "description": "A String", # Description of the event. Optional. 1024 "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. 1025 # 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. 1026 "extendedProperties": { # Extended properties of the event. 1027 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 1028 "a_key": "A String", # The name of the shared property and the corresponding value. 1029 }, 1030 "private": { # Properties that are private to the copy of the event that appears on this calendar. 1031 "a_key": "A String", # The name of the private property and the corresponding value. 1032 }, 1033 }, 1034 "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. 1035 "sequence": 42, # Sequence number as per iCalendar. 1036 "visibility": "default", # Visibility of the event. Optional. Possible values are: 1037 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 1038 # - "public" - The event is public and event details are visible to all readers of the calendar. 1039 # - "private" - The event is private and only event attendees may view event details. 1040 # - "confidential" - The event is private. This value is provided for compatibility reasons. 1041 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 1042 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 1043 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1044 "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. 1045 "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. 1046 }, 1047 "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. 1048 "kind": "calendar#event", # Type of the resource ("calendar#event"). 1049 "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. 1050 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 1051 "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. 1052 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 1053 "reminders": { # Information about the event's reminders for the authenticated user. 1054 "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. 1055 { 1056 "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). 1057 # Required when adding a reminder. 1058 "method": "A String", # The method used by this reminder. Possible values are: 1059 # - "email" - Reminders are sent via email. 1060 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 1061 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1062 # - "popup" - Reminders are sent via a UI popup. 1063 # Required when adding a reminder. 1064 }, 1065 ], 1066 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 1067 }, 1068 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 1069 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 1070 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1071 "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. 1072 "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. 1073 }, 1074 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 1075 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 1076 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 1077 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 1078 "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. 1079 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 1080 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 1081 # All of them must belong to the same conference. 1082 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 1083 { 1084 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 1085 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1086 # Optional. 1087 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 1088 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1089 # Optional. 1090 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 1091 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1092 # Optional. 1093 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 1094 # Format: 1095 # - for video, http: or https: schema is required. 1096 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 1097 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 1098 # - for more, http: or https: schema is required. 1099 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 1100 "A String", 1101 ], 1102 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 1103 # Examples: 1104 # - for video: meet.google.com/aaa-bbbb-ccc 1105 # - for phone: +1 123 268 2601 1106 # - for sip: 12345678@altostrat.com 1107 # - for more: should not be filled 1108 # Optional. 1109 "entryPointType": "A String", # The type of the conference entry point. 1110 # Possible values are: 1111 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 1112 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 1113 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 1114 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 1115 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 1116 # Calendar backend will populate this field only for EntryPointType.PHONE. 1117 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 1118 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1119 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 1120 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1121 # Optional. 1122 }, 1123 ], 1124 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 1125 "addOnParameters": { # Additional add-on specific data. 1126 "parameters": { 1127 "a_key": "A String", 1128 }, 1129 }, 1130 }, 1131 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 1132 "conferenceId": "A String", # The ID of the conference. 1133 # Can be used by developers to keep track of conferences, should not be displayed to users. 1134 # Values for solution types: 1135 # - "eventHangout": unset. 1136 # - "eventNamedHangout": the name of the Hangout. 1137 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 1138 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 1139 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 1140 "status": { # The status of the conference create request. 1141 "statusCode": "A String", # The current status of the conference create request. Read-only. 1142 # The possible values are: 1143 # - "pending": the conference create request is still being processed. 1144 # - "success": the conference create request succeeded, the entry points are populated. 1145 # - "failure": the conference create request failed, there are no entry points. 1146 }, 1147 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 1148 "type": "A String", # The conference solution type. 1149 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 1150 # The possible values are: 1151 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 1152 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 1153 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 1154 }, 1155 "requestId": "A String", # The client-generated unique ID for this request. 1156 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 1157 }, 1158 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 1159 # Unset for a conference with a failed create request. 1160 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 1161 "iconUri": "A String", # The user-visible icon for this solution. 1162 "name": "A String", # The user-visible name of this solution. Not localized. 1163 "key": { # The key which can uniquely identify the conference solution for this event. 1164 "type": "A String", # The conference solution type. 1165 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 1166 # The possible values are: 1167 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 1168 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 1169 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 1170 }, 1171 }, 1172 "signature": "A String", # The signature of the conference data. 1173 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 1174 # Unset for a conference with a failed create request. 1175 # Optional for a conference with a pending create request. 1176 }, 1177 } 1178 1179 sendNotifications: boolean, Deprecated. Please use sendUpdates instead. 1180 1181Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false. 1182 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. 1183 sendUpdates: string, Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. 1184 Allowed values 1185 all - Notifications are sent to all guests. 1186 externalOnly - Notifications are sent to non-Google Calendar guests only. 1187 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used). 1188 conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. 1189 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. 1190 1191Returns: 1192 An object of the form: 1193 1194 { 1195 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 1196 # In order to modify attachments the supportsAttachments request parameter should be set to true. 1197 # There can be at most 25 attachments per event, 1198 { 1199 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 1200 "title": "A String", # Attachment title. 1201 "fileUrl": "A String", # URL link to the attachment. 1202 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 1203 # Required when adding an attachment. 1204 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 1205 "fileId": "A String", # ID of the attached file. Read-only. 1206 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 1207 }, 1208 ], 1209 "creator": { # The creator of the event. Read-only. 1210 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1211 "displayName": "A String", # The creator's name, if available. 1212 "email": "A String", # The creator's email address, if available. 1213 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 1214 }, 1215 "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. 1216 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1217 "displayName": "A String", # The organizer's name, if available. 1218 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 1219 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 1220 }, 1221 "summary": "A String", # Title of the event. 1222 "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: 1223 # - 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 1224 # - the length of the ID must be between 5 and 1024 characters 1225 # - 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. 1226 # If you do not specify an ID, it will be automatically generated by the server. 1227 # 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. 1228 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 1229 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 1230 { 1231 "comment": "A String", # The attendee's response comment. Optional. 1232 "displayName": "A String", # The attendee's name, if available. Optional. 1233 "responseStatus": "A String", # The attendee's response status. Possible values are: 1234 # - "needsAction" - The attendee has not responded to the invitation. 1235 # - "declined" - The attendee has declined the invitation. 1236 # - "tentative" - The attendee has tentatively accepted the invitation. 1237 # - "accepted" - The attendee has accepted the invitation. 1238 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 1239 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 1240 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 1241 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 1242 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 1243 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 1244 "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. 1245 # Required when adding an attendee. 1246 }, 1247 ], 1248 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 1249 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1250 "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. 1251 "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. 1252 }, 1253 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 1254 "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. 1255 "A String", 1256 ], 1257 "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. 1258 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 1259 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 1260 }, 1261 "etag": "A String", # ETag of the resource. 1262 "location": "A String", # Geographic location of the event as free-form text. Optional. 1263 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 1264 "gadget": { # A gadget that extends this event. 1265 "preferences": { # Preferences. 1266 "a_key": "A String", # The preference name and corresponding value. 1267 }, 1268 "title": "A String", # The gadget's title. 1269 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 1270 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 1271 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 1272 "type": "A String", # The gadget's type. 1273 "display": "A String", # The gadget's display mode. Optional. Possible values are: 1274 # - "icon" - The gadget displays next to the event's title in the calendar view. 1275 # - "chip" - The gadget displays when the event is clicked. 1276 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 1277 }, 1278 "status": "A String", # Status of the event. Optional. Possible values are: 1279 # - "confirmed" - The event is confirmed. This is the default status. 1280 # - "tentative" - The event is tentatively confirmed. 1281 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 1282 # A cancelled status represents two different states depending on the event type: 1283 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 1284 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 1285 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 1286 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 1287 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 1288 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 1289 "description": "A String", # Description of the event. Optional. 1290 "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. 1291 # 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. 1292 "extendedProperties": { # Extended properties of the event. 1293 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 1294 "a_key": "A String", # The name of the shared property and the corresponding value. 1295 }, 1296 "private": { # Properties that are private to the copy of the event that appears on this calendar. 1297 "a_key": "A String", # The name of the private property and the corresponding value. 1298 }, 1299 }, 1300 "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. 1301 "sequence": 42, # Sequence number as per iCalendar. 1302 "visibility": "default", # Visibility of the event. Optional. Possible values are: 1303 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 1304 # - "public" - The event is public and event details are visible to all readers of the calendar. 1305 # - "private" - The event is private and only event attendees may view event details. 1306 # - "confidential" - The event is private. This value is provided for compatibility reasons. 1307 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 1308 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 1309 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1310 "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. 1311 "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. 1312 }, 1313 "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. 1314 "kind": "calendar#event", # Type of the resource ("calendar#event"). 1315 "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. 1316 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 1317 "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. 1318 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 1319 "reminders": { # Information about the event's reminders for the authenticated user. 1320 "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. 1321 { 1322 "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). 1323 # Required when adding a reminder. 1324 "method": "A String", # The method used by this reminder. Possible values are: 1325 # - "email" - Reminders are sent via email. 1326 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 1327 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1328 # - "popup" - Reminders are sent via a UI popup. 1329 # Required when adding a reminder. 1330 }, 1331 ], 1332 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 1333 }, 1334 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 1335 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 1336 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1337 "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. 1338 "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. 1339 }, 1340 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 1341 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 1342 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 1343 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 1344 "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. 1345 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 1346 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 1347 # All of them must belong to the same conference. 1348 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 1349 { 1350 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 1351 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1352 # Optional. 1353 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 1354 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1355 # Optional. 1356 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 1357 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1358 # Optional. 1359 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 1360 # Format: 1361 # - for video, http: or https: schema is required. 1362 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 1363 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 1364 # - for more, http: or https: schema is required. 1365 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 1366 "A String", 1367 ], 1368 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 1369 # Examples: 1370 # - for video: meet.google.com/aaa-bbbb-ccc 1371 # - for phone: +1 123 268 2601 1372 # - for sip: 12345678@altostrat.com 1373 # - for more: should not be filled 1374 # Optional. 1375 "entryPointType": "A String", # The type of the conference entry point. 1376 # Possible values are: 1377 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 1378 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 1379 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 1380 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 1381 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 1382 # Calendar backend will populate this field only for EntryPointType.PHONE. 1383 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 1384 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1385 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 1386 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1387 # Optional. 1388 }, 1389 ], 1390 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 1391 "addOnParameters": { # Additional add-on specific data. 1392 "parameters": { 1393 "a_key": "A String", 1394 }, 1395 }, 1396 }, 1397 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 1398 "conferenceId": "A String", # The ID of the conference. 1399 # Can be used by developers to keep track of conferences, should not be displayed to users. 1400 # Values for solution types: 1401 # - "eventHangout": unset. 1402 # - "eventNamedHangout": the name of the Hangout. 1403 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 1404 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 1405 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 1406 "status": { # The status of the conference create request. 1407 "statusCode": "A String", # The current status of the conference create request. Read-only. 1408 # The possible values are: 1409 # - "pending": the conference create request is still being processed. 1410 # - "success": the conference create request succeeded, the entry points are populated. 1411 # - "failure": the conference create request failed, there are no entry points. 1412 }, 1413 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 1414 "type": "A String", # The conference solution type. 1415 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 1416 # The possible values are: 1417 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 1418 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 1419 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 1420 }, 1421 "requestId": "A String", # The client-generated unique ID for this request. 1422 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 1423 }, 1424 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 1425 # Unset for a conference with a failed create request. 1426 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 1427 "iconUri": "A String", # The user-visible icon for this solution. 1428 "name": "A String", # The user-visible name of this solution. Not localized. 1429 "key": { # The key which can uniquely identify the conference solution for this event. 1430 "type": "A String", # The conference solution type. 1431 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 1432 # The possible values are: 1433 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 1434 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 1435 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 1436 }, 1437 }, 1438 "signature": "A String", # The signature of the conference data. 1439 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 1440 # Unset for a conference with a failed create request. 1441 # Optional for a conference with a pending create request. 1442 }, 1443 }</pre> 1444</div> 1445 1446<div class="method"> 1447 <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> 1448 <pre>Returns instances of the specified recurring event. 1449 1450Args: 1451 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) 1452 eventId: string, Recurring event identifier. (required) 1453 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. 1454 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. 1455 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. 1456 pageToken: string, Token specifying which result page to return. Optional. 1457 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. 1458 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. 1459 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. 1460 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. 1461 originalStart: string, The original start time of the instance in the result. Optional. 1462 1463Returns: 1464 An object of the form: 1465 1466 { 1467 "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. 1468 "kind": "calendar#events", # Type of the collection ("calendar#events"). 1469 "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). 1470 { 1471 "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). 1472 # Required when adding a reminder. 1473 "method": "A String", # The method used by this reminder. Possible values are: 1474 # - "email" - Reminders are sent via email. 1475 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 1476 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1477 # - "popup" - Reminders are sent via a UI popup. 1478 # Required when adding a reminder. 1479 }, 1480 ], 1481 "description": "A String", # Description of the calendar. Read-only. 1482 "items": [ # List of events on the calendar. 1483 { 1484 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 1485 # In order to modify attachments the supportsAttachments request parameter should be set to true. 1486 # There can be at most 25 attachments per event, 1487 { 1488 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 1489 "title": "A String", # Attachment title. 1490 "fileUrl": "A String", # URL link to the attachment. 1491 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 1492 # Required when adding an attachment. 1493 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 1494 "fileId": "A String", # ID of the attached file. Read-only. 1495 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 1496 }, 1497 ], 1498 "creator": { # The creator of the event. Read-only. 1499 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1500 "displayName": "A String", # The creator's name, if available. 1501 "email": "A String", # The creator's email address, if available. 1502 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 1503 }, 1504 "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. 1505 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1506 "displayName": "A String", # The organizer's name, if available. 1507 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 1508 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 1509 }, 1510 "summary": "A String", # Title of the event. 1511 "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: 1512 # - 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 1513 # - the length of the ID must be between 5 and 1024 characters 1514 # - 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. 1515 # If you do not specify an ID, it will be automatically generated by the server. 1516 # 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. 1517 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 1518 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 1519 { 1520 "comment": "A String", # The attendee's response comment. Optional. 1521 "displayName": "A String", # The attendee's name, if available. Optional. 1522 "responseStatus": "A String", # The attendee's response status. Possible values are: 1523 # - "needsAction" - The attendee has not responded to the invitation. 1524 # - "declined" - The attendee has declined the invitation. 1525 # - "tentative" - The attendee has tentatively accepted the invitation. 1526 # - "accepted" - The attendee has accepted the invitation. 1527 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 1528 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 1529 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 1530 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 1531 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 1532 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 1533 "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. 1534 # Required when adding an attendee. 1535 }, 1536 ], 1537 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 1538 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1539 "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. 1540 "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. 1541 }, 1542 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 1543 "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. 1544 "A String", 1545 ], 1546 "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. 1547 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 1548 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 1549 }, 1550 "etag": "A String", # ETag of the resource. 1551 "location": "A String", # Geographic location of the event as free-form text. Optional. 1552 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 1553 "gadget": { # A gadget that extends this event. 1554 "preferences": { # Preferences. 1555 "a_key": "A String", # The preference name and corresponding value. 1556 }, 1557 "title": "A String", # The gadget's title. 1558 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 1559 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 1560 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 1561 "type": "A String", # The gadget's type. 1562 "display": "A String", # The gadget's display mode. Optional. Possible values are: 1563 # - "icon" - The gadget displays next to the event's title in the calendar view. 1564 # - "chip" - The gadget displays when the event is clicked. 1565 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 1566 }, 1567 "status": "A String", # Status of the event. Optional. Possible values are: 1568 # - "confirmed" - The event is confirmed. This is the default status. 1569 # - "tentative" - The event is tentatively confirmed. 1570 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 1571 # A cancelled status represents two different states depending on the event type: 1572 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 1573 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 1574 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 1575 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 1576 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 1577 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 1578 "description": "A String", # Description of the event. Optional. 1579 "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. 1580 # 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. 1581 "extendedProperties": { # Extended properties of the event. 1582 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 1583 "a_key": "A String", # The name of the shared property and the corresponding value. 1584 }, 1585 "private": { # Properties that are private to the copy of the event that appears on this calendar. 1586 "a_key": "A String", # The name of the private property and the corresponding value. 1587 }, 1588 }, 1589 "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. 1590 "sequence": 42, # Sequence number as per iCalendar. 1591 "visibility": "default", # Visibility of the event. Optional. Possible values are: 1592 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 1593 # - "public" - The event is public and event details are visible to all readers of the calendar. 1594 # - "private" - The event is private and only event attendees may view event details. 1595 # - "confidential" - The event is private. This value is provided for compatibility reasons. 1596 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 1597 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 1598 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1599 "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. 1600 "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. 1601 }, 1602 "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. 1603 "kind": "calendar#event", # Type of the resource ("calendar#event"). 1604 "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. 1605 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 1606 "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. 1607 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 1608 "reminders": { # Information about the event's reminders for the authenticated user. 1609 "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. 1610 { 1611 "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). 1612 # Required when adding a reminder. 1613 "method": "A String", # The method used by this reminder. Possible values are: 1614 # - "email" - Reminders are sent via email. 1615 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 1616 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1617 # - "popup" - Reminders are sent via a UI popup. 1618 # Required when adding a reminder. 1619 }, 1620 ], 1621 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 1622 }, 1623 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 1624 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 1625 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1626 "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. 1627 "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. 1628 }, 1629 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 1630 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 1631 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 1632 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 1633 "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. 1634 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 1635 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 1636 # All of them must belong to the same conference. 1637 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 1638 { 1639 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 1640 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1641 # Optional. 1642 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 1643 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1644 # Optional. 1645 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 1646 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1647 # Optional. 1648 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 1649 # Format: 1650 # - for video, http: or https: schema is required. 1651 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 1652 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 1653 # - for more, http: or https: schema is required. 1654 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 1655 "A String", 1656 ], 1657 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 1658 # Examples: 1659 # - for video: meet.google.com/aaa-bbbb-ccc 1660 # - for phone: +1 123 268 2601 1661 # - for sip: 12345678@altostrat.com 1662 # - for more: should not be filled 1663 # Optional. 1664 "entryPointType": "A String", # The type of the conference entry point. 1665 # Possible values are: 1666 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 1667 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 1668 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 1669 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 1670 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 1671 # Calendar backend will populate this field only for EntryPointType.PHONE. 1672 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 1673 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1674 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 1675 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1676 # Optional. 1677 }, 1678 ], 1679 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 1680 "addOnParameters": { # Additional add-on specific data. 1681 "parameters": { 1682 "a_key": "A String", 1683 }, 1684 }, 1685 }, 1686 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 1687 "conferenceId": "A String", # The ID of the conference. 1688 # Can be used by developers to keep track of conferences, should not be displayed to users. 1689 # Values for solution types: 1690 # - "eventHangout": unset. 1691 # - "eventNamedHangout": the name of the Hangout. 1692 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 1693 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 1694 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 1695 "status": { # The status of the conference create request. 1696 "statusCode": "A String", # The current status of the conference create request. Read-only. 1697 # The possible values are: 1698 # - "pending": the conference create request is still being processed. 1699 # - "success": the conference create request succeeded, the entry points are populated. 1700 # - "failure": the conference create request failed, there are no entry points. 1701 }, 1702 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 1703 "type": "A String", # The conference solution type. 1704 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 1705 # The possible values are: 1706 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 1707 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 1708 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 1709 }, 1710 "requestId": "A String", # The client-generated unique ID for this request. 1711 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 1712 }, 1713 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 1714 # Unset for a conference with a failed create request. 1715 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 1716 "iconUri": "A String", # The user-visible icon for this solution. 1717 "name": "A String", # The user-visible name of this solution. Not localized. 1718 "key": { # The key which can uniquely identify the conference solution for this event. 1719 "type": "A String", # The conference solution type. 1720 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 1721 # The possible values are: 1722 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 1723 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 1724 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 1725 }, 1726 }, 1727 "signature": "A String", # The signature of the conference data. 1728 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 1729 # Unset for a conference with a failed create request. 1730 # Optional for a conference with a pending create request. 1731 }, 1732 }, 1733 ], 1734 "updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only. 1735 "summary": "A String", # Title of the calendar. Read-only. 1736 "etag": "A String", # ETag of the collection. 1737 "timeZone": "A String", # The time zone of the calendar. Read-only. 1738 "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. 1739 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are: 1740 # - "none" - The user has no access. 1741 # - "freeBusyReader" - The user has read access to free/busy information. 1742 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 1743 # - "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. 1744 # - "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. 1745 }</pre> 1746</div> 1747 1748<div class="method"> 1749 <code class="details" id="instances_next">instances_next(previous_request, previous_response)</code> 1750 <pre>Retrieves the next page of results. 1751 1752Args: 1753 previous_request: The request for the previous page. (required) 1754 previous_response: The response from the request for the previous page. (required) 1755 1756Returns: 1757 A request object that you can call 'execute()' on to request the next 1758 page. Returns None if there are no more items in the collection. 1759 </pre> 1760</div> 1761 1762<div class="method"> 1763 <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> 1764 <pre>Returns events on the specified calendar. 1765 1766Args: 1767 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) 1768 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order. 1769 Allowed values 1770 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True) 1771 updated - Order by last modification time (ascending). 1772 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False. 1773 timeMin: string, Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. 1774 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) 1775 pageToken: string, Token specifying which result page to return. Optional. 1776 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. 1777 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. 1778 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. 1779 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. 1780 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) 1781 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. 1782 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. 1783There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. 1784 1785These are: 1786- iCalUID 1787- orderBy 1788- privateExtendedProperty 1789- q 1790- sharedExtendedProperty 1791- timeMin 1792- timeMax 1793- 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. 1794Learn more about incremental synchronization. 1795Optional. The default is to return all entries. 1796 iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional. 1797 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. 1798 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. 1799 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional. 1800 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. 1801 1802Returns: 1803 An object of the form: 1804 1805 { 1806 "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. 1807 "kind": "calendar#events", # Type of the collection ("calendar#events"). 1808 "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). 1809 { 1810 "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). 1811 # Required when adding a reminder. 1812 "method": "A String", # The method used by this reminder. Possible values are: 1813 # - "email" - Reminders are sent via email. 1814 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 1815 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1816 # - "popup" - Reminders are sent via a UI popup. 1817 # Required when adding a reminder. 1818 }, 1819 ], 1820 "description": "A String", # Description of the calendar. Read-only. 1821 "items": [ # List of events on the calendar. 1822 { 1823 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 1824 # In order to modify attachments the supportsAttachments request parameter should be set to true. 1825 # There can be at most 25 attachments per event, 1826 { 1827 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 1828 "title": "A String", # Attachment title. 1829 "fileUrl": "A String", # URL link to the attachment. 1830 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 1831 # Required when adding an attachment. 1832 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 1833 "fileId": "A String", # ID of the attached file. Read-only. 1834 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 1835 }, 1836 ], 1837 "creator": { # The creator of the event. Read-only. 1838 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1839 "displayName": "A String", # The creator's name, if available. 1840 "email": "A String", # The creator's email address, if available. 1841 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 1842 }, 1843 "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. 1844 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 1845 "displayName": "A String", # The organizer's name, if available. 1846 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 1847 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 1848 }, 1849 "summary": "A String", # Title of the event. 1850 "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: 1851 # - 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 1852 # - the length of the ID must be between 5 and 1024 characters 1853 # - 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. 1854 # If you do not specify an ID, it will be automatically generated by the server. 1855 # 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. 1856 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 1857 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 1858 { 1859 "comment": "A String", # The attendee's response comment. Optional. 1860 "displayName": "A String", # The attendee's name, if available. Optional. 1861 "responseStatus": "A String", # The attendee's response status. Possible values are: 1862 # - "needsAction" - The attendee has not responded to the invitation. 1863 # - "declined" - The attendee has declined the invitation. 1864 # - "tentative" - The attendee has tentatively accepted the invitation. 1865 # - "accepted" - The attendee has accepted the invitation. 1866 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 1867 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 1868 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 1869 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 1870 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 1871 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 1872 "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. 1873 # Required when adding an attendee. 1874 }, 1875 ], 1876 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 1877 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1878 "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. 1879 "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. 1880 }, 1881 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 1882 "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. 1883 "A String", 1884 ], 1885 "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. 1886 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 1887 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 1888 }, 1889 "etag": "A String", # ETag of the resource. 1890 "location": "A String", # Geographic location of the event as free-form text. Optional. 1891 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 1892 "gadget": { # A gadget that extends this event. 1893 "preferences": { # Preferences. 1894 "a_key": "A String", # The preference name and corresponding value. 1895 }, 1896 "title": "A String", # The gadget's title. 1897 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 1898 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 1899 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 1900 "type": "A String", # The gadget's type. 1901 "display": "A String", # The gadget's display mode. Optional. Possible values are: 1902 # - "icon" - The gadget displays next to the event's title in the calendar view. 1903 # - "chip" - The gadget displays when the event is clicked. 1904 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 1905 }, 1906 "status": "A String", # Status of the event. Optional. Possible values are: 1907 # - "confirmed" - The event is confirmed. This is the default status. 1908 # - "tentative" - The event is tentatively confirmed. 1909 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 1910 # A cancelled status represents two different states depending on the event type: 1911 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 1912 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 1913 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 1914 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 1915 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 1916 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 1917 "description": "A String", # Description of the event. Optional. 1918 "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. 1919 # 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. 1920 "extendedProperties": { # Extended properties of the event. 1921 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 1922 "a_key": "A String", # The name of the shared property and the corresponding value. 1923 }, 1924 "private": { # Properties that are private to the copy of the event that appears on this calendar. 1925 "a_key": "A String", # The name of the private property and the corresponding value. 1926 }, 1927 }, 1928 "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. 1929 "sequence": 42, # Sequence number as per iCalendar. 1930 "visibility": "default", # Visibility of the event. Optional. Possible values are: 1931 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 1932 # - "public" - The event is public and event details are visible to all readers of the calendar. 1933 # - "private" - The event is private and only event attendees may view event details. 1934 # - "confidential" - The event is private. This value is provided for compatibility reasons. 1935 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 1936 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 1937 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1938 "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. 1939 "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. 1940 }, 1941 "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. 1942 "kind": "calendar#event", # Type of the resource ("calendar#event"). 1943 "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. 1944 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 1945 "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. 1946 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 1947 "reminders": { # Information about the event's reminders for the authenticated user. 1948 "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. 1949 { 1950 "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). 1951 # Required when adding a reminder. 1952 "method": "A String", # The method used by this reminder. Possible values are: 1953 # - "email" - Reminders are sent via email. 1954 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 1955 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 1956 # - "popup" - Reminders are sent via a UI popup. 1957 # Required when adding a reminder. 1958 }, 1959 ], 1960 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 1961 }, 1962 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 1963 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 1964 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 1965 "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. 1966 "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. 1967 }, 1968 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 1969 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 1970 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 1971 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 1972 "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. 1973 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 1974 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 1975 # All of them must belong to the same conference. 1976 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 1977 { 1978 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 1979 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1980 # Optional. 1981 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 1982 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1983 # Optional. 1984 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 1985 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 1986 # Optional. 1987 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 1988 # Format: 1989 # - for video, http: or https: schema is required. 1990 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 1991 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 1992 # - for more, http: or https: schema is required. 1993 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 1994 "A String", 1995 ], 1996 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 1997 # Examples: 1998 # - for video: meet.google.com/aaa-bbbb-ccc 1999 # - for phone: +1 123 268 2601 2000 # - for sip: 12345678@altostrat.com 2001 # - for more: should not be filled 2002 # Optional. 2003 "entryPointType": "A String", # The type of the conference entry point. 2004 # Possible values are: 2005 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 2006 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 2007 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 2008 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 2009 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 2010 # Calendar backend will populate this field only for EntryPointType.PHONE. 2011 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 2012 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2013 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 2014 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2015 # Optional. 2016 }, 2017 ], 2018 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 2019 "addOnParameters": { # Additional add-on specific data. 2020 "parameters": { 2021 "a_key": "A String", 2022 }, 2023 }, 2024 }, 2025 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 2026 "conferenceId": "A String", # The ID of the conference. 2027 # Can be used by developers to keep track of conferences, should not be displayed to users. 2028 # Values for solution types: 2029 # - "eventHangout": unset. 2030 # - "eventNamedHangout": the name of the Hangout. 2031 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 2032 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 2033 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2034 "status": { # The status of the conference create request. 2035 "statusCode": "A String", # The current status of the conference create request. Read-only. 2036 # The possible values are: 2037 # - "pending": the conference create request is still being processed. 2038 # - "success": the conference create request succeeded, the entry points are populated. 2039 # - "failure": the conference create request failed, there are no entry points. 2040 }, 2041 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 2042 "type": "A String", # The conference solution type. 2043 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 2044 # The possible values are: 2045 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 2046 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 2047 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 2048 }, 2049 "requestId": "A String", # The client-generated unique ID for this request. 2050 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 2051 }, 2052 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 2053 # Unset for a conference with a failed create request. 2054 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2055 "iconUri": "A String", # The user-visible icon for this solution. 2056 "name": "A String", # The user-visible name of this solution. Not localized. 2057 "key": { # The key which can uniquely identify the conference solution for this event. 2058 "type": "A String", # The conference solution type. 2059 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 2060 # The possible values are: 2061 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 2062 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 2063 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 2064 }, 2065 }, 2066 "signature": "A String", # The signature of the conference data. 2067 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 2068 # Unset for a conference with a failed create request. 2069 # Optional for a conference with a pending create request. 2070 }, 2071 }, 2072 ], 2073 "updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only. 2074 "summary": "A String", # Title of the calendar. Read-only. 2075 "etag": "A String", # ETag of the collection. 2076 "timeZone": "A String", # The time zone of the calendar. Read-only. 2077 "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. 2078 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are: 2079 # - "none" - The user has no access. 2080 # - "freeBusyReader" - The user has read access to free/busy information. 2081 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. 2082 # - "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. 2083 # - "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. 2084 }</pre> 2085</div> 2086 2087<div class="method"> 2088 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 2089 <pre>Retrieves the next page of results. 2090 2091Args: 2092 previous_request: The request for the previous page. (required) 2093 previous_response: The response from the request for the previous page. (required) 2094 2095Returns: 2096 A request object that you can call 'execute()' on to request the next 2097 page. Returns None if there are no more items in the collection. 2098 </pre> 2099</div> 2100 2101<div class="method"> 2102 <code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)</code> 2103 <pre>Moves an event to another calendar, i.e. changes an event's organizer. 2104 2105Args: 2106 calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required) 2107 eventId: string, Event identifier. (required) 2108 destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required) 2109 sendNotifications: boolean, Deprecated. Please use sendUpdates instead. 2110 2111Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false. 2112 sendUpdates: string, Guests who should receive notifications about the change of the event's organizer. 2113 Allowed values 2114 all - Notifications are sent to all guests. 2115 externalOnly - Notifications are sent to non-Google Calendar guests only. 2116 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used). 2117 2118Returns: 2119 An object of the form: 2120 2121 { 2122 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 2123 # In order to modify attachments the supportsAttachments request parameter should be set to true. 2124 # There can be at most 25 attachments per event, 2125 { 2126 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 2127 "title": "A String", # Attachment title. 2128 "fileUrl": "A String", # URL link to the attachment. 2129 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 2130 # Required when adding an attachment. 2131 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 2132 "fileId": "A String", # ID of the attached file. Read-only. 2133 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 2134 }, 2135 ], 2136 "creator": { # The creator of the event. Read-only. 2137 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 2138 "displayName": "A String", # The creator's name, if available. 2139 "email": "A String", # The creator's email address, if available. 2140 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2141 }, 2142 "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. 2143 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 2144 "displayName": "A String", # The organizer's name, if available. 2145 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 2146 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2147 }, 2148 "summary": "A String", # Title of the event. 2149 "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: 2150 # - 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 2151 # - the length of the ID must be between 5 and 1024 characters 2152 # - 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. 2153 # If you do not specify an ID, it will be automatically generated by the server. 2154 # 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. 2155 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 2156 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 2157 { 2158 "comment": "A String", # The attendee's response comment. Optional. 2159 "displayName": "A String", # The attendee's name, if available. Optional. 2160 "responseStatus": "A String", # The attendee's response status. Possible values are: 2161 # - "needsAction" - The attendee has not responded to the invitation. 2162 # - "declined" - The attendee has declined the invitation. 2163 # - "tentative" - The attendee has tentatively accepted the invitation. 2164 # - "accepted" - The attendee has accepted the invitation. 2165 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 2166 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2167 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 2168 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 2169 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 2170 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 2171 "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. 2172 # Required when adding an attendee. 2173 }, 2174 ], 2175 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 2176 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2177 "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. 2178 "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. 2179 }, 2180 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 2181 "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. 2182 "A String", 2183 ], 2184 "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. 2185 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 2186 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 2187 }, 2188 "etag": "A String", # ETag of the resource. 2189 "location": "A String", # Geographic location of the event as free-form text. Optional. 2190 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 2191 "gadget": { # A gadget that extends this event. 2192 "preferences": { # Preferences. 2193 "a_key": "A String", # The preference name and corresponding value. 2194 }, 2195 "title": "A String", # The gadget's title. 2196 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 2197 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 2198 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 2199 "type": "A String", # The gadget's type. 2200 "display": "A String", # The gadget's display mode. Optional. Possible values are: 2201 # - "icon" - The gadget displays next to the event's title in the calendar view. 2202 # - "chip" - The gadget displays when the event is clicked. 2203 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 2204 }, 2205 "status": "A String", # Status of the event. Optional. Possible values are: 2206 # - "confirmed" - The event is confirmed. This is the default status. 2207 # - "tentative" - The event is tentatively confirmed. 2208 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 2209 # A cancelled status represents two different states depending on the event type: 2210 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 2211 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 2212 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 2213 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 2214 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 2215 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 2216 "description": "A String", # Description of the event. Optional. 2217 "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. 2218 # 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. 2219 "extendedProperties": { # Extended properties of the event. 2220 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 2221 "a_key": "A String", # The name of the shared property and the corresponding value. 2222 }, 2223 "private": { # Properties that are private to the copy of the event that appears on this calendar. 2224 "a_key": "A String", # The name of the private property and the corresponding value. 2225 }, 2226 }, 2227 "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. 2228 "sequence": 42, # Sequence number as per iCalendar. 2229 "visibility": "default", # Visibility of the event. Optional. Possible values are: 2230 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 2231 # - "public" - The event is public and event details are visible to all readers of the calendar. 2232 # - "private" - The event is private and only event attendees may view event details. 2233 # - "confidential" - The event is private. This value is provided for compatibility reasons. 2234 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 2235 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 2236 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2237 "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. 2238 "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. 2239 }, 2240 "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. 2241 "kind": "calendar#event", # Type of the resource ("calendar#event"). 2242 "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. 2243 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 2244 "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. 2245 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 2246 "reminders": { # Information about the event's reminders for the authenticated user. 2247 "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. 2248 { 2249 "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). 2250 # Required when adding a reminder. 2251 "method": "A String", # The method used by this reminder. Possible values are: 2252 # - "email" - Reminders are sent via email. 2253 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 2254 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 2255 # - "popup" - Reminders are sent via a UI popup. 2256 # Required when adding a reminder. 2257 }, 2258 ], 2259 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 2260 }, 2261 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 2262 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 2263 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2264 "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. 2265 "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. 2266 }, 2267 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 2268 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 2269 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 2270 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 2271 "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. 2272 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 2273 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 2274 # All of them must belong to the same conference. 2275 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2276 { 2277 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 2278 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2279 # Optional. 2280 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 2281 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2282 # Optional. 2283 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 2284 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2285 # Optional. 2286 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 2287 # Format: 2288 # - for video, http: or https: schema is required. 2289 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 2290 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 2291 # - for more, http: or https: schema is required. 2292 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 2293 "A String", 2294 ], 2295 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 2296 # Examples: 2297 # - for video: meet.google.com/aaa-bbbb-ccc 2298 # - for phone: +1 123 268 2601 2299 # - for sip: 12345678@altostrat.com 2300 # - for more: should not be filled 2301 # Optional. 2302 "entryPointType": "A String", # The type of the conference entry point. 2303 # Possible values are: 2304 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 2305 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 2306 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 2307 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 2308 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 2309 # Calendar backend will populate this field only for EntryPointType.PHONE. 2310 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 2311 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2312 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 2313 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2314 # Optional. 2315 }, 2316 ], 2317 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 2318 "addOnParameters": { # Additional add-on specific data. 2319 "parameters": { 2320 "a_key": "A String", 2321 }, 2322 }, 2323 }, 2324 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 2325 "conferenceId": "A String", # The ID of the conference. 2326 # Can be used by developers to keep track of conferences, should not be displayed to users. 2327 # Values for solution types: 2328 # - "eventHangout": unset. 2329 # - "eventNamedHangout": the name of the Hangout. 2330 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 2331 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 2332 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2333 "status": { # The status of the conference create request. 2334 "statusCode": "A String", # The current status of the conference create request. Read-only. 2335 # The possible values are: 2336 # - "pending": the conference create request is still being processed. 2337 # - "success": the conference create request succeeded, the entry points are populated. 2338 # - "failure": the conference create request failed, there are no entry points. 2339 }, 2340 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 2341 "type": "A String", # The conference solution type. 2342 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 2343 # The possible values are: 2344 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 2345 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 2346 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 2347 }, 2348 "requestId": "A String", # The client-generated unique ID for this request. 2349 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 2350 }, 2351 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 2352 # Unset for a conference with a failed create request. 2353 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2354 "iconUri": "A String", # The user-visible icon for this solution. 2355 "name": "A String", # The user-visible name of this solution. Not localized. 2356 "key": { # The key which can uniquely identify the conference solution for this event. 2357 "type": "A String", # The conference solution type. 2358 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 2359 # The possible values are: 2360 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 2361 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 2362 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 2363 }, 2364 }, 2365 "signature": "A String", # The signature of the conference data. 2366 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 2367 # Unset for a conference with a failed create request. 2368 # Optional for a conference with a pending create request. 2369 }, 2370 }</pre> 2371</div> 2372 2373<div class="method"> 2374 <code class="details" id="patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, supportsAttachments=None, maxAttendees=None, conferenceDataVersion=None, sendUpdates=None)</code> 2375 <pre>Updates an event. This method supports patch semantics. 2376 2377Args: 2378 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) 2379 eventId: string, Event identifier. (required) 2380 body: object, The request body. (required) 2381 The object takes the form of: 2382 2383{ 2384 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 2385 # In order to modify attachments the supportsAttachments request parameter should be set to true. 2386 # There can be at most 25 attachments per event, 2387 { 2388 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 2389 "title": "A String", # Attachment title. 2390 "fileUrl": "A String", # URL link to the attachment. 2391 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 2392 # Required when adding an attachment. 2393 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 2394 "fileId": "A String", # ID of the attached file. Read-only. 2395 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 2396 }, 2397 ], 2398 "creator": { # The creator of the event. Read-only. 2399 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 2400 "displayName": "A String", # The creator's name, if available. 2401 "email": "A String", # The creator's email address, if available. 2402 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2403 }, 2404 "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. 2405 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 2406 "displayName": "A String", # The organizer's name, if available. 2407 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 2408 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2409 }, 2410 "summary": "A String", # Title of the event. 2411 "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: 2412 # - 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 2413 # - the length of the ID must be between 5 and 1024 characters 2414 # - 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. 2415 # If you do not specify an ID, it will be automatically generated by the server. 2416 # 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. 2417 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 2418 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 2419 { 2420 "comment": "A String", # The attendee's response comment. Optional. 2421 "displayName": "A String", # The attendee's name, if available. Optional. 2422 "responseStatus": "A String", # The attendee's response status. Possible values are: 2423 # - "needsAction" - The attendee has not responded to the invitation. 2424 # - "declined" - The attendee has declined the invitation. 2425 # - "tentative" - The attendee has tentatively accepted the invitation. 2426 # - "accepted" - The attendee has accepted the invitation. 2427 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 2428 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2429 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 2430 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 2431 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 2432 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 2433 "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. 2434 # Required when adding an attendee. 2435 }, 2436 ], 2437 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 2438 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2439 "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. 2440 "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. 2441 }, 2442 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 2443 "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. 2444 "A String", 2445 ], 2446 "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. 2447 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 2448 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 2449 }, 2450 "etag": "A String", # ETag of the resource. 2451 "location": "A String", # Geographic location of the event as free-form text. Optional. 2452 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 2453 "gadget": { # A gadget that extends this event. 2454 "preferences": { # Preferences. 2455 "a_key": "A String", # The preference name and corresponding value. 2456 }, 2457 "title": "A String", # The gadget's title. 2458 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 2459 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 2460 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 2461 "type": "A String", # The gadget's type. 2462 "display": "A String", # The gadget's display mode. Optional. Possible values are: 2463 # - "icon" - The gadget displays next to the event's title in the calendar view. 2464 # - "chip" - The gadget displays when the event is clicked. 2465 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 2466 }, 2467 "status": "A String", # Status of the event. Optional. Possible values are: 2468 # - "confirmed" - The event is confirmed. This is the default status. 2469 # - "tentative" - The event is tentatively confirmed. 2470 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 2471 # A cancelled status represents two different states depending on the event type: 2472 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 2473 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 2474 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 2475 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 2476 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 2477 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 2478 "description": "A String", # Description of the event. Optional. 2479 "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. 2480 # 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. 2481 "extendedProperties": { # Extended properties of the event. 2482 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 2483 "a_key": "A String", # The name of the shared property and the corresponding value. 2484 }, 2485 "private": { # Properties that are private to the copy of the event that appears on this calendar. 2486 "a_key": "A String", # The name of the private property and the corresponding value. 2487 }, 2488 }, 2489 "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. 2490 "sequence": 42, # Sequence number as per iCalendar. 2491 "visibility": "default", # Visibility of the event. Optional. Possible values are: 2492 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 2493 # - "public" - The event is public and event details are visible to all readers of the calendar. 2494 # - "private" - The event is private and only event attendees may view event details. 2495 # - "confidential" - The event is private. This value is provided for compatibility reasons. 2496 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 2497 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 2498 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2499 "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. 2500 "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. 2501 }, 2502 "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. 2503 "kind": "calendar#event", # Type of the resource ("calendar#event"). 2504 "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. 2505 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 2506 "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. 2507 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 2508 "reminders": { # Information about the event's reminders for the authenticated user. 2509 "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. 2510 { 2511 "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). 2512 # Required when adding a reminder. 2513 "method": "A String", # The method used by this reminder. Possible values are: 2514 # - "email" - Reminders are sent via email. 2515 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 2516 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 2517 # - "popup" - Reminders are sent via a UI popup. 2518 # Required when adding a reminder. 2519 }, 2520 ], 2521 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 2522 }, 2523 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 2524 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 2525 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2526 "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. 2527 "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. 2528 }, 2529 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 2530 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 2531 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 2532 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 2533 "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. 2534 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 2535 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 2536 # All of them must belong to the same conference. 2537 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2538 { 2539 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 2540 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2541 # Optional. 2542 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 2543 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2544 # Optional. 2545 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 2546 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2547 # Optional. 2548 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 2549 # Format: 2550 # - for video, http: or https: schema is required. 2551 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 2552 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 2553 # - for more, http: or https: schema is required. 2554 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 2555 "A String", 2556 ], 2557 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 2558 # Examples: 2559 # - for video: meet.google.com/aaa-bbbb-ccc 2560 # - for phone: +1 123 268 2601 2561 # - for sip: 12345678@altostrat.com 2562 # - for more: should not be filled 2563 # Optional. 2564 "entryPointType": "A String", # The type of the conference entry point. 2565 # Possible values are: 2566 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 2567 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 2568 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 2569 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 2570 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 2571 # Calendar backend will populate this field only for EntryPointType.PHONE. 2572 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 2573 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2574 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 2575 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2576 # Optional. 2577 }, 2578 ], 2579 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 2580 "addOnParameters": { # Additional add-on specific data. 2581 "parameters": { 2582 "a_key": "A String", 2583 }, 2584 }, 2585 }, 2586 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 2587 "conferenceId": "A String", # The ID of the conference. 2588 # Can be used by developers to keep track of conferences, should not be displayed to users. 2589 # Values for solution types: 2590 # - "eventHangout": unset. 2591 # - "eventNamedHangout": the name of the Hangout. 2592 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 2593 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 2594 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2595 "status": { # The status of the conference create request. 2596 "statusCode": "A String", # The current status of the conference create request. Read-only. 2597 # The possible values are: 2598 # - "pending": the conference create request is still being processed. 2599 # - "success": the conference create request succeeded, the entry points are populated. 2600 # - "failure": the conference create request failed, there are no entry points. 2601 }, 2602 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 2603 "type": "A String", # The conference solution type. 2604 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 2605 # The possible values are: 2606 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 2607 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 2608 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 2609 }, 2610 "requestId": "A String", # The client-generated unique ID for this request. 2611 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 2612 }, 2613 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 2614 # Unset for a conference with a failed create request. 2615 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2616 "iconUri": "A String", # The user-visible icon for this solution. 2617 "name": "A String", # The user-visible name of this solution. Not localized. 2618 "key": { # The key which can uniquely identify the conference solution for this event. 2619 "type": "A String", # The conference solution type. 2620 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 2621 # The possible values are: 2622 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 2623 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 2624 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 2625 }, 2626 }, 2627 "signature": "A String", # The signature of the conference data. 2628 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 2629 # Unset for a conference with a failed create request. 2630 # Optional for a conference with a pending create request. 2631 }, 2632 } 2633 2634 sendNotifications: boolean, Deprecated. Please use sendUpdates instead. 2635 2636Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false. 2637 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. 2638 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. 2639 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. 2640 conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. 2641 sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.). 2642 Allowed values 2643 all - Notifications are sent to all guests. 2644 externalOnly - Notifications are sent to non-Google Calendar guests only. 2645 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used). 2646 2647Returns: 2648 An object of the form: 2649 2650 { 2651 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 2652 # In order to modify attachments the supportsAttachments request parameter should be set to true. 2653 # There can be at most 25 attachments per event, 2654 { 2655 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 2656 "title": "A String", # Attachment title. 2657 "fileUrl": "A String", # URL link to the attachment. 2658 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 2659 # Required when adding an attachment. 2660 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 2661 "fileId": "A String", # ID of the attached file. Read-only. 2662 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 2663 }, 2664 ], 2665 "creator": { # The creator of the event. Read-only. 2666 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 2667 "displayName": "A String", # The creator's name, if available. 2668 "email": "A String", # The creator's email address, if available. 2669 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2670 }, 2671 "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. 2672 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 2673 "displayName": "A String", # The organizer's name, if available. 2674 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 2675 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2676 }, 2677 "summary": "A String", # Title of the event. 2678 "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: 2679 # - 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 2680 # - the length of the ID must be between 5 and 1024 characters 2681 # - 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. 2682 # If you do not specify an ID, it will be automatically generated by the server. 2683 # 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. 2684 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 2685 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 2686 { 2687 "comment": "A String", # The attendee's response comment. Optional. 2688 "displayName": "A String", # The attendee's name, if available. Optional. 2689 "responseStatus": "A String", # The attendee's response status. Possible values are: 2690 # - "needsAction" - The attendee has not responded to the invitation. 2691 # - "declined" - The attendee has declined the invitation. 2692 # - "tentative" - The attendee has tentatively accepted the invitation. 2693 # - "accepted" - The attendee has accepted the invitation. 2694 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 2695 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2696 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 2697 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 2698 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 2699 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 2700 "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. 2701 # Required when adding an attendee. 2702 }, 2703 ], 2704 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 2705 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2706 "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. 2707 "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. 2708 }, 2709 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 2710 "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. 2711 "A String", 2712 ], 2713 "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. 2714 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 2715 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 2716 }, 2717 "etag": "A String", # ETag of the resource. 2718 "location": "A String", # Geographic location of the event as free-form text. Optional. 2719 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 2720 "gadget": { # A gadget that extends this event. 2721 "preferences": { # Preferences. 2722 "a_key": "A String", # The preference name and corresponding value. 2723 }, 2724 "title": "A String", # The gadget's title. 2725 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 2726 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 2727 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 2728 "type": "A String", # The gadget's type. 2729 "display": "A String", # The gadget's display mode. Optional. Possible values are: 2730 # - "icon" - The gadget displays next to the event's title in the calendar view. 2731 # - "chip" - The gadget displays when the event is clicked. 2732 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 2733 }, 2734 "status": "A String", # Status of the event. Optional. Possible values are: 2735 # - "confirmed" - The event is confirmed. This is the default status. 2736 # - "tentative" - The event is tentatively confirmed. 2737 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 2738 # A cancelled status represents two different states depending on the event type: 2739 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 2740 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 2741 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 2742 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 2743 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 2744 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 2745 "description": "A String", # Description of the event. Optional. 2746 "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. 2747 # 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. 2748 "extendedProperties": { # Extended properties of the event. 2749 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 2750 "a_key": "A String", # The name of the shared property and the corresponding value. 2751 }, 2752 "private": { # Properties that are private to the copy of the event that appears on this calendar. 2753 "a_key": "A String", # The name of the private property and the corresponding value. 2754 }, 2755 }, 2756 "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. 2757 "sequence": 42, # Sequence number as per iCalendar. 2758 "visibility": "default", # Visibility of the event. Optional. Possible values are: 2759 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 2760 # - "public" - The event is public and event details are visible to all readers of the calendar. 2761 # - "private" - The event is private and only event attendees may view event details. 2762 # - "confidential" - The event is private. This value is provided for compatibility reasons. 2763 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 2764 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 2765 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2766 "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. 2767 "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. 2768 }, 2769 "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. 2770 "kind": "calendar#event", # Type of the resource ("calendar#event"). 2771 "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. 2772 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 2773 "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. 2774 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 2775 "reminders": { # Information about the event's reminders for the authenticated user. 2776 "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. 2777 { 2778 "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). 2779 # Required when adding a reminder. 2780 "method": "A String", # The method used by this reminder. Possible values are: 2781 # - "email" - Reminders are sent via email. 2782 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 2783 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 2784 # - "popup" - Reminders are sent via a UI popup. 2785 # Required when adding a reminder. 2786 }, 2787 ], 2788 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 2789 }, 2790 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 2791 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 2792 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2793 "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. 2794 "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. 2795 }, 2796 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 2797 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 2798 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 2799 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 2800 "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. 2801 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 2802 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 2803 # All of them must belong to the same conference. 2804 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2805 { 2806 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 2807 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2808 # Optional. 2809 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 2810 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2811 # Optional. 2812 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 2813 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2814 # Optional. 2815 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 2816 # Format: 2817 # - for video, http: or https: schema is required. 2818 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 2819 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 2820 # - for more, http: or https: schema is required. 2821 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 2822 "A String", 2823 ], 2824 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 2825 # Examples: 2826 # - for video: meet.google.com/aaa-bbbb-ccc 2827 # - for phone: +1 123 268 2601 2828 # - for sip: 12345678@altostrat.com 2829 # - for more: should not be filled 2830 # Optional. 2831 "entryPointType": "A String", # The type of the conference entry point. 2832 # Possible values are: 2833 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 2834 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 2835 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 2836 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 2837 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 2838 # Calendar backend will populate this field only for EntryPointType.PHONE. 2839 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 2840 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2841 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 2842 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 2843 # Optional. 2844 }, 2845 ], 2846 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 2847 "addOnParameters": { # Additional add-on specific data. 2848 "parameters": { 2849 "a_key": "A String", 2850 }, 2851 }, 2852 }, 2853 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 2854 "conferenceId": "A String", # The ID of the conference. 2855 # Can be used by developers to keep track of conferences, should not be displayed to users. 2856 # Values for solution types: 2857 # - "eventHangout": unset. 2858 # - "eventNamedHangout": the name of the Hangout. 2859 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 2860 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 2861 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2862 "status": { # The status of the conference create request. 2863 "statusCode": "A String", # The current status of the conference create request. Read-only. 2864 # The possible values are: 2865 # - "pending": the conference create request is still being processed. 2866 # - "success": the conference create request succeeded, the entry points are populated. 2867 # - "failure": the conference create request failed, there are no entry points. 2868 }, 2869 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 2870 "type": "A String", # The conference solution type. 2871 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 2872 # The possible values are: 2873 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 2874 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 2875 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 2876 }, 2877 "requestId": "A String", # The client-generated unique ID for this request. 2878 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 2879 }, 2880 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 2881 # Unset for a conference with a failed create request. 2882 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 2883 "iconUri": "A String", # The user-visible icon for this solution. 2884 "name": "A String", # The user-visible name of this solution. Not localized. 2885 "key": { # The key which can uniquely identify the conference solution for this event. 2886 "type": "A String", # The conference solution type. 2887 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 2888 # The possible values are: 2889 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 2890 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 2891 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 2892 }, 2893 }, 2894 "signature": "A String", # The signature of the conference data. 2895 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 2896 # Unset for a conference with a failed create request. 2897 # Optional for a conference with a pending create request. 2898 }, 2899 }</pre> 2900</div> 2901 2902<div class="method"> 2903 <code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None, sendUpdates=None)</code> 2904 <pre>Creates an event based on a simple text string. 2905 2906Args: 2907 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) 2908 text: string, The text describing the event to be created. (required) 2909 sendNotifications: boolean, Deprecated. Please use sendUpdates instead. 2910 2911Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false. 2912 sendUpdates: string, Guests who should receive notifications about the creation of the new event. 2913 Allowed values 2914 all - Notifications are sent to all guests. 2915 externalOnly - Notifications are sent to non-Google Calendar guests only. 2916 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used). 2917 2918Returns: 2919 An object of the form: 2920 2921 { 2922 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 2923 # In order to modify attachments the supportsAttachments request parameter should be set to true. 2924 # There can be at most 25 attachments per event, 2925 { 2926 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 2927 "title": "A String", # Attachment title. 2928 "fileUrl": "A String", # URL link to the attachment. 2929 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 2930 # Required when adding an attachment. 2931 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 2932 "fileId": "A String", # ID of the attached file. Read-only. 2933 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 2934 }, 2935 ], 2936 "creator": { # The creator of the event. Read-only. 2937 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 2938 "displayName": "A String", # The creator's name, if available. 2939 "email": "A String", # The creator's email address, if available. 2940 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2941 }, 2942 "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. 2943 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 2944 "displayName": "A String", # The organizer's name, if available. 2945 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 2946 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2947 }, 2948 "summary": "A String", # Title of the event. 2949 "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: 2950 # - 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 2951 # - the length of the ID must be between 5 and 1024 characters 2952 # - 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. 2953 # If you do not specify an ID, it will be automatically generated by the server. 2954 # 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. 2955 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 2956 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 2957 { 2958 "comment": "A String", # The attendee's response comment. Optional. 2959 "displayName": "A String", # The attendee's name, if available. Optional. 2960 "responseStatus": "A String", # The attendee's response status. Possible values are: 2961 # - "needsAction" - The attendee has not responded to the invitation. 2962 # - "declined" - The attendee has declined the invitation. 2963 # - "tentative" - The attendee has tentatively accepted the invitation. 2964 # - "accepted" - The attendee has accepted the invitation. 2965 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 2966 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 2967 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 2968 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 2969 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 2970 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 2971 "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. 2972 # Required when adding an attendee. 2973 }, 2974 ], 2975 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 2976 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 2977 "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. 2978 "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. 2979 }, 2980 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 2981 "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. 2982 "A String", 2983 ], 2984 "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. 2985 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 2986 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 2987 }, 2988 "etag": "A String", # ETag of the resource. 2989 "location": "A String", # Geographic location of the event as free-form text. Optional. 2990 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 2991 "gadget": { # A gadget that extends this event. 2992 "preferences": { # Preferences. 2993 "a_key": "A String", # The preference name and corresponding value. 2994 }, 2995 "title": "A String", # The gadget's title. 2996 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 2997 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 2998 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 2999 "type": "A String", # The gadget's type. 3000 "display": "A String", # The gadget's display mode. Optional. Possible values are: 3001 # - "icon" - The gadget displays next to the event's title in the calendar view. 3002 # - "chip" - The gadget displays when the event is clicked. 3003 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 3004 }, 3005 "status": "A String", # Status of the event. Optional. Possible values are: 3006 # - "confirmed" - The event is confirmed. This is the default status. 3007 # - "tentative" - The event is tentatively confirmed. 3008 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 3009 # A cancelled status represents two different states depending on the event type: 3010 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 3011 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 3012 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 3013 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 3014 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 3015 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 3016 "description": "A String", # Description of the event. Optional. 3017 "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. 3018 # 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. 3019 "extendedProperties": { # Extended properties of the event. 3020 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 3021 "a_key": "A String", # The name of the shared property and the corresponding value. 3022 }, 3023 "private": { # Properties that are private to the copy of the event that appears on this calendar. 3024 "a_key": "A String", # The name of the private property and the corresponding value. 3025 }, 3026 }, 3027 "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. 3028 "sequence": 42, # Sequence number as per iCalendar. 3029 "visibility": "default", # Visibility of the event. Optional. Possible values are: 3030 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 3031 # - "public" - The event is public and event details are visible to all readers of the calendar. 3032 # - "private" - The event is private and only event attendees may view event details. 3033 # - "confidential" - The event is private. This value is provided for compatibility reasons. 3034 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 3035 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 3036 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 3037 "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. 3038 "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. 3039 }, 3040 "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. 3041 "kind": "calendar#event", # Type of the resource ("calendar#event"). 3042 "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. 3043 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 3044 "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. 3045 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 3046 "reminders": { # Information about the event's reminders for the authenticated user. 3047 "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. 3048 { 3049 "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). 3050 # Required when adding a reminder. 3051 "method": "A String", # The method used by this reminder. Possible values are: 3052 # - "email" - Reminders are sent via email. 3053 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 3054 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 3055 # - "popup" - Reminders are sent via a UI popup. 3056 # Required when adding a reminder. 3057 }, 3058 ], 3059 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 3060 }, 3061 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 3062 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 3063 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 3064 "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. 3065 "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. 3066 }, 3067 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 3068 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 3069 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 3070 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 3071 "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. 3072 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 3073 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 3074 # All of them must belong to the same conference. 3075 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 3076 { 3077 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 3078 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3079 # Optional. 3080 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 3081 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3082 # Optional. 3083 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 3084 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3085 # Optional. 3086 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 3087 # Format: 3088 # - for video, http: or https: schema is required. 3089 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 3090 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 3091 # - for more, http: or https: schema is required. 3092 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 3093 "A String", 3094 ], 3095 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 3096 # Examples: 3097 # - for video: meet.google.com/aaa-bbbb-ccc 3098 # - for phone: +1 123 268 2601 3099 # - for sip: 12345678@altostrat.com 3100 # - for more: should not be filled 3101 # Optional. 3102 "entryPointType": "A String", # The type of the conference entry point. 3103 # Possible values are: 3104 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 3105 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 3106 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 3107 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 3108 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 3109 # Calendar backend will populate this field only for EntryPointType.PHONE. 3110 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 3111 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3112 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 3113 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3114 # Optional. 3115 }, 3116 ], 3117 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 3118 "addOnParameters": { # Additional add-on specific data. 3119 "parameters": { 3120 "a_key": "A String", 3121 }, 3122 }, 3123 }, 3124 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 3125 "conferenceId": "A String", # The ID of the conference. 3126 # Can be used by developers to keep track of conferences, should not be displayed to users. 3127 # Values for solution types: 3128 # - "eventHangout": unset. 3129 # - "eventNamedHangout": the name of the Hangout. 3130 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 3131 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 3132 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 3133 "status": { # The status of the conference create request. 3134 "statusCode": "A String", # The current status of the conference create request. Read-only. 3135 # The possible values are: 3136 # - "pending": the conference create request is still being processed. 3137 # - "success": the conference create request succeeded, the entry points are populated. 3138 # - "failure": the conference create request failed, there are no entry points. 3139 }, 3140 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 3141 "type": "A String", # The conference solution type. 3142 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 3143 # The possible values are: 3144 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 3145 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 3146 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 3147 }, 3148 "requestId": "A String", # The client-generated unique ID for this request. 3149 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 3150 }, 3151 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 3152 # Unset for a conference with a failed create request. 3153 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 3154 "iconUri": "A String", # The user-visible icon for this solution. 3155 "name": "A String", # The user-visible name of this solution. Not localized. 3156 "key": { # The key which can uniquely identify the conference solution for this event. 3157 "type": "A String", # The conference solution type. 3158 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 3159 # The possible values are: 3160 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 3161 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 3162 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 3163 }, 3164 }, 3165 "signature": "A String", # The signature of the conference data. 3166 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 3167 # Unset for a conference with a failed create request. 3168 # Optional for a conference with a pending create request. 3169 }, 3170 }</pre> 3171</div> 3172 3173<div class="method"> 3174 <code class="details" id="update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, supportsAttachments=None, maxAttendees=None, conferenceDataVersion=None, sendUpdates=None)</code> 3175 <pre>Updates an event. 3176 3177Args: 3178 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) 3179 eventId: string, Event identifier. (required) 3180 body: object, The request body. (required) 3181 The object takes the form of: 3182 3183{ 3184 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 3185 # In order to modify attachments the supportsAttachments request parameter should be set to true. 3186 # There can be at most 25 attachments per event, 3187 { 3188 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 3189 "title": "A String", # Attachment title. 3190 "fileUrl": "A String", # URL link to the attachment. 3191 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 3192 # Required when adding an attachment. 3193 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 3194 "fileId": "A String", # ID of the attached file. Read-only. 3195 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 3196 }, 3197 ], 3198 "creator": { # The creator of the event. Read-only. 3199 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 3200 "displayName": "A String", # The creator's name, if available. 3201 "email": "A String", # The creator's email address, if available. 3202 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 3203 }, 3204 "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. 3205 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 3206 "displayName": "A String", # The organizer's name, if available. 3207 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 3208 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 3209 }, 3210 "summary": "A String", # Title of the event. 3211 "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: 3212 # - 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 3213 # - the length of the ID must be between 5 and 1024 characters 3214 # - 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. 3215 # If you do not specify an ID, it will be automatically generated by the server. 3216 # 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. 3217 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 3218 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 3219 { 3220 "comment": "A String", # The attendee's response comment. Optional. 3221 "displayName": "A String", # The attendee's name, if available. Optional. 3222 "responseStatus": "A String", # The attendee's response status. Possible values are: 3223 # - "needsAction" - The attendee has not responded to the invitation. 3224 # - "declined" - The attendee has declined the invitation. 3225 # - "tentative" - The attendee has tentatively accepted the invitation. 3226 # - "accepted" - The attendee has accepted the invitation. 3227 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 3228 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 3229 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 3230 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 3231 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 3232 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 3233 "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. 3234 # Required when adding an attendee. 3235 }, 3236 ], 3237 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 3238 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 3239 "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. 3240 "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. 3241 }, 3242 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 3243 "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. 3244 "A String", 3245 ], 3246 "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. 3247 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 3248 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 3249 }, 3250 "etag": "A String", # ETag of the resource. 3251 "location": "A String", # Geographic location of the event as free-form text. Optional. 3252 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 3253 "gadget": { # A gadget that extends this event. 3254 "preferences": { # Preferences. 3255 "a_key": "A String", # The preference name and corresponding value. 3256 }, 3257 "title": "A String", # The gadget's title. 3258 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 3259 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 3260 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 3261 "type": "A String", # The gadget's type. 3262 "display": "A String", # The gadget's display mode. Optional. Possible values are: 3263 # - "icon" - The gadget displays next to the event's title in the calendar view. 3264 # - "chip" - The gadget displays when the event is clicked. 3265 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 3266 }, 3267 "status": "A String", # Status of the event. Optional. Possible values are: 3268 # - "confirmed" - The event is confirmed. This is the default status. 3269 # - "tentative" - The event is tentatively confirmed. 3270 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 3271 # A cancelled status represents two different states depending on the event type: 3272 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 3273 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 3274 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 3275 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 3276 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 3277 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 3278 "description": "A String", # Description of the event. Optional. 3279 "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. 3280 # 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. 3281 "extendedProperties": { # Extended properties of the event. 3282 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 3283 "a_key": "A String", # The name of the shared property and the corresponding value. 3284 }, 3285 "private": { # Properties that are private to the copy of the event that appears on this calendar. 3286 "a_key": "A String", # The name of the private property and the corresponding value. 3287 }, 3288 }, 3289 "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. 3290 "sequence": 42, # Sequence number as per iCalendar. 3291 "visibility": "default", # Visibility of the event. Optional. Possible values are: 3292 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 3293 # - "public" - The event is public and event details are visible to all readers of the calendar. 3294 # - "private" - The event is private and only event attendees may view event details. 3295 # - "confidential" - The event is private. This value is provided for compatibility reasons. 3296 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 3297 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 3298 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 3299 "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. 3300 "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. 3301 }, 3302 "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. 3303 "kind": "calendar#event", # Type of the resource ("calendar#event"). 3304 "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. 3305 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 3306 "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. 3307 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 3308 "reminders": { # Information about the event's reminders for the authenticated user. 3309 "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. 3310 { 3311 "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). 3312 # Required when adding a reminder. 3313 "method": "A String", # The method used by this reminder. Possible values are: 3314 # - "email" - Reminders are sent via email. 3315 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 3316 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 3317 # - "popup" - Reminders are sent via a UI popup. 3318 # Required when adding a reminder. 3319 }, 3320 ], 3321 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 3322 }, 3323 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 3324 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 3325 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 3326 "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. 3327 "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. 3328 }, 3329 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 3330 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 3331 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 3332 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 3333 "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. 3334 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 3335 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 3336 # All of them must belong to the same conference. 3337 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 3338 { 3339 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 3340 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3341 # Optional. 3342 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 3343 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3344 # Optional. 3345 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 3346 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3347 # Optional. 3348 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 3349 # Format: 3350 # - for video, http: or https: schema is required. 3351 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 3352 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 3353 # - for more, http: or https: schema is required. 3354 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 3355 "A String", 3356 ], 3357 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 3358 # Examples: 3359 # - for video: meet.google.com/aaa-bbbb-ccc 3360 # - for phone: +1 123 268 2601 3361 # - for sip: 12345678@altostrat.com 3362 # - for more: should not be filled 3363 # Optional. 3364 "entryPointType": "A String", # The type of the conference entry point. 3365 # Possible values are: 3366 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 3367 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 3368 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 3369 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 3370 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 3371 # Calendar backend will populate this field only for EntryPointType.PHONE. 3372 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 3373 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3374 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 3375 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3376 # Optional. 3377 }, 3378 ], 3379 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 3380 "addOnParameters": { # Additional add-on specific data. 3381 "parameters": { 3382 "a_key": "A String", 3383 }, 3384 }, 3385 }, 3386 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 3387 "conferenceId": "A String", # The ID of the conference. 3388 # Can be used by developers to keep track of conferences, should not be displayed to users. 3389 # Values for solution types: 3390 # - "eventHangout": unset. 3391 # - "eventNamedHangout": the name of the Hangout. 3392 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 3393 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 3394 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 3395 "status": { # The status of the conference create request. 3396 "statusCode": "A String", # The current status of the conference create request. Read-only. 3397 # The possible values are: 3398 # - "pending": the conference create request is still being processed. 3399 # - "success": the conference create request succeeded, the entry points are populated. 3400 # - "failure": the conference create request failed, there are no entry points. 3401 }, 3402 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 3403 "type": "A String", # The conference solution type. 3404 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 3405 # The possible values are: 3406 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 3407 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 3408 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 3409 }, 3410 "requestId": "A String", # The client-generated unique ID for this request. 3411 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 3412 }, 3413 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 3414 # Unset for a conference with a failed create request. 3415 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 3416 "iconUri": "A String", # The user-visible icon for this solution. 3417 "name": "A String", # The user-visible name of this solution. Not localized. 3418 "key": { # The key which can uniquely identify the conference solution for this event. 3419 "type": "A String", # The conference solution type. 3420 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 3421 # The possible values are: 3422 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 3423 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 3424 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 3425 }, 3426 }, 3427 "signature": "A String", # The signature of the conference data. 3428 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 3429 # Unset for a conference with a failed create request. 3430 # Optional for a conference with a pending create request. 3431 }, 3432 } 3433 3434 sendNotifications: boolean, Deprecated. Please use sendUpdates instead. 3435 3436Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false. 3437 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. 3438 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. 3439 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. 3440 conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. 3441 sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.). 3442 Allowed values 3443 all - Notifications are sent to all guests. 3444 externalOnly - Notifications are sent to non-Google Calendar guests only. 3445 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used). 3446 3447Returns: 3448 An object of the form: 3449 3450 { 3451 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. 3452 # In order to modify attachments the supportsAttachments request parameter should be set to true. 3453 # There can be at most 25 attachments per event, 3454 { 3455 "mimeType": "A String", # Internet media type (MIME type) of the attachment. 3456 "title": "A String", # Attachment title. 3457 "fileUrl": "A String", # URL link to the attachment. 3458 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. 3459 # Required when adding an attachment. 3460 "iconLink": "A String", # URL link to the attachment's icon. Read-only. 3461 "fileId": "A String", # ID of the attached file. Read-only. 3462 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. 3463 }, 3464 ], 3465 "creator": { # The creator of the event. Read-only. 3466 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 3467 "displayName": "A String", # The creator's name, if available. 3468 "email": "A String", # The creator's email address, if available. 3469 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 3470 }, 3471 "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. 3472 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. 3473 "displayName": "A String", # The organizer's name, if available. 3474 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. 3475 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 3476 }, 3477 "summary": "A String", # Title of the event. 3478 "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: 3479 # - 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 3480 # - the length of the ID must be between 5 and 1024 characters 3481 # - 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. 3482 # If you do not specify an ID, it will be automatically generated by the server. 3483 # 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. 3484 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. 3485 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. 3486 { 3487 "comment": "A String", # The attendee's response comment. Optional. 3488 "displayName": "A String", # The attendee's name, if available. Optional. 3489 "responseStatus": "A String", # The attendee's response status. Possible values are: 3490 # - "needsAction" - The attendee has not responded to the invitation. 3491 # - "declined" - The attendee has declined the invitation. 3492 # - "tentative" - The attendee has tentatively accepted the invitation. 3493 # - "accepted" - The attendee has accepted the invitation. 3494 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. 3495 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API 3496 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. 3497 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. 3498 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. 3499 "optional": false, # Whether this is an optional attendee. Optional. The default is False. 3500 "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. 3501 # Required when adding an attendee. 3502 }, 3503 ], 3504 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. 3505 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 3506 "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. 3507 "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. 3508 }, 3509 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. 3510 "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. 3511 "A String", 3512 ], 3513 "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. 3514 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. 3515 "title": "A String", # Title of the source; for example a title of a web page or an email subject. 3516 }, 3517 "etag": "A String", # ETag of the resource. 3518 "location": "A String", # Geographic location of the event as free-form text. Optional. 3519 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. 3520 "gadget": { # A gadget that extends this event. 3521 "preferences": { # Preferences. 3522 "a_key": "A String", # The preference name and corresponding value. 3523 }, 3524 "title": "A String", # The gadget's title. 3525 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. 3526 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. 3527 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. 3528 "type": "A String", # The gadget's type. 3529 "display": "A String", # The gadget's display mode. Optional. Possible values are: 3530 # - "icon" - The gadget displays next to the event's title in the calendar view. 3531 # - "chip" - The gadget displays when the event is clicked. 3532 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. 3533 }, 3534 "status": "A String", # Status of the event. Optional. Possible values are: 3535 # - "confirmed" - The event is confirmed. This is the default status. 3536 # - "tentative" - The event is tentatively confirmed. 3537 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. 3538 # A cancelled status represents two different states depending on the event type: 3539 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. 3540 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. 3541 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. 3542 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. 3543 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. 3544 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. 3545 "description": "A String", # Description of the event. Optional. 3546 "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. 3547 # 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. 3548 "extendedProperties": { # Extended properties of the event. 3549 "shared": { # Properties that are shared between copies of the event on other attendees' calendars. 3550 "a_key": "A String", # The name of the shared property and the corresponding value. 3551 }, 3552 "private": { # Properties that are private to the copy of the event that appears on this calendar. 3553 "a_key": "A String", # The name of the private property and the corresponding value. 3554 }, 3555 }, 3556 "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. 3557 "sequence": 42, # Sequence number as per iCalendar. 3558 "visibility": "default", # Visibility of the event. Optional. Possible values are: 3559 # - "default" - Uses the default visibility for events on the calendar. This is the default value. 3560 # - "public" - The event is public and event details are visible to all readers of the calendar. 3561 # - "private" - The event is private and only event attendees may view event details. 3562 # - "confidential" - The event is private. This value is provided for compatibility reasons. 3563 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. 3564 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. 3565 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 3566 "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. 3567 "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. 3568 }, 3569 "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. 3570 "kind": "calendar#event", # Type of the resource ("calendar#event"). 3571 "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. 3572 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. 3573 "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. 3574 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. 3575 "reminders": { # Information about the event's reminders for the authenticated user. 3576 "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. 3577 { 3578 "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). 3579 # Required when adding a reminder. 3580 "method": "A String", # The method used by this reminder. Possible values are: 3581 # - "email" - Reminders are sent via email. 3582 # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. 3583 # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. 3584 # - "popup" - Reminders are sent via a UI popup. 3585 # Required when adding a reminder. 3586 }, 3587 ], 3588 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. 3589 }, 3590 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. 3591 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. 3592 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. 3593 "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. 3594 "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. 3595 }, 3596 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. 3597 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: 3598 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. 3599 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. 3600 "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. 3601 "conferenceData": { # The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. 3602 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. 3603 # All of them must belong to the same conference. 3604 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 3605 { 3606 "password": "A String", # The password to access the conference. The maximum length is 128 characters. 3607 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3608 # Optional. 3609 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. 3610 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3611 # Optional. 3612 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. 3613 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3614 # Optional. 3615 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. 3616 # Format: 3617 # - for video, http: or https: schema is required. 3618 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). 3619 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. 3620 # - for more, http: or https: schema is required. 3621 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. 3622 "A String", 3623 ], 3624 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. 3625 # Examples: 3626 # - for video: meet.google.com/aaa-bbbb-ccc 3627 # - for phone: +1 123 268 2601 3628 # - for sip: 12345678@altostrat.com 3629 # - for more: should not be filled 3630 # Optional. 3631 "entryPointType": "A String", # The type of the conference entry point. 3632 # Possible values are: 3633 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. 3634 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. 3635 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. 3636 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. 3637 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. 3638 # Calendar backend will populate this field only for EntryPointType.PHONE. 3639 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. 3640 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3641 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. 3642 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. 3643 # Optional. 3644 }, 3645 ], 3646 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. 3647 "addOnParameters": { # Additional add-on specific data. 3648 "parameters": { 3649 "a_key": "A String", 3650 }, 3651 }, 3652 }, 3653 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. 3654 "conferenceId": "A String", # The ID of the conference. 3655 # Can be used by developers to keep track of conferences, should not be displayed to users. 3656 # Values for solution types: 3657 # - "eventHangout": unset. 3658 # - "eventNamedHangout": the name of the Hangout. 3659 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. 3660 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. 3661 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 3662 "status": { # The status of the conference create request. 3663 "statusCode": "A String", # The current status of the conference create request. Read-only. 3664 # The possible values are: 3665 # - "pending": the conference create request is still being processed. 3666 # - "success": the conference create request succeeded, the entry points are populated. 3667 # - "failure": the conference create request failed, there are no entry points. 3668 }, 3669 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet. 3670 "type": "A String", # The conference solution type. 3671 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 3672 # The possible values are: 3673 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 3674 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 3675 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 3676 }, 3677 "requestId": "A String", # The client-generated unique ID for this request. 3678 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. 3679 }, 3680 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet. 3681 # Unset for a conference with a failed create request. 3682 # Either conferenceSolution and at least one entryPoint, or createRequest is required. 3683 "iconUri": "A String", # The user-visible icon for this solution. 3684 "name": "A String", # The user-visible name of this solution. Not localized. 3685 "key": { # The key which can uniquely identify the conference solution for this event. 3686 "type": "A String", # The conference solution type. 3687 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. 3688 # The possible values are: 3689 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) 3690 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) 3691 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) 3692 }, 3693 }, 3694 "signature": "A String", # The signature of the conference data. 3695 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. 3696 # Unset for a conference with a failed create request. 3697 # Optional for a conference with a pending create request. 3698 }, 3699 }</pre> 3700</div> 3701 3702<div class="method"> 3703 <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> 3704 <pre>Watch for changes to Events resources. 3705 3706Args: 3707 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) 3708 body: object, The request body. (required) 3709 The object takes the form of: 3710 3711{ 3712 "resourceUri": "A String", # A version-specific identifier for the watched resource. 3713 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 3714 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 3715 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 3716 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 3717 "params": { # Additional parameters controlling delivery channel behavior. Optional. 3718 "a_key": "A String", # Declares a new parameter by name. 3719 }, 3720 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 3721 "address": "A String", # The address where notifications are delivered for this channel. 3722 "type": "A String", # The type of delivery mechanism used for this channel. 3723 "id": "A String", # A UUID or similar unique string that identifies this channel. 3724 } 3725 3726 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order. 3727 Allowed values 3728 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True) 3729 updated - Order by last modification time (ascending). 3730 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False. 3731 timeMin: string, Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. 3732 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) 3733 pageToken: string, Token specifying which result page to return. Optional. 3734 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. 3735 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. 3736 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. 3737 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. 3738 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) 3739 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. 3740 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. 3741There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. 3742 3743These are: 3744- iCalUID 3745- orderBy 3746- privateExtendedProperty 3747- q 3748- sharedExtendedProperty 3749- timeMin 3750- timeMax 3751- 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. 3752Learn more about incremental synchronization. 3753Optional. The default is to return all entries. 3754 iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional. 3755 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. 3756 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. 3757 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional. 3758 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. 3759 3760Returns: 3761 An object of the form: 3762 3763 { 3764 "resourceUri": "A String", # A version-specific identifier for the watched resource. 3765 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 3766 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 3767 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 3768 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 3769 "params": { # Additional parameters controlling delivery channel behavior. Optional. 3770 "a_key": "A String", # Declares a new parameter by name. 3771 }, 3772 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 3773 "address": "A String", # The address where notifications are delivered for this channel. 3774 "type": "A String", # The type of delivery mechanism used for this channel. 3775 "id": "A String", # A UUID or similar unique string that identifies this channel. 3776 }</pre> 3777</div> 3778 3779</body></html>