Lines Matching full:the

91 <p class="firstline">Returns instances of the specified recurring event.</p>
94 <p class="firstline">Retrieves the next page of results.</p>
97 <p class="firstline">Returns events on the specified calendar.</p>
100 <p class="firstline">Retrieves the next page of results.</p>
122 …e calendar IDs call the calendarList.list method. If you want to access the primary calendar of th…
126 …d notifications about the deletion of the event. Note that some emails might still be sent even if…
127 sendUpdates: string, Guests who should receive notifications about the deletion of the event.
131 …ld only be used for migration use cases (note that in most migration cases the import method shoul…
140 …e calendar IDs call the calendarList.list method. If you want to access the primary calendar of th…
142the email field for the organizer, creator and attendees, even if no real email is available (i.e.…
143 …timeZone: string, Time zone used in the response. Optional. The default is the time zone of the ca…
144 …es: integer, The maximum number of attendees to include in the response. If there are more than th…
147 An object of the form:
150 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
151 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
154 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
156 "fileUrl": "A String", # URL link to the attachment.
157 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
170The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
171 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
174 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
176 "summary": "A String", # Title of the event.
177 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
178 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
179 # - the length of the ID must be between 5 and 1024 characters
180the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
181 # If you do not specify an ID, it will be automatically generated by the server.
182the icalUID and the id are not identical and only one of them should be supplied at event creation…
183 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
184 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
194 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
195 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
196the attendee is a resource. Can only be set when the attendee is added to the event for the first …
197 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
203 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
204 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
205The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
206 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
208 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
209 … are not allowed in this field; event start and end times are specified in the start and end field…
212the event was created. For example, a web page, an email message or any document identifiable by a…
213 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
214 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
221 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
236The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
237 # A cancelled status represents two different states depending on the event type:
238 … instance should no longer be presented to the user. Clients should store these events for the lif…
239 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
241the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
242 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
246the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
255 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
263 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
264 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
265The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
266 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
268the event's representation. When retrieving an event, this may be due to a restriction specified b…
269 "kind": "calendar#event", # Type of the resource ("calendar#event").
270 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
271 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
272 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
275the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
277 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
279 "method": "A String", # The method used by this reminder. Possible values are:
281 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
287 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
289 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
290the time at which this event would start according to the recurrence data in the recurring event i…
291 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
292The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
293 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
295 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
296 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
297 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
298 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
299 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
300The conference-related information, such as details of a Hangouts Meet conference. To create new c…
302 # All of them must belong to the same conference.
305 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
306 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
308 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
309 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
311 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
312 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
314 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
317 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
320 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
323 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
330 "entryPointType": "A String", # The type of the conference entry point.
336 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
338 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
339 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
340 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
341 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
352 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
353 "conferenceId": "A String", # The ID of the conference.
357 # - "eventNamedHangout": the name of the Hangout.
358 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
359 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
368 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
369 "type": "A String", # The conference solution type.
370 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
371 # The possible values are:
376 "requestId": "A String", # The client-generated unique ID for this request.
377 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
379 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
387 # The possible values are:
393 "signature": "A String", # The signature of the conference data.
394 …ted on server side. Must be preserved while copying the conference data between events, otherwise
406 …e calendar IDs call the calendarList.list method. If you want to access the primary calendar of th…
407 body: object, The request body. (required)
408 The object takes the form of:
411 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
412 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
415 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
417 "fileUrl": "A String", # URL link to the attachment.
418 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
431The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
432 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
435 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
437 "summary": "A String", # Title of the event.
438 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
439 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
440 # - the length of the ID must be between 5 and 1024 characters
441the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
442 # If you do not specify an ID, it will be automatically generated by the server.
443the icalUID and the id are not identical and only one of them should be supplied at event creation…
444 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
445 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
455 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
456 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
457the attendee is a resource. Can only be set when the attendee is added to the event for the first …
458 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
464 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
465 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
466The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
467 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
469 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
470 … are not allowed in this field; event start and end times are specified in the start and end field…
473the event was created. For example, a web page, an email message or any document identifiable by a…
474 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
475 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
482 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
497The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
498 # A cancelled status represents two different states depending on the event type:
499 … instance should no longer be presented to the user. Clients should store these events for the lif…
500 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
502the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
503 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
507the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
516 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
524 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
525 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
526The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
527 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
529the event's representation. When retrieving an event, this may be due to a restriction specified b…
530 "kind": "calendar#event", # Type of the resource ("calendar#event").
531 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
532 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
533 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
536the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
538 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
540 "method": "A String", # The method used by this reminder. Possible values are:
542 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
548 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
550 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
551the time at which this event would start according to the recurrence data in the recurring event i…
552 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
553The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
554 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
556 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
557 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
558 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
559 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
560 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
561The conference-related information, such as details of a Hangouts Meet conference. To create new c…
563 # All of them must belong to the same conference.
566 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
567 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
569 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
570 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
572 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
573 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
575 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
578 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
581 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
584 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
591 "entryPointType": "A String", # The type of the conference entry point.
597 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
599 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
600 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
601 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
602 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
613 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
614 "conferenceId": "A String", # The ID of the conference.
618 # - "eventNamedHangout": the name of the Hangout.
619 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
620 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
629 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
630 "type": "A String", # The conference solution type.
631 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
632 # The possible values are:
637 "requestId": "A String", # The client-generated unique ID for this request.
638 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
640 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
648 # The possible values are:
654 "signature": "A String", # The signature of the conference data.
655 …ted on server side. Must be preserved while copying the conference data between events, otherwise
661 …Whether API client performing operation supports event attachments. Optional. The default is False.
662the API client. Version 0 assumes no conference data support and ignores conference data in the ev…
665 An object of the form:
668 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
669 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
672 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
674 "fileUrl": "A String", # URL link to the attachment.
675 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
688The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
689 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
692 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
694 "summary": "A String", # Title of the event.
695 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
696 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
697 # - the length of the ID must be between 5 and 1024 characters
698the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
699 # If you do not specify an ID, it will be automatically generated by the server.
700the icalUID and the id are not identical and only one of them should be supplied at event creation…
701 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
702 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
712 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
713 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
714the attendee is a resource. Can only be set when the attendee is added to the event for the first …
715 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
721 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
722 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
723The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
724 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
726 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
727 … are not allowed in this field; event start and end times are specified in the start and end field…
730the event was created. For example, a web page, an email message or any document identifiable by a…
731 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
732 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
739 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
754The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
755 # A cancelled status represents two different states depending on the event type:
756 … instance should no longer be presented to the user. Clients should store these events for the lif…
757 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
759the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
760 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
764the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
773 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
781 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
782 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
783The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
784 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
786the event's representation. When retrieving an event, this may be due to a restriction specified b…
787 "kind": "calendar#event", # Type of the resource ("calendar#event").
788 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
789 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
790 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
793the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
795 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
797 "method": "A String", # The method used by this reminder. Possible values are:
799 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
805 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
807 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
808the time at which this event would start according to the recurrence data in the recurring event i…
809 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
810The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
811 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
813 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
814 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
815 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
816 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
817 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
818The conference-related information, such as details of a Hangouts Meet conference. To create new c…
820 # All of them must belong to the same conference.
823 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
824 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
826 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
827 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
829 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
830 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
832 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
835 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
838 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
841 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
848 "entryPointType": "A String", # The type of the conference entry point.
854 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
856 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
857 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
858 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
859 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
870 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
871 "conferenceId": "A String", # The ID of the conference.
875 # - "eventNamedHangout": the name of the Hangout.
876 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
877 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
886 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
887 "type": "A String", # The conference solution type.
888 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
889 # The possible values are:
894 "requestId": "A String", # The client-generated unique ID for this request.
895 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
897 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
905 # The possible values are:
911 "signature": "A String", # The signature of the conference data.
912 …ted on server side. Must be preserved while copying the conference data between events, otherwise
924 …e calendar IDs call the calendarList.list method. If you want to access the primary calendar of th…
925 body: object, The request body. (required)
926 The object takes the form of:
929 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
930 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
933 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
935 "fileUrl": "A String", # URL link to the attachment.
936 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
949The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
950 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
953 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
955 "summary": "A String", # Title of the event.
956 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
957 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
958 # - the length of the ID must be between 5 and 1024 characters
959the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
960 # If you do not specify an ID, it will be automatically generated by the server.
961the icalUID and the id are not identical and only one of them should be supplied at event creation…
962 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
963 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
973 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
974 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
975the attendee is a resource. Can only be set when the attendee is added to the event for the first …
976 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
982 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
983 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
984The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
985 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
987 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
988 … are not allowed in this field; event start and end times are specified in the start and end field…
991the event was created. For example, a web page, an email message or any document identifiable by a…
992 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
993 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
1000 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
1015The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
1016 # A cancelled status represents two different states depending on the event type:
1017 … instance should no longer be presented to the user. Clients should store these events for the lif…
1018 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
1020the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
1021 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
1025the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
1034 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
1042 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
1043 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1044The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1045 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1047the event's representation. When retrieving an event, this may be due to a restriction specified b…
1048 "kind": "calendar#event", # Type of the resource ("calendar#event").
1049 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
1050 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
1051 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
1054the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
1056 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
1058 "method": "A String", # The method used by this reminder. Possible values are:
1060 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
1066 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1068 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
1069the time at which this event would start according to the recurrence data in the recurring event i…
1070 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1071The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1072 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1074 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
1075 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
1076 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
1077 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
1078 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1079The conference-related information, such as details of a Hangouts Meet conference. To create new c…
1081 # All of them must belong to the same conference.
1084 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
1085 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1087 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
1088 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1090 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
1091 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1093 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
1096 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
1099 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
1102 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
1109 "entryPointType": "A String", # The type of the conference entry point.
1115 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
1117 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
1118 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1119 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
1120 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1131 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
1132 "conferenceId": "A String", # The ID of the conference.
1136 # - "eventNamedHangout": the name of the Hangout.
1137 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
1138 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
1147 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
1148 "type": "A String", # The conference solution type.
1149 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
1150 # The possible values are:
1155 "requestId": "A String", # The client-generated unique ID for this request.
1156 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
1158 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
1166 # The possible values are:
1172 "signature": "A String", # The signature of the conference data.
1173 …ted on server side. Must be preserved while copying the conference data between events, otherwise
1181 …notifications about the creation of the new event. Note that some emails might still be sent even …
1182 …Whether API client performing operation supports event attachments. Optional. The default is False.
1183 …, Whether to send notifications about the creation of the new event. Note that some emails might s…
1187 …ld only be used for migration use cases (note that in most migration cases the import method shoul…
1188the API client. Version 0 assumes no conference data support and ignores conference data in the ev…
1189 …es: integer, The maximum number of attendees to include in the response. If there are more than th…
1192 An object of the form:
1195 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
1196 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
1199 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
1201 "fileUrl": "A String", # URL link to the attachment.
1202 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
1215The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
1216 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
1219 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
1221 "summary": "A String", # Title of the event.
1222 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
1223 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
1224 # - the length of the ID must be between 5 and 1024 characters
1225the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
1226 # If you do not specify an ID, it will be automatically generated by the server.
1227the icalUID and the id are not identical and only one of them should be supplied at event creation…
1228 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
1229 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
1239 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
1240 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
1241the attendee is a resource. Can only be set when the attendee is added to the event for the first …
1242 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
1248 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
1249 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1250The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1251 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1253 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1254 … are not allowed in this field; event start and end times are specified in the start and end field…
1257the event was created. For example, a web page, an email message or any document identifiable by a…
1258 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
1259 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
1266 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
1281The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
1282 # A cancelled status represents two different states depending on the event type:
1283 … instance should no longer be presented to the user. Clients should store these events for the lif…
1284 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
1286the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
1287 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
1291the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
1300 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
1308 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
1309 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1310The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1311 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1313the event's representation. When retrieving an event, this may be due to a restriction specified b…
1314 "kind": "calendar#event", # Type of the resource ("calendar#event").
1315 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
1316 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
1317 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
1320the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
1322 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
1324 "method": "A String", # The method used by this reminder. Possible values are:
1326 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
1332 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1334 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
1335the time at which this event would start according to the recurrence data in the recurring event i…
1336 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1337The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1338 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1340 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
1341 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
1342 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
1343 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
1344 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1345The conference-related information, such as details of a Hangouts Meet conference. To create new c…
1347 # All of them must belong to the same conference.
1350 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
1351 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1353 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
1354 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1356 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
1357 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1359 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
1362 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
1365 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
1368 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
1375 "entryPointType": "A String", # The type of the conference entry point.
1381 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
1383 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
1384 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1385 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
1386 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1397 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
1398 "conferenceId": "A String", # The ID of the conference.
1402 # - "eventNamedHangout": the name of the Hangout.
1403 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
1404 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
1413 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
1414 "type": "A String", # The conference solution type.
1415 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
1416 # The possible values are:
1421 "requestId": "A String", # The client-generated unique ID for this request.
1422 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
1424 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
1432 # The possible values are:
1438 "signature": "A String", # The signature of the conference data.
1439 …ted on server side. Must be preserved while copying the conference data between events, otherwise
1448 <pre>Returns instances of the specified recurring event.
1451 …e calendar IDs call the calendarList.list method. If you want to access the primary calendar of th…
1453 …timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The defau…
1454 …ls "cancelled") in the result. Cancelled instances of recurring events will still be included if s…
1455the email field for the organizer, creator and attendees, even if no real email is available (i.e.…
1457 …es: integer, The maximum number of attendees to include in the response. If there are more than th…
1458 …imum number of events returned on one result page. By default the value is 250 events. The page si…
1459 …timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The def…
1460 …timeZone: string, Time zone used in the response. Optional. The default is the time zone of the ca…
1461 originalStart: string, The original start time of the instance in the result. Optional.
1464 An object of the form:
1467 …"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no fu…
1468 "kind": "calendar#events", # Type of the collection ("calendar#events").
1469 …"defaultReminders": [ # The default reminders on the calendar for the authenticated user. These re…
1471 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
1473 "method": "A String", # The method used by this reminder. Possible values are:
1475 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
1481 "description": "A String", # Description of the calendar. Read-only.
1482 "items": [ # List of events on the calendar.
1484 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
1485 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
1488 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
1490 "fileUrl": "A String", # URL link to the attachment.
1491 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
1504The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
1505 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
1508 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
1510 "summary": "A String", # Title of the event.
1511 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
1512 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
1513 # - the length of the ID must be between 5 and 1024 characters
1514the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
1515 # If you do not specify an ID, it will be automatically generated by the server.
1516the icalUID and the id are not identical and only one of them should be supplied at event creation…
1517 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
1518 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
1528 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
1529 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
1530the attendee is a resource. Can only be set when the attendee is added to the event for the first …
1531 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
1537 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
1538 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1539The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1540 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1542 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1543 … are not allowed in this field; event start and end times are specified in the start and end field…
1546the event was created. For example, a web page, an email message or any document identifiable by a…
1547 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
1548 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1550 "etag": "A String", # ETag of the resource.
1551 "location": "A String", # Geographic location of the event as free-form text. Optional.
1552 …EventId": "A String", # For an instance of a recurring event, this is the id of the recurring even…
1555 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
1570The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
1571 # A cancelled status represents two different states depending on the event type:
1572 … instance should no longer be presented to the user. Clients should store these events for the lif…
1573 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
1575the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
1576 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
1580the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
1589 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
1597 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
1598 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1599The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1600 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1602the event's representation. When retrieving an event, this may be due to a restriction specified b…
1603 "kind": "calendar#event", # Type of the resource ("calendar#event").
1604 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
1605 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
1606 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
1609the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
1611 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
1613 "method": "A String", # The method used by this reminder. Possible values are:
1615 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
1621 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1623 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
1624the time at which this event would start according to the recurrence data in the recurring event i…
1625 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1626The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1627 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1629 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
1630 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
1631 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
1632 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
1633 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1634The conference-related information, such as details of a Hangouts Meet conference. To create new c…
1636 # All of them must belong to the same conference.
1639 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
1640 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1642 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
1643 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1645 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
1646 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1648 … "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
1651 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
1654 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
1657 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
1664 "entryPointType": "A String", # The type of the conference entry point.
1670 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
1672 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
1673 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1674 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
1675 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1686 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
1687 "conferenceId": "A String", # The ID of the conference.
1691 # - "eventNamedHangout": the name of the Hangout.
1692 … # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
1693 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
1702 … "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
1703 "type": "A String", # The conference solution type.
1704 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
1705 # The possible values are:
1710 "requestId": "A String", # The client-generated unique ID for this request.
1711 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
1713 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
1721 # The possible values are:
1727 "signature": "A String", # The signature of the conference data.
1728 …ted on server side. Must be preserved while copying the conference data between events, otherwise
1734 …"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-onl…
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 th…
1739 …"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values a…
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 …
1743 …# - "writer" - The user has read and write access to the calendar. Private events will appear to u…
1744 …# - "owner" - The user has ownership of the calendar. This role has all of the permissions of the
1750 <pre>Retrieves the next page of results.
1753 previous_request: The request for the previous page. (required)
1754 previous_response: The response from the request for the previous page. (required)
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.
1764 <pre>Returns events on the specified calendar.
1767 …e calendar IDs call the calendarList.list method. If you want to access the primary calendar of th…
1768 …orderBy: string, The order of the events returned in the result. Optional. The default is an unspe…
1770 …startTime - Order by the start date/time (ascending). This is only available when querying single …
1772 …nInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default …
1773 …timeMin: string, Lower bound (exclusive) for an event's end time to filter by. Optional. The defau…
1776 …nce this time will always be included regardless of showDeleted. Optional. The default is not to f…
1777 …ents and instances of recurring events, but not the underlying recurring events themselves. Option…
1778the email field for the organizer, creator and attendees, even if no real email is available (i.e.…
1779the result. Cancelled instances of recurring events (but not the underlying recurring event) will …
1781 …es: integer, The maximum number of attendees to include in the response. If there are more than th…
1782the nextSyncToken field returned on the last page of results from the previous list request. It ma…
1783 …ers that cannot be specified together with nextSyncToken to ensure consistency of the client state.
1793 - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and th…
1795 Optional. The default is to return all entries.
1796 …iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Option…
1797The number of events in the resulting page may be less than this value, or none at all, even if th…
1798 …timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The def…
1800 …timeZone: string, Time zone used in the response. Optional. The default is the time zone of the ca…
1803 An object of the form:
1806 …"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no fu…
1807 "kind": "calendar#events", # Type of the collection ("calendar#events").
1808 …"defaultReminders": [ # The default reminders on the calendar for the authenticated user. These re…
1810 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
1812 "method": "A String", # The method used by this reminder. Possible values are:
1814 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
1820 "description": "A String", # Description of the calendar. Read-only.
1821 "items": [ # List of events on the calendar.
1823 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
1824 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
1827 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
1829 "fileUrl": "A String", # URL link to the attachment.
1830 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
1843The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
1844 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
1847 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
1849 "summary": "A String", # Title of the event.
1850 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
1851 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
1852 # - the length of the ID must be between 5 and 1024 characters
1853the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
1854 # If you do not specify an ID, it will be automatically generated by the server.
1855the icalUID and the id are not identical and only one of them should be supplied at event creation…
1856 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
1857 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
1867 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
1868 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
1869the attendee is a resource. Can only be set when the attendee is added to the event for the first …
1870 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
1876 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
1877 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1878The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1879 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1881 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1882 … are not allowed in this field; event start and end times are specified in the start and end field…
1885the event was created. For example, a web page, an email message or any document identifiable by a…
1886 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
1887 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1889 "etag": "A String", # ETag of the resource.
1890 "location": "A String", # Geographic location of the event as free-form text. Optional.
1891 …EventId": "A String", # For an instance of a recurring event, this is the id of the recurring even…
1894 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
1909The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
1910 # A cancelled status represents two different states depending on the event type:
1911 … instance should no longer be presented to the user. Clients should store these events for the lif…
1912 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
1914the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
1915 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
1919the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
1928 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
1936 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
1937 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1938The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1939 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1941the event's representation. When retrieving an event, this may be due to a restriction specified b…
1942 "kind": "calendar#event", # Type of the resource ("calendar#event").
1943 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
1944 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
1945 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
1948the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
1950 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
1952 "method": "A String", # The method used by this reminder. Possible values are:
1954 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
1960 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1962 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
1963the time at which this event would start according to the recurrence data in the recurring event i…
1964 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1965The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
1966 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
1968 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
1969 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
1970 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
1971 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
1972 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1973The conference-related information, such as details of a Hangouts Meet conference. To create new c…
1975 # All of them must belong to the same conference.
1978 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
1979 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1981 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
1982 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1984 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
1985 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
1987 … "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
1990 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
1993 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
1996 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
2003 "entryPointType": "A String", # The type of the conference entry point.
2009 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
2011 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
2012 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2013 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
2014 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2025 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
2026 "conferenceId": "A String", # The ID of the conference.
2030 # - "eventNamedHangout": the name of the Hangout.
2031 … # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
2032 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
2041 … "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
2042 "type": "A String", # The conference solution type.
2043 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
2044 # The possible values are:
2049 "requestId": "A String", # The client-generated unique ID for this request.
2050 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
2052 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
2060 # The possible values are:
2066 "signature": "A String", # The signature of the conference data.
2067 …ted on server side. Must be preserved while copying the conference data between events, otherwise
2073 …"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-onl…
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 th…
2078 …"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values a…
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 …
2082 …# - "writer" - The user has read and write access to the calendar. Private events will appear to u…
2083 …# - "owner" - The user has ownership of the calendar. This role has all of the permissions of the
2089 <pre>Retrieves the next page of results.
2092 previous_request: The request for the previous page. (required)
2093 previous_response: The response from the request for the previous page. (required)
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.
2106 …calendarId: string, Calendar identifier of the source calendar where the event currently is on. (r…
2108 …destination: string, Calendar identifier of the target calendar where the event is to be moved to.…
2111 …ifications about the change of the event's organizer. Note that some emails might still be sent ev…
2112 …sendUpdates: string, Guests who should receive notifications about the change of the event's organ…
2116 …ld only be used for migration use cases (note that in most migration cases the import method shoul…
2119 An object of the form:
2122 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
2123 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
2126 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
2128 "fileUrl": "A String", # URL link to the attachment.
2129 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
2142The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
2143 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
2146 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
2148 "summary": "A String", # Title of the event.
2149 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
2150 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
2151 # - the length of the ID must be between 5 and 1024 characters
2152the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
2153 # If you do not specify an ID, it will be automatically generated by the server.
2154the icalUID and the id are not identical and only one of them should be supplied at event creation…
2155 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
2156 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
2166 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
2167 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
2168the attendee is a resource. Can only be set when the attendee is added to the event for the first …
2169 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
2175 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
2176 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
2177The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
2178 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
2180 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
2181 … are not allowed in this field; event start and end times are specified in the start and end field…
2184the event was created. For example, a web page, an email message or any document identifiable by a…
2185 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
2186 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
2193 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
2208The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
2209 # A cancelled status represents two different states depending on the event type:
2210 … instance should no longer be presented to the user. Clients should store these events for the lif…
2211 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
2213the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
2214 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
2218the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
2227 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
2235 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
2236 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
2237The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
2238 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
2240the event's representation. When retrieving an event, this may be due to a restriction specified b…
2241 "kind": "calendar#event", # Type of the resource ("calendar#event").
2242 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
2243 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
2244 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
2247the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
2249 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
2251 "method": "A String", # The method used by this reminder. Possible values are:
2253 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
2259 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
2261 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
2262the time at which this event would start according to the recurrence data in the recurring event i…
2263 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
2264The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
2265 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
2267 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
2268 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
2269 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
2270 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
2271 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
2272The conference-related information, such as details of a Hangouts Meet conference. To create new c…
2274 # All of them must belong to the same conference.
2277 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
2278 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2280 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
2281 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2283 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
2284 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2286 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
2289 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
2292 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
2295 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
2302 "entryPointType": "A String", # The type of the conference entry point.
2308 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
2310 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
2311 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2312 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
2313 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2324 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
2325 "conferenceId": "A String", # The ID of the conference.
2329 # - "eventNamedHangout": the name of the Hangout.
2330 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
2331 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
2340 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
2341 "type": "A String", # The conference solution type.
2342 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
2343 # The possible values are:
2348 "requestId": "A String", # The client-generated unique ID for this request.
2349 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
2351 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
2359 # The possible values are:
2365 "signature": "A String", # The signature of the conference data.
2366 …ted on server side. Must be preserved while copying the conference data between events, otherwise
2378 …e calendar IDs call the calendarList.list method. If you want to access the primary calendar of th…
2380 body: object, The request body. (required)
2381 The object takes the form of:
2384 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
2385 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
2388 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
2390 "fileUrl": "A String", # URL link to the attachment.
2391 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
2404The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
2405 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
2408 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
2410 "summary": "A String", # Title of the event.
2411 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
2412 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
2413 # - the length of the ID must be between 5 and 1024 characters
2414the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
2415 # If you do not specify an ID, it will be automatically generated by the server.
2416the icalUID and the id are not identical and only one of them should be supplied at event creation…
2417 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
2418 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
2428 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
2429 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
2430the attendee is a resource. Can only be set when the attendee is added to the event for the first …
2431 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
2437 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
2438 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
2439The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
2440 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
2442 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
2443 … are not allowed in this field; event start and end times are specified in the start and end field…
2446the event was created. For example, a web page, an email message or any document identifiable by a…
2447 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
2448 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
2455 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
2470The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
2471 # A cancelled status represents two different states depending on the event type:
2472 … instance should no longer be presented to the user. Clients should store these events for the lif…
2473 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
2475the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
2476 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
2480the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
2489 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
2497 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
2498 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
2499The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
2500 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
2502the event's representation. When retrieving an event, this may be due to a restriction specified b…
2503 "kind": "calendar#event", # Type of the resource ("calendar#event").
2504 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
2505 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
2506 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
2509the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
2511 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
2513 "method": "A String", # The method used by this reminder. Possible values are:
2515 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
2521 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
2523 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
2524the time at which this event would start according to the recurrence data in the recurring event i…
2525 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
2526The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
2527 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
2529 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
2530 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
2531 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
2532 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
2533 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
2534The conference-related information, such as details of a Hangouts Meet conference. To create new c…
2536 # All of them must belong to the same conference.
2539 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
2540 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2542 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
2543 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2545 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
2546 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2548 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
2551 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
2554 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
2557 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
2564 "entryPointType": "A String", # The type of the conference entry point.
2570 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
2572 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
2573 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2574 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
2575 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2586 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
2587 "conferenceId": "A String", # The ID of the conference.
2591 # - "eventNamedHangout": the name of the Hangout.
2592 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
2593 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
2602 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
2603 "type": "A String", # The conference solution type.
2604 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
2605 # The possible values are:
2610 "requestId": "A String", # The client-generated unique ID for this request.
2611 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
2613 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
2621 # The possible values are:
2627 "signature": "A String", # The signature of the conference data.
2628 …ted on server side. Must be preserved while copying the conference data between events, otherwise
2636 …about the event update (for example, description changes, etc.). Note that some emails might still…
2637the email field for the organizer, creator and attendees, even if no real email is available (i.e.…
2638 …Whether API client performing operation supports event attachments. Optional. The default is False.
2639 …es: integer, The maximum number of attendees to include in the response. If there are more than th…
2640the API client. Version 0 assumes no conference data support and ignores conference data in the ev…
2641 …sendUpdates: string, Guests who should receive notifications about the event update (for example, …
2645 …ld only be used for migration use cases (note that in most migration cases the import method shoul…
2648 An object of the form:
2651 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
2652 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
2655 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
2657 "fileUrl": "A String", # URL link to the attachment.
2658 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
2671The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
2672 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
2675 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
2677 "summary": "A String", # Title of the event.
2678 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
2679 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
2680 # - the length of the ID must be between 5 and 1024 characters
2681the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
2682 # If you do not specify an ID, it will be automatically generated by the server.
2683the icalUID and the id are not identical and only one of them should be supplied at event creation…
2684 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
2685 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
2695 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
2696 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
2697the attendee is a resource. Can only be set when the attendee is added to the event for the first …
2698 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
2704 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
2705 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
2706The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
2707 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
2709 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
2710 … are not allowed in this field; event start and end times are specified in the start and end field…
2713the event was created. For example, a web page, an email message or any document identifiable by a…
2714 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
2715 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
2722 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
2737The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
2738 # A cancelled status represents two different states depending on the event type:
2739 … instance should no longer be presented to the user. Clients should store these events for the lif…
2740 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
2742the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
2743 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
2747the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
2756 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
2764 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
2765 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
2766The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
2767 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
2769the event's representation. When retrieving an event, this may be due to a restriction specified b…
2770 "kind": "calendar#event", # Type of the resource ("calendar#event").
2771 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
2772 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
2773 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
2776the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
2778 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
2780 "method": "A String", # The method used by this reminder. Possible values are:
2782 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
2788 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
2790 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
2791the time at which this event would start according to the recurrence data in the recurring event i…
2792 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
2793The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
2794 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
2796 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
2797 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
2798 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
2799 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
2800 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
2801The conference-related information, such as details of a Hangouts Meet conference. To create new c…
2803 # All of them must belong to the same conference.
2806 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
2807 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2809 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
2810 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2812 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
2813 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2815 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
2818 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
2821 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
2824 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
2831 "entryPointType": "A String", # The type of the conference entry point.
2837 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
2839 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
2840 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2841 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
2842 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
2853 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
2854 "conferenceId": "A String", # The ID of the conference.
2858 # - "eventNamedHangout": the name of the Hangout.
2859 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
2860 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
2869 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
2870 "type": "A String", # The conference solution type.
2871 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
2872 # The possible values are:
2877 "requestId": "A String", # The client-generated unique ID for this request.
2878 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
2880 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
2888 # The possible values are:
2894 "signature": "A String", # The signature of the conference data.
2895 …ted on server side. Must be preserved while copying the conference data between events, otherwise
2907 …e calendar IDs call the calendarList.list method. If you want to access the primary calendar of th…
2908 text: string, The text describing the event to be created. (required)
2911 …d notifications about the creation of the event. Note that some emails might still be sent even if…
2912 sendUpdates: string, Guests who should receive notifications about the creation of the new event.
2916 …ld only be used for migration use cases (note that in most migration cases the import method shoul…
2919 An object of the form:
2922 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
2923 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
2926 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
2928 "fileUrl": "A String", # URL link to the attachment.
2929 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
2942The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
2943 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
2946 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
2948 "summary": "A String", # Title of the event.
2949 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
2950 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
2951 # - the length of the ID must be between 5 and 1024 characters
2952the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
2953 # If you do not specify an ID, it will be automatically generated by the server.
2954the icalUID and the id are not identical and only one of them should be supplied at event creation…
2955 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
2956 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
2966 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
2967 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
2968the attendee is a resource. Can only be set when the attendee is added to the event for the first …
2969 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
2975 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
2976 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
2977The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
2978 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
2980 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
2981 … are not allowed in this field; event start and end times are specified in the start and end field…
2984the event was created. For example, a web page, an email message or any document identifiable by a…
2985 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
2986 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
2993 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
3008The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
3009 # A cancelled status represents two different states depending on the event type:
3010 … instance should no longer be presented to the user. Clients should store these events for the lif…
3011 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
3013the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
3014 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
3018the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
3027 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
3035 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
3036 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
3037The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
3038 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
3040the event's representation. When retrieving an event, this may be due to a restriction specified b…
3041 "kind": "calendar#event", # Type of the resource ("calendar#event").
3042 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
3043 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
3044 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
3047the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
3049 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
3051 "method": "A String", # The method used by this reminder. Possible values are:
3053 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
3059 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
3061 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
3062the time at which this event would start according to the recurrence data in the recurring event i…
3063 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
3064The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
3065 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
3067 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
3068 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
3069 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
3070 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
3071 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
3072The conference-related information, such as details of a Hangouts Meet conference. To create new c…
3074 # All of them must belong to the same conference.
3077 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
3078 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3080 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
3081 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3083 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
3084 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3086 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
3089 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
3092 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
3095 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
3102 "entryPointType": "A String", # The type of the conference entry point.
3108 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
3110 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
3111 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3112 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
3113 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3124 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
3125 "conferenceId": "A String", # The ID of the conference.
3129 # - "eventNamedHangout": the name of the Hangout.
3130 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
3131 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
3140 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
3141 "type": "A String", # The conference solution type.
3142 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
3143 # The possible values are:
3148 "requestId": "A String", # The client-generated unique ID for this request.
3149 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
3151 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
3159 # The possible values are:
3165 "signature": "A String", # The signature of the conference data.
3166 …ted on server side. Must be preserved while copying the conference data between events, otherwise
3178 …e calendar IDs call the calendarList.list method. If you want to access the primary calendar of th…
3180 body: object, The request body. (required)
3181 The object takes the form of:
3184 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
3185 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
3188 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
3190 "fileUrl": "A String", # URL link to the attachment.
3191 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
3204The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
3205 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
3208 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
3210 "summary": "A String", # Title of the event.
3211 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
3212 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
3213 # - the length of the ID must be between 5 and 1024 characters
3214the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
3215 # If you do not specify an ID, it will be automatically generated by the server.
3216the icalUID and the id are not identical and only one of them should be supplied at event creation…
3217 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
3218 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
3228 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
3229 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
3230the attendee is a resource. Can only be set when the attendee is added to the event for the first …
3231 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
3237 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
3238 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
3239The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
3240 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
3242 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
3243 … are not allowed in this field; event start and end times are specified in the start and end field…
3246the event was created. For example, a web page, an email message or any document identifiable by a…
3247 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
3248 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
3255 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
3270The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
3271 # A cancelled status represents two different states depending on the event type:
3272 … instance should no longer be presented to the user. Clients should store these events for the lif…
3273 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
3275the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
3276 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
3280the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
3289 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
3297 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
3298 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
3299The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
3300 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
3302the event's representation. When retrieving an event, this may be due to a restriction specified b…
3303 "kind": "calendar#event", # Type of the resource ("calendar#event").
3304 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
3305 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
3306 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
3309the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
3311 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
3313 "method": "A String", # The method used by this reminder. Possible values are:
3315 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
3321 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
3323 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
3324the time at which this event would start according to the recurrence data in the recurring event i…
3325 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
3326The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
3327 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
3329 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
3330 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
3331 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
3332 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
3333 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
3334The conference-related information, such as details of a Hangouts Meet conference. To create new c…
3336 # All of them must belong to the same conference.
3339 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
3340 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3342 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
3343 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3345 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
3346 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3348 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
3351 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
3354 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
3357 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
3364 "entryPointType": "A String", # The type of the conference entry point.
3370 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
3372 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
3373 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3374 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
3375 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3386 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
3387 "conferenceId": "A String", # The ID of the conference.
3391 # - "eventNamedHangout": the name of the Hangout.
3392 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
3393 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
3402 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
3403 "type": "A String", # The conference solution type.
3404 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
3405 # The possible values are:
3410 "requestId": "A String", # The client-generated unique ID for this request.
3411 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
3413 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
3421 # The possible values are:
3427 "signature": "A String", # The signature of the conference data.
3428 …ted on server side. Must be preserved while copying the conference data between events, otherwise
3436 …about the event update (for example, description changes, etc.). Note that some emails might still…
3437the email field for the organizer, creator and attendees, even if no real email is available (i.e.…
3438 …Whether API client performing operation supports event attachments. Optional. The default is False.
3439 …es: integer, The maximum number of attendees to include in the response. If there are more than th…
3440the API client. Version 0 assumes no conference data support and ignores conference data in the ev…
3441 …sendUpdates: string, Guests who should receive notifications about the event update (for example, …
3445 …ld only be used for migration use cases (note that in most migration cases the import method shoul…
3448 An object of the form:
3451 …"attachments": [ # File attachments for the event. Currently only Google Drive attachments are sup…
3452 … # In order to modify attachments the supportsAttachments request parameter should be set to true.
3455 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
3457 "fileUrl": "A String", # URL link to the attachment.
3458 …dding Google Drive file attachments use the same format as in alternateLink property of the Files …
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 AP…
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 a…
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
3471The organizer of the event. If the organizer is also an attendee, this is indicated with a separat…
3472 …"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event…
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 addre…
3475 …"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in th…
3477 "summary": "A String", # Title of the event.
3478 …"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, …
3479 …# - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v …
3480 # - the length of the ID must be between 5 and 1024 characters
3481the ID must be unique per calendar Due to the globally distributed nature of the system, we canno…
3482 # If you do not specify an ID, it will be automatically generated by the server.
3483the icalUID and the id are not identical and only one of them should be supplied at event creation…
3484 …"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. R…
3485 …"attendees": [ # The attendees of the event. See the Events with attendees guide for more informat…
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 …": false, # Whether this entry represents the calendar on which this copy of the event appears. Re…
3495 …"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the
3496 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
3497the attendee is a resource. Can only be set when the attendee is added to the event for the first …
3498 …"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The d…
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…
3504 …"start": { # The (inclusive) start time of the event. For a recurring event, this is the start tim…
3505 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
3506The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
3507 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
3509 … "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
3510 … are not allowed in this field; event start and end times are specified in the start and end field…
3513the event was created. For example, a web page, an email message or any document identifiable by a…
3514 …"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTP…
3515 … "title": "A String", # Title of the source; for example a title of a web page or an email subject.
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 recu…
3522 "a_key": "A String", # The preference name and corresponding value.
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. Optio…
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.
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.
3537The event is cancelled (deleted). The list method returns cancelled events only on incremental syn…
3538 # A cancelled status represents two different states depending on the event type:
3539 … instance should no longer be presented to the user. Clients should store these events for the lif…
3540 …ns are only guaranteed to have values for the id, recurringEventId and originalStartTime fields po…
3542the id field populated. On the organizer's calendar, cancelled events continue to expose event d…
3543 …example via the move operation) and the original organizer is not on the attendee list, it will le…
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 …vents accross calendaring systems and must be supplied when importing events via the import method.
3547the icalUID and the id are not identical and only one of them should be supplied at event creation…
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.
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.
3556 …Whether the end time is actually unspecified. An end time is still provided for compatibility reas…
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 …tsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional.
3564 …"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of t…
3565 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
3566The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
3567 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
3569the event's representation. When retrieving an event, this may be due to a restriction specified b…
3570 "kind": "calendar#event", # Type of the resource ("calendar#event").
3571 …re no changes can be made to the main event fields "summary", "description", "location", "start", …
3572 … # Whether anyone can invite themselves to the event (currently works for Google+ events only). Op…
3573 …Id": "A String", # The color of the event. This is an ID referring to an entry in the event sectio…
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.
3576the event doesn't use the default reminders, this lists the reminders specific to the event, or, i…
3578 …"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.…
3580 "method": "A String", # The method used by this reminder. Possible values are:
3582 …# - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders usi…
3588 … "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
3590 …sts": true, # Whether attendees other than the organizer can see who the event's attendees are. Op…
3591the time at which this event would start according to the recurrence data in the recurring event i…
3592 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
3593The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. …
3594 …"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339)…
3596 …eOthers": true, # Whether attendees other than the organizer can invite others to the event. Optio…
3597 …"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible valu…
3598 … "opaque" - Default value. The event does block time on the calendar. This is equivalent to settin…
3599 …# - "transparent" - The event does not block time on the calendar. This is equivalent to setting S…
3600 …ges are not shared with other copies on other calendars. Optional. Immutable. The default is False.
3601The conference-related information, such as details of a Hangouts Meet conference. To create new c…
3603 # All of them must belong to the same conference.
3606 …"password": "A String", # The password to access the conference. The maximum length is 128 charact…
3607 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3609 …"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 …
3610 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3612 … "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
3613 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3615 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
3618 …# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel…
3621 …of the entry point, such as being toll or toll-free. One entry point can have multiple features. H…
3624 …"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum len…
3631 "entryPointType": "A String", # The type of the conference entry point.
3637 …"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this pho…
3639 …"passcode": "A String", # The passcode to access the conference. The maximum length is 128 charact…
3640 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3641 …"accessCode": "A String", # The access code to access the conference. The maximum length is 128 ch…
3642 …only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the termin…
3653 …notes (such as instructions from the domain administrator, legal notices) to display to the user. …
3654 "conferenceId": "A String", # The ID of the conference.
3658 # - "eventNamedHangout": the name of the Hangout.
3659 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional.
3660 …w conference and attach it to the event. The data is generated asynchronously. To see whether the
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.
3669 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Hangouts Meet.
3670 "type": "A String", # The conference solution type.
3671 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
3672 # The possible values are:
3677 "requestId": "A String", # The client-generated unique ID for this request.
3678 …ate this ID for every new request. If an ID provided is the same as for the previous request, the
3680 "conferenceSolution": { # The conference solution, such as Hangouts or Hangouts Meet.
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 …encounters an unfamiliar or empty type, it should still be able to display the entry points. Howev…
3688 # The possible values are:
3694 "signature": "A String", # The signature of the conference data.
3695 …ted on server side. Must be preserved while copying the conference data between events, otherwise
3707 …e calendar IDs call the calendarList.list method. If you want to access the primary calendar of th…
3708 body: object, The request body. (required)
3709 The object takes the form of:
3712 "resourceUri": "A String", # A version-specific identifier for the watched resource.
3713 … as a notification channel used to watch for changes to a resource. Value: the fixed string "api#c…
3714 …"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channe…
3716 …"token": "A String", # An arbitrary string delivered to the target address with each notification …
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.
3726 …orderBy: string, The order of the events returned in the result. Optional. The default is an unspe…
3728 …startTime - Order by the start date/time (ascending). This is only available when querying single …
3730 …nInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default …
3731 …timeMin: string, Lower bound (exclusive) for an event's end time to filter by. Optional. The defau…
3734 …nce this time will always be included regardless of showDeleted. Optional. The default is not to f…
3735 …ents and instances of recurring events, but not the underlying recurring events themselves. Option…
3736the email field for the organizer, creator and attendees, even if no real email is available (i.e.…
3737the result. Cancelled instances of recurring events (but not the underlying recurring event) will …
3739 …es: integer, The maximum number of attendees to include in the response. If there are more than th…
3740the nextSyncToken field returned on the last page of results from the previous list request. It ma…
3741 …ers that cannot be specified together with nextSyncToken to ensure consistency of the client state.
3751 - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and th…
3753 Optional. The default is to return all entries.
3754 …iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Option…
3755The number of events in the resulting page may be less than this value, or none at all, even if th…
3756 …timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The def…
3758 …timeZone: string, Time zone used in the response. Optional. The default is the time zone of the ca…
3761 An object of the form:
3764 "resourceUri": "A String", # A version-specific identifier for the watched resource.
3765 … as a notification channel used to watch for changes to a resource. Value: the fixed string "api#c…
3766 …"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channe…
3768 …"token": "A String", # An arbitrary string delivered to the target address with each notification …
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.