blob: f1dd5d3e4e4b248a6cc79c3be749a6fbcee602b6 [file] [log] [blame]
Yoshi Automation Botb6971b02020-11-26 17:16:03 -08001{
2 "id": "calendar:v3",
3 "documentationLink": "https://developers.google.com/google-apps/calendar/firstapp",
4 "resources": {
5 "calendarList": {
6 "methods": {
7 "update": {
8 "parameterOrder": [
9 "calendarId"
10 ],
11 "httpMethod": "PUT",
12 "response": {
13 "$ref": "CalendarListEntry"
14 },
15 "scopes": [
16 "https://www.googleapis.com/auth/calendar"
17 ],
18 "path": "users/me/calendarList/{calendarId}",
19 "description": "Updates an existing calendar on the user's calendar list.",
20 "parameters": {
21 "calendarId": {
22 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
23 "location": "path",
24 "type": "string",
25 "required": true
26 },
27 "colorRgbFormat": {
28 "type": "boolean",
29 "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.",
30 "location": "query"
31 }
32 },
33 "request": {
34 "$ref": "CalendarListEntry"
35 },
36 "id": "calendar.calendarList.update"
37 },
38 "insert": {
39 "response": {
40 "$ref": "CalendarListEntry"
41 },
42 "description": "Inserts an existing calendar into the user's calendar list.",
43 "path": "users/me/calendarList",
44 "scopes": [
45 "https://www.googleapis.com/auth/calendar"
46 ],
47 "httpMethod": "POST",
48 "id": "calendar.calendarList.insert",
49 "request": {
50 "$ref": "CalendarListEntry"
51 },
52 "parameters": {
53 "colorRgbFormat": {
54 "type": "boolean",
55 "location": "query",
56 "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False."
57 }
58 }
59 },
60 "get": {
61 "parameterOrder": [
62 "calendarId"
63 ],
64 "description": "Returns a calendar from the user's calendar list.",
65 "response": {
66 "$ref": "CalendarListEntry"
67 },
68 "parameters": {
69 "calendarId": {
70 "location": "path",
71 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
72 "required": true,
73 "type": "string"
74 }
75 },
76 "httpMethod": "GET",
77 "path": "users/me/calendarList/{calendarId}",
78 "id": "calendar.calendarList.get",
79 "scopes": [
80 "https://www.googleapis.com/auth/calendar",
81 "https://www.googleapis.com/auth/calendar.readonly"
82 ]
83 },
84 "list": {
85 "response": {
86 "$ref": "CalendarList"
87 },
88 "description": "Returns the calendars on the user's calendar list.",
89 "path": "users/me/calendarList",
90 "scopes": [
91 "https://www.googleapis.com/auth/calendar",
92 "https://www.googleapis.com/auth/calendar.readonly"
93 ],
94 "httpMethod": "GET",
95 "supportsSubscription": true,
96 "parameters": {
97 "syncToken": {
98 "type": "string",
99 "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
100 "location": "query"
101 },
102 "showDeleted": {
103 "location": "query",
104 "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False.",
105 "type": "boolean"
106 },
107 "showHidden": {
108 "location": "query",
109 "description": "Whether to show hidden entries. Optional. The default is False.",
110 "type": "boolean"
111 },
112 "minAccessRole": {
113 "location": "query",
114 "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
115 "enum": [
116 "freeBusyReader",
117 "owner",
118 "reader",
119 "writer"
120 ],
121 "type": "string",
122 "enumDescriptions": [
123 "The user can read free/busy information.",
124 "The user can read and modify events and access control lists.",
125 "The user can read events that are not private.",
126 "The user can read and modify events."
127 ]
128 },
129 "maxResults": {
130 "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
131 "type": "integer",
132 "minimum": "1",
133 "location": "query",
134 "format": "int32"
135 },
136 "pageToken": {
137 "location": "query",
138 "description": "Token specifying which result page to return. Optional.",
139 "type": "string"
140 }
141 },
142 "id": "calendar.calendarList.list"
143 },
144 "watch": {
145 "response": {
146 "$ref": "Channel"
147 },
148 "httpMethod": "POST",
149 "path": "users/me/calendarList/watch",
150 "parameters": {
151 "maxResults": {
152 "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
153 "location": "query",
154 "format": "int32",
155 "type": "integer",
156 "minimum": "1"
157 },
158 "pageToken": {
159 "type": "string",
160 "location": "query",
161 "description": "Token specifying which result page to return. Optional."
162 },
163 "showHidden": {
164 "type": "boolean",
165 "location": "query",
166 "description": "Whether to show hidden entries. Optional. The default is False."
167 },
168 "showDeleted": {
169 "location": "query",
170 "type": "boolean",
171 "description": "Whether to include deleted calendar list entries in the result. Optional. The default is False."
172 },
173 "minAccessRole": {
174 "type": "string",
175 "enum": [
176 "freeBusyReader",
177 "owner",
178 "reader",
179 "writer"
180 ],
181 "description": "The minimum access role for the user in the returned entries. Optional. The default is no restriction.",
182 "location": "query",
183 "enumDescriptions": [
184 "The user can read free/busy information.",
185 "The user can read and modify events and access control lists.",
186 "The user can read events that are not private.",
187 "The user can read and modify events."
188 ]
189 },
190 "syncToken": {
191 "location": "query",
192 "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
193 "type": "string"
194 }
195 },
196 "description": "Watch for changes to CalendarList resources.",
197 "supportsSubscription": true,
198 "scopes": [
199 "https://www.googleapis.com/auth/calendar",
200 "https://www.googleapis.com/auth/calendar.readonly"
201 ],
202 "id": "calendar.calendarList.watch",
203 "request": {
204 "$ref": "Channel",
205 "parameterName": "resource"
206 }
207 },
208 "patch": {
209 "parameters": {
210 "calendarId": {
211 "required": true,
212 "type": "string",
213 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
214 "location": "path"
215 },
216 "colorRgbFormat": {
217 "type": "boolean",
218 "description": "Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.",
219 "location": "query"
220 }
221 },
222 "scopes": [
223 "https://www.googleapis.com/auth/calendar"
224 ],
225 "id": "calendar.calendarList.patch",
226 "parameterOrder": [
227 "calendarId"
228 ],
229 "response": {
230 "$ref": "CalendarListEntry"
231 },
232 "path": "users/me/calendarList/{calendarId}",
233 "description": "Updates an existing calendar on the user's calendar list. This method supports patch semantics.",
234 "request": {
235 "$ref": "CalendarListEntry"
236 },
237 "httpMethod": "PATCH"
238 },
239 "delete": {
240 "description": "Removes a calendar from the user's calendar list.",
241 "id": "calendar.calendarList.delete",
242 "httpMethod": "DELETE",
243 "parameters": {
244 "calendarId": {
245 "required": true,
246 "location": "path",
247 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
248 "type": "string"
249 }
250 },
251 "parameterOrder": [
252 "calendarId"
253 ],
254 "path": "users/me/calendarList/{calendarId}",
255 "scopes": [
256 "https://www.googleapis.com/auth/calendar"
257 ]
258 }
259 }
260 },
261 "events": {
262 "methods": {
263 "import": {
264 "parameterOrder": [
265 "calendarId"
266 ],
267 "scopes": [
268 "https://www.googleapis.com/auth/calendar",
269 "https://www.googleapis.com/auth/calendar.events"
270 ],
271 "path": "calendars/{calendarId}/events/import",
272 "request": {
273 "$ref": "Event"
274 },
275 "httpMethod": "POST",
276 "response": {
277 "$ref": "Event"
278 },
279 "id": "calendar.events.import",
280 "description": "Imports an event. This operation is used to add a private copy of an existing event to a calendar.",
281 "parameters": {
282 "supportsAttachments": {
283 "type": "boolean",
284 "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
285 "location": "query"
286 },
287 "conferenceDataVersion": {
288 "minimum": "0",
289 "location": "query",
290 "type": "integer",
291 "description": "Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.",
292 "format": "int32",
293 "maximum": "1"
294 },
295 "calendarId": {
296 "type": "string",
297 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
298 "location": "path",
299 "required": true
300 }
301 }
302 },
303 "patch": {
304 "path": "calendars/{calendarId}/events/{eventId}",
305 "request": {
306 "$ref": "Event"
307 },
308 "id": "calendar.events.patch",
309 "parameters": {
310 "sendUpdates": {
311 "type": "string",
312 "enum": [
313 "all",
314 "externalOnly",
315 "none"
316 ],
317 "enumDescriptions": [
318 "Notifications are sent to all guests.",
319 "Notifications are sent to non-Google Calendar guests only.",
320 "No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
321 ],
322 "description": "Guests who should receive notifications about the event update (for example, title changes, etc.).",
323 "location": "query"
324 },
325 "eventId": {
326 "description": "Event identifier.",
327 "required": true,
328 "type": "string",
329 "location": "path"
330 },
331 "maxAttendees": {
332 "location": "query",
333 "format": "int32",
334 "minimum": "1",
335 "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
336 "type": "integer"
337 },
338 "calendarId": {
339 "location": "path",
340 "required": true,
341 "type": "string",
342 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword."
343 },
344 "sendNotifications": {
345 "type": "boolean",
346 "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.",
347 "location": "query"
348 },
349 "supportsAttachments": {
350 "type": "boolean",
351 "location": "query",
352 "description": "Whether API client performing operation supports event attachments. Optional. The default is False."
353 },
354 "alwaysIncludeEmail": {
355 "description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
356 "location": "query",
357 "type": "boolean"
358 },
359 "conferenceDataVersion": {
360 "description": "Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.",
361 "minimum": "0",
362 "maximum": "1",
363 "format": "int32",
364 "type": "integer",
365 "location": "query"
366 }
367 },
368 "httpMethod": "PATCH",
369 "description": "Updates an event. This method supports patch semantics.",
370 "scopes": [
371 "https://www.googleapis.com/auth/calendar",
372 "https://www.googleapis.com/auth/calendar.events"
373 ],
374 "response": {
375 "$ref": "Event"
376 },
377 "parameterOrder": [
378 "calendarId",
379 "eventId"
380 ]
381 },
382 "move": {
383 "parameterOrder": [
384 "calendarId",
385 "eventId",
386 "destination"
387 ],
388 "response": {
389 "$ref": "Event"
390 },
391 "parameters": {
392 "destination": {
393 "required": true,
394 "type": "string",
395 "description": "Calendar identifier of the target calendar where the event is to be moved to.",
396 "location": "query"
397 },
398 "sendUpdates": {
399 "enumDescriptions": [
400 "Notifications are sent to all guests.",
401 "Notifications are sent to non-Google Calendar guests only.",
402 "No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
403 ],
404 "location": "query",
405 "description": "Guests who should receive notifications about the change of the event's organizer.",
406 "type": "string",
407 "enum": [
408 "all",
409 "externalOnly",
410 "none"
411 ]
412 },
413 "calendarId": {
414 "location": "path",
415 "required": true,
416 "description": "Calendar identifier of the source calendar where the event currently is on.",
417 "type": "string"
418 },
419 "eventId": {
420 "location": "path",
421 "type": "string",
422 "description": "Event identifier.",
423 "required": true
424 },
425 "sendNotifications": {
426 "type": "boolean",
427 "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.",
428 "location": "query"
429 }
430 },
431 "path": "calendars/{calendarId}/events/{eventId}/move",
432 "description": "Moves an event to another calendar, i.e. changes an event's organizer.",
433 "id": "calendar.events.move",
434 "scopes": [
435 "https://www.googleapis.com/auth/calendar",
436 "https://www.googleapis.com/auth/calendar.events"
437 ],
438 "httpMethod": "POST"
439 },
440 "delete": {
441 "description": "Deletes an event.",
442 "id": "calendar.events.delete",
443 "parameters": {
444 "eventId": {
445 "required": true,
446 "location": "path",
447 "description": "Event identifier.",
448 "type": "string"
449 },
450 "sendNotifications": {
451 "location": "query",
452 "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.",
453 "type": "boolean"
454 },
455 "calendarId": {
456 "required": true,
457 "location": "path",
458 "type": "string",
459 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword."
460 },
461 "sendUpdates": {
462 "enum": [
463 "all",
464 "externalOnly",
465 "none"
466 ],
467 "type": "string",
468 "description": "Guests who should receive notifications about the deletion of the event.",
469 "location": "query",
470 "enumDescriptions": [
471 "Notifications are sent to all guests.",
472 "Notifications are sent to non-Google Calendar guests only.",
473 "No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
474 ]
475 }
476 },
477 "scopes": [
478 "https://www.googleapis.com/auth/calendar",
479 "https://www.googleapis.com/auth/calendar.events"
480 ],
481 "path": "calendars/{calendarId}/events/{eventId}",
482 "parameterOrder": [
483 "calendarId",
484 "eventId"
485 ],
486 "httpMethod": "DELETE"
487 },
488 "instances": {
489 "httpMethod": "GET",
490 "response": {
491 "$ref": "Events"
492 },
493 "supportsSubscription": true,
494 "id": "calendar.events.instances",
495 "path": "calendars/{calendarId}/events/{eventId}/instances",
496 "scopes": [
497 "https://www.googleapis.com/auth/calendar",
498 "https://www.googleapis.com/auth/calendar.events",
499 "https://www.googleapis.com/auth/calendar.events.readonly",
500 "https://www.googleapis.com/auth/calendar.readonly"
501 ],
502 "description": "Returns instances of the specified recurring event.",
503 "parameterOrder": [
504 "calendarId",
505 "eventId"
506 ],
507 "parameters": {
508 "maxAttendees": {
509 "format": "int32",
510 "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
511 "type": "integer",
512 "minimum": "1",
513 "location": "query"
514 },
515 "timeMax": {
516 "location": "query",
517 "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.",
518 "type": "string",
519 "format": "date-time"
520 },
521 "timeMin": {
522 "format": "date-time",
523 "location": "query",
524 "type": "string",
525 "description": "Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset."
526 },
527 "alwaysIncludeEmail": {
528 "type": "boolean",
529 "description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
530 "location": "query"
531 },
532 "calendarId": {
533 "type": "string",
534 "location": "path",
535 "required": true,
536 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword."
537 },
538 "showDeleted": {
539 "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.",
540 "type": "boolean",
541 "location": "query"
542 },
543 "maxResults": {
544 "location": "query",
545 "type": "integer",
546 "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
547 "minimum": "1",
548 "format": "int32"
549 },
550 "eventId": {
551 "required": true,
552 "location": "path",
553 "description": "Recurring event identifier.",
554 "type": "string"
555 },
556 "timeZone": {
557 "type": "string",
558 "location": "query",
559 "description": "Time zone used in the response. Optional. The default is the time zone of the calendar."
560 },
561 "pageToken": {
562 "description": "Token specifying which result page to return. Optional.",
563 "location": "query",
564 "type": "string"
565 },
566 "originalStart": {
567 "type": "string",
568 "location": "query",
569 "description": "The original start time of the instance in the result. Optional."
570 }
571 }
572 },
573 "insert": {
574 "parameters": {
575 "calendarId": {
576 "type": "string",
577 "location": "path",
578 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
579 "required": true
580 },
581 "maxAttendees": {
582 "location": "query",
583 "type": "integer",
584 "format": "int32",
585 "minimum": "1",
586 "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional."
587 },
588 "conferenceDataVersion": {
589 "description": "Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.",
590 "type": "integer",
591 "maximum": "1",
592 "format": "int32",
593 "minimum": "0",
594 "location": "query"
595 },
596 "sendNotifications": {
597 "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.",
598 "type": "boolean",
599 "location": "query"
600 },
601 "supportsAttachments": {
602 "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
603 "location": "query",
604 "type": "boolean"
605 },
606 "sendUpdates": {
607 "description": "Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.",
608 "enumDescriptions": [
609 "Notifications are sent to all guests.",
610 "Notifications are sent to non-Google Calendar guests only.",
611 "No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
612 ],
613 "enum": [
614 "all",
615 "externalOnly",
616 "none"
617 ],
618 "location": "query",
619 "type": "string"
620 }
621 },
622 "description": "Creates an event.",
623 "path": "calendars/{calendarId}/events",
624 "scopes": [
625 "https://www.googleapis.com/auth/calendar",
626 "https://www.googleapis.com/auth/calendar.events"
627 ],
628 "parameterOrder": [
629 "calendarId"
630 ],
631 "httpMethod": "POST",
632 "response": {
633 "$ref": "Event"
634 },
635 "id": "calendar.events.insert",
636 "request": {
637 "$ref": "Event"
638 }
639 },
640 "update": {
641 "httpMethod": "PUT",
642 "response": {
643 "$ref": "Event"
644 },
645 "path": "calendars/{calendarId}/events/{eventId}",
646 "parameters": {
647 "alwaysIncludeEmail": {
648 "location": "query",
649 "type": "boolean",
650 "description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided)."
651 },
652 "maxAttendees": {
653 "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
654 "location": "query",
655 "format": "int32",
656 "minimum": "1",
657 "type": "integer"
658 },
659 "sendNotifications": {
660 "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.",
661 "location": "query",
662 "type": "boolean"
663 },
664 "supportsAttachments": {
665 "description": "Whether API client performing operation supports event attachments. Optional. The default is False.",
666 "type": "boolean",
667 "location": "query"
668 },
669 "sendUpdates": {
670 "type": "string",
671 "enum": [
672 "all",
673 "externalOnly",
674 "none"
675 ],
676 "description": "Guests who should receive notifications about the event update (for example, title changes, etc.).",
677 "enumDescriptions": [
678 "Notifications are sent to all guests.",
679 "Notifications are sent to non-Google Calendar guests only.",
680 "No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
681 ],
682 "location": "query"
683 },
684 "calendarId": {
685 "required": true,
686 "type": "string",
687 "location": "path",
688 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword."
689 },
690 "eventId": {
691 "type": "string",
692 "location": "path",
693 "description": "Event identifier.",
694 "required": true
695 },
696 "conferenceDataVersion": {
697 "location": "query",
698 "minimum": "0",
699 "description": "Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.",
700 "type": "integer",
701 "format": "int32",
702 "maximum": "1"
703 }
704 },
705 "scopes": [
706 "https://www.googleapis.com/auth/calendar",
707 "https://www.googleapis.com/auth/calendar.events"
708 ],
709 "id": "calendar.events.update",
710 "request": {
711 "$ref": "Event"
712 },
713 "description": "Updates an event.",
714 "parameterOrder": [
715 "calendarId",
716 "eventId"
717 ]
718 },
719 "quickAdd": {
720 "id": "calendar.events.quickAdd",
721 "parameterOrder": [
722 "calendarId",
723 "text"
724 ],
725 "parameters": {
726 "text": {
727 "description": "The text describing the event to be created.",
728 "location": "query",
729 "required": true,
730 "type": "string"
731 },
732 "sendNotifications": {
733 "type": "boolean",
734 "description": "Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.",
735 "location": "query"
736 },
737 "calendarId": {
738 "type": "string",
739 "location": "path",
740 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
741 "required": true
742 },
743 "sendUpdates": {
744 "enumDescriptions": [
745 "Notifications are sent to all guests.",
746 "Notifications are sent to non-Google Calendar guests only.",
747 "No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
748 ],
749 "enum": [
750 "all",
751 "externalOnly",
752 "none"
753 ],
754 "description": "Guests who should receive notifications about the creation of the new event.",
755 "type": "string",
756 "location": "query"
757 }
758 },
759 "path": "calendars/{calendarId}/events/quickAdd",
760 "response": {
761 "$ref": "Event"
762 },
763 "httpMethod": "POST",
764 "scopes": [
765 "https://www.googleapis.com/auth/calendar",
766 "https://www.googleapis.com/auth/calendar.events"
767 ],
768 "description": "Creates an event based on a simple text string."
769 },
770 "list": {
771 "path": "calendars/{calendarId}/events",
772 "httpMethod": "GET",
773 "description": "Returns events on the specified calendar.",
774 "parameters": {
775 "timeMax": {
776 "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.",
777 "location": "query",
778 "format": "date-time",
779 "type": "string"
780 },
781 "q": {
782 "type": "string",
783 "description": "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
784 "location": "query"
785 },
786 "calendarId": {
787 "location": "path",
788 "required": true,
789 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
790 "type": "string"
791 },
792 "orderBy": {
793 "enum": [
794 "startTime",
795 "updated"
796 ],
797 "location": "query",
798 "enumDescriptions": [
799 "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)",
800 "Order by last modification time (ascending)."
801 ],
802 "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
803 "type": "string"
804 },
805 "showHiddenInvitations": {
806 "description": "Whether to include hidden invitations in the result. Optional. The default is False.",
807 "type": "boolean",
808 "location": "query"
809 },
810 "maxResults": {
811 "type": "integer",
812 "default": "250",
813 "description": "Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
814 "minimum": "1",
815 "format": "int32",
816 "location": "query"
817 },
818 "timeMin": {
819 "format": "date-time",
820 "description": "Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.",
821 "type": "string",
822 "location": "query"
823 },
824 "maxAttendees": {
825 "format": "int32",
826 "location": "query",
827 "type": "integer",
828 "minimum": "1",
829 "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional."
830 },
831 "sharedExtendedProperty": {
832 "type": "string",
833 "description": "Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.",
834 "repeated": true,
835 "location": "query"
836 },
837 "iCalUID": {
838 "description": "Specifies event ID in the iCalendar format to be included in the response. Optional.",
839 "location": "query",
840 "type": "string"
841 },
842 "singleEvents": {
843 "location": "query",
844 "description": "Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.",
845 "type": "boolean"
846 },
847 "alwaysIncludeEmail": {
848 "description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
849 "location": "query",
850 "type": "boolean"
851 },
852 "timeZone": {
853 "location": "query",
854 "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
855 "type": "string"
856 },
857 "syncToken": {
858 "type": "string",
859 "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
860 "location": "query"
861 },
862 "updatedMin": {
863 "type": "string",
864 "location": "query",
865 "format": "date-time",
866 "description": "Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time."
867 },
868 "privateExtendedProperty": {
869 "description": "Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.",
870 "location": "query",
871 "repeated": true,
872 "type": "string"
873 },
874 "showDeleted": {
875 "type": "boolean",
876 "location": "query",
877 "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False."
878 },
879 "pageToken": {
880 "location": "query",
881 "type": "string",
882 "description": "Token specifying which result page to return. Optional."
883 }
884 },
885 "response": {
886 "$ref": "Events"
887 },
888 "supportsSubscription": true,
889 "id": "calendar.events.list",
890 "parameterOrder": [
891 "calendarId"
892 ],
893 "scopes": [
894 "https://www.googleapis.com/auth/calendar",
895 "https://www.googleapis.com/auth/calendar.events",
896 "https://www.googleapis.com/auth/calendar.events.readonly",
897 "https://www.googleapis.com/auth/calendar.readonly"
898 ]
899 },
900 "get": {
901 "parameters": {
902 "timeZone": {
903 "type": "string",
904 "description": "Time zone used in the response. Optional. The default is the time zone of the calendar.",
905 "location": "query"
906 },
907 "calendarId": {
908 "location": "path",
909 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
910 "required": true,
911 "type": "string"
912 },
913 "eventId": {
914 "location": "path",
915 "description": "Event identifier.",
916 "type": "string",
917 "required": true
918 },
919 "alwaysIncludeEmail": {
920 "description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
921 "type": "boolean",
922 "location": "query"
923 },
924 "maxAttendees": {
925 "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
926 "format": "int32",
927 "type": "integer",
928 "minimum": "1",
929 "location": "query"
930 }
931 },
932 "parameterOrder": [
933 "calendarId",
934 "eventId"
935 ],
936 "path": "calendars/{calendarId}/events/{eventId}",
937 "scopes": [
938 "https://www.googleapis.com/auth/calendar",
939 "https://www.googleapis.com/auth/calendar.events",
940 "https://www.googleapis.com/auth/calendar.events.readonly",
941 "https://www.googleapis.com/auth/calendar.readonly"
942 ],
943 "description": "Returns an event.",
944 "response": {
945 "$ref": "Event"
946 },
947 "httpMethod": "GET",
948 "id": "calendar.events.get"
949 },
950 "watch": {
951 "request": {
952 "parameterName": "resource",
953 "$ref": "Channel"
954 },
955 "parameterOrder": [
956 "calendarId"
957 ],
958 "description": "Watch for changes to Events resources.",
959 "response": {
960 "$ref": "Channel"
961 },
962 "id": "calendar.events.watch",
963 "httpMethod": "POST",
964 "parameters": {
965 "sharedExtendedProperty": {
966 "repeated": true,
967 "description": "Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.",
968 "location": "query",
969 "type": "string"
970 },
971 "pageToken": {
972 "description": "Token specifying which result page to return. Optional.",
973 "location": "query",
974 "type": "string"
975 },
976 "maxAttendees": {
977 "location": "query",
978 "type": "integer",
979 "format": "int32",
980 "minimum": "1",
981 "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional."
982 },
983 "timeMin": {
984 "location": "query",
985 "format": "date-time",
986 "description": "Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.",
987 "type": "string"
988 },
989 "showHiddenInvitations": {
990 "description": "Whether to include hidden invitations in the result. Optional. The default is False.",
991 "location": "query",
992 "type": "boolean"
993 },
994 "q": {
995 "location": "query",
996 "description": "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
997 "type": "string"
998 },
999 "updatedMin": {
1000 "location": "query",
1001 "type": "string",
1002 "description": "Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.",
1003 "format": "date-time"
1004 },
1005 "singleEvents": {
1006 "description": "Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.",
1007 "location": "query",
1008 "type": "boolean"
1009 },
1010 "alwaysIncludeEmail": {
1011 "type": "boolean",
1012 "description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
1013 "location": "query"
1014 },
1015 "iCalUID": {
1016 "type": "string",
1017 "description": "Specifies event ID in the iCalendar format to be included in the response. Optional.",
1018 "location": "query"
1019 },
1020 "syncToken": {
1021 "location": "query",
1022 "type": "string",
1023 "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries."
1024 },
1025 "timeZone": {
1026 "type": "string",
1027 "location": "query",
1028 "description": "Time zone used in the response. Optional. The default is the time zone of the calendar."
1029 },
1030 "privateExtendedProperty": {
1031 "repeated": true,
1032 "location": "query",
1033 "type": "string",
1034 "description": "Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints."
1035 },
1036 "timeMax": {
1037 "location": "query",
1038 "type": "string",
1039 "format": "date-time",
1040 "description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin."
1041 },
1042 "showDeleted": {
1043 "description": "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.",
1044 "type": "boolean",
1045 "location": "query"
1046 },
1047 "orderBy": {
1048 "type": "string",
1049 "enum": [
1050 "startTime",
1051 "updated"
1052 ],
1053 "description": "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
1054 "location": "query",
1055 "enumDescriptions": [
1056 "Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)",
1057 "Order by last modification time (ascending)."
1058 ]
1059 },
1060 "maxResults": {
1061 "default": "250",
1062 "location": "query",
1063 "format": "int32",
1064 "type": "integer",
1065 "description": "Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
1066 "minimum": "1"
1067 },
1068 "calendarId": {
1069 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1070 "type": "string",
1071 "location": "path",
1072 "required": true
1073 }
1074 },
1075 "path": "calendars/{calendarId}/events/watch",
1076 "scopes": [
1077 "https://www.googleapis.com/auth/calendar",
1078 "https://www.googleapis.com/auth/calendar.events",
1079 "https://www.googleapis.com/auth/calendar.events.readonly",
1080 "https://www.googleapis.com/auth/calendar.readonly"
1081 ],
1082 "supportsSubscription": true
1083 }
1084 }
1085 },
1086 "freebusy": {
1087 "methods": {
1088 "query": {
1089 "path": "freeBusy",
1090 "request": {
1091 "$ref": "FreeBusyRequest"
1092 },
1093 "scopes": [
1094 "https://www.googleapis.com/auth/calendar",
1095 "https://www.googleapis.com/auth/calendar.readonly"
1096 ],
1097 "description": "Returns free/busy information for a set of calendars.",
1098 "httpMethod": "POST",
1099 "id": "calendar.freebusy.query",
1100 "response": {
1101 "$ref": "FreeBusyResponse"
1102 }
1103 }
1104 }
1105 },
1106 "settings": {
1107 "methods": {
1108 "list": {
1109 "response": {
1110 "$ref": "Settings"
1111 },
1112 "scopes": [
1113 "https://www.googleapis.com/auth/calendar",
1114 "https://www.googleapis.com/auth/calendar.readonly",
1115 "https://www.googleapis.com/auth/calendar.settings.readonly"
1116 ],
1117 "path": "users/me/settings",
1118 "description": "Returns all user settings for the authenticated user.",
1119 "parameters": {
1120 "syncToken": {
1121 "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
1122 "location": "query",
1123 "type": "string"
1124 },
1125 "pageToken": {
1126 "location": "query",
1127 "description": "Token specifying which result page to return. Optional.",
1128 "type": "string"
1129 },
1130 "maxResults": {
1131 "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
1132 "format": "int32",
1133 "location": "query",
1134 "minimum": "1",
1135 "type": "integer"
1136 }
1137 },
1138 "supportsSubscription": true,
1139 "id": "calendar.settings.list",
1140 "httpMethod": "GET"
1141 },
1142 "watch": {
1143 "parameters": {
1144 "syncToken": {
1145 "location": "query",
1146 "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
1147 "type": "string"
1148 },
1149 "maxResults": {
1150 "type": "integer",
1151 "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
1152 "minimum": "1",
1153 "location": "query",
1154 "format": "int32"
1155 },
1156 "pageToken": {
1157 "description": "Token specifying which result page to return. Optional.",
1158 "type": "string",
1159 "location": "query"
1160 }
1161 },
1162 "description": "Watch for changes to Settings resources.",
1163 "httpMethod": "POST",
1164 "request": {
1165 "$ref": "Channel",
1166 "parameterName": "resource"
1167 },
1168 "supportsSubscription": true,
1169 "id": "calendar.settings.watch",
1170 "scopes": [
1171 "https://www.googleapis.com/auth/calendar",
1172 "https://www.googleapis.com/auth/calendar.readonly",
1173 "https://www.googleapis.com/auth/calendar.settings.readonly"
1174 ],
1175 "response": {
1176 "$ref": "Channel"
1177 },
1178 "path": "users/me/settings/watch"
1179 },
1180 "get": {
1181 "parameterOrder": [
1182 "setting"
1183 ],
1184 "httpMethod": "GET",
1185 "id": "calendar.settings.get",
1186 "description": "Returns a single user setting.",
1187 "path": "users/me/settings/{setting}",
1188 "scopes": [
1189 "https://www.googleapis.com/auth/calendar",
1190 "https://www.googleapis.com/auth/calendar.readonly",
1191 "https://www.googleapis.com/auth/calendar.settings.readonly"
1192 ],
1193 "parameters": {
1194 "setting": {
1195 "description": "The id of the user setting.",
1196 "type": "string",
1197 "required": true,
1198 "location": "path"
1199 }
1200 },
1201 "response": {
1202 "$ref": "Setting"
1203 }
1204 }
1205 }
1206 },
1207 "colors": {
1208 "methods": {
1209 "get": {
1210 "response": {
1211 "$ref": "Colors"
1212 },
1213 "scopes": [
1214 "https://www.googleapis.com/auth/calendar",
1215 "https://www.googleapis.com/auth/calendar.readonly"
1216 ],
1217 "path": "colors",
1218 "description": "Returns the color definitions for calendars and events.",
1219 "httpMethod": "GET",
1220 "id": "calendar.colors.get"
1221 }
1222 }
1223 },
1224 "calendars": {
1225 "methods": {
1226 "clear": {
1227 "parameterOrder": [
1228 "calendarId"
1229 ],
1230 "id": "calendar.calendars.clear",
1231 "httpMethod": "POST",
1232 "description": "Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.",
1233 "path": "calendars/{calendarId}/clear",
1234 "scopes": [
1235 "https://www.googleapis.com/auth/calendar"
1236 ],
1237 "parameters": {
1238 "calendarId": {
1239 "required": true,
1240 "type": "string",
1241 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1242 "location": "path"
1243 }
1244 }
1245 },
1246 "insert": {
1247 "request": {
1248 "$ref": "Calendar"
1249 },
1250 "httpMethod": "POST",
1251 "path": "calendars",
1252 "response": {
1253 "$ref": "Calendar"
1254 },
1255 "description": "Creates a secondary calendar.",
1256 "id": "calendar.calendars.insert",
1257 "scopes": [
1258 "https://www.googleapis.com/auth/calendar"
1259 ]
1260 },
1261 "update": {
1262 "response": {
1263 "$ref": "Calendar"
1264 },
1265 "id": "calendar.calendars.update",
1266 "scopes": [
1267 "https://www.googleapis.com/auth/calendar"
1268 ],
1269 "path": "calendars/{calendarId}",
1270 "parameterOrder": [
1271 "calendarId"
1272 ],
1273 "description": "Updates metadata for a calendar.",
1274 "httpMethod": "PUT",
1275 "parameters": {
1276 "calendarId": {
1277 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1278 "required": true,
1279 "location": "path",
1280 "type": "string"
1281 }
1282 },
1283 "request": {
1284 "$ref": "Calendar"
1285 }
1286 },
1287 "get": {
1288 "scopes": [
1289 "https://www.googleapis.com/auth/calendar",
1290 "https://www.googleapis.com/auth/calendar.readonly"
1291 ],
1292 "id": "calendar.calendars.get",
1293 "httpMethod": "GET",
1294 "response": {
1295 "$ref": "Calendar"
1296 },
1297 "description": "Returns metadata for a calendar.",
1298 "path": "calendars/{calendarId}",
1299 "parameterOrder": [
1300 "calendarId"
1301 ],
1302 "parameters": {
1303 "calendarId": {
1304 "type": "string",
1305 "required": true,
1306 "location": "path",
1307 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword."
1308 }
1309 }
1310 },
1311 "patch": {
1312 "scopes": [
1313 "https://www.googleapis.com/auth/calendar"
1314 ],
1315 "parameters": {
1316 "calendarId": {
1317 "type": "string",
1318 "location": "path",
1319 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1320 "required": true
1321 }
1322 },
1323 "request": {
1324 "$ref": "Calendar"
1325 },
1326 "path": "calendars/{calendarId}",
1327 "response": {
1328 "$ref": "Calendar"
1329 },
1330 "description": "Updates metadata for a calendar. This method supports patch semantics.",
1331 "httpMethod": "PATCH",
1332 "parameterOrder": [
1333 "calendarId"
1334 ],
1335 "id": "calendar.calendars.patch"
1336 },
1337 "delete": {
1338 "description": "Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.",
1339 "scopes": [
1340 "https://www.googleapis.com/auth/calendar"
1341 ],
1342 "id": "calendar.calendars.delete",
1343 "path": "calendars/{calendarId}",
1344 "parameters": {
1345 "calendarId": {
1346 "type": "string",
1347 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1348 "required": true,
1349 "location": "path"
1350 }
1351 },
1352 "parameterOrder": [
1353 "calendarId"
1354 ],
1355 "httpMethod": "DELETE"
1356 }
1357 }
1358 },
1359 "acl": {
1360 "methods": {
1361 "list": {
1362 "response": {
1363 "$ref": "Acl"
1364 },
1365 "httpMethod": "GET",
1366 "parameterOrder": [
1367 "calendarId"
1368 ],
1369 "scopes": [
1370 "https://www.googleapis.com/auth/calendar"
1371 ],
1372 "parameters": {
1373 "calendarId": {
1374 "type": "string",
1375 "location": "path",
1376 "required": true,
1377 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword."
1378 },
1379 "pageToken": {
1380 "type": "string",
1381 "description": "Token specifying which result page to return. Optional.",
1382 "location": "query"
1383 },
1384 "syncToken": {
1385 "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
1386 "type": "string",
1387 "location": "query"
1388 },
1389 "showDeleted": {
1390 "description": "Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.",
1391 "location": "query",
1392 "type": "boolean"
1393 },
1394 "maxResults": {
1395 "type": "integer",
1396 "minimum": "1",
1397 "format": "int32",
1398 "location": "query",
1399 "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional."
1400 }
1401 },
1402 "supportsSubscription": true,
1403 "id": "calendar.acl.list",
1404 "description": "Returns the rules in the access control list for the calendar.",
1405 "path": "calendars/{calendarId}/acl"
1406 },
1407 "update": {
1408 "response": {
1409 "$ref": "AclRule"
1410 },
1411 "id": "calendar.acl.update",
1412 "parameterOrder": [
1413 "calendarId",
1414 "ruleId"
1415 ],
1416 "description": "Updates an access control rule.",
1417 "httpMethod": "PUT",
1418 "path": "calendars/{calendarId}/acl/{ruleId}",
1419 "request": {
1420 "$ref": "AclRule"
1421 },
1422 "parameters": {
1423 "sendNotifications": {
1424 "location": "query",
1425 "description": "Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.",
1426 "type": "boolean"
1427 },
1428 "ruleId": {
1429 "required": true,
1430 "location": "path",
1431 "description": "ACL rule identifier.",
1432 "type": "string"
1433 },
1434 "calendarId": {
1435 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1436 "location": "path",
1437 "required": true,
1438 "type": "string"
1439 }
1440 },
1441 "scopes": [
1442 "https://www.googleapis.com/auth/calendar"
1443 ]
1444 },
1445 "delete": {
1446 "id": "calendar.acl.delete",
1447 "scopes": [
1448 "https://www.googleapis.com/auth/calendar"
1449 ],
1450 "description": "Deletes an access control rule.",
1451 "parameterOrder": [
1452 "calendarId",
1453 "ruleId"
1454 ],
1455 "path": "calendars/{calendarId}/acl/{ruleId}",
1456 "parameters": {
1457 "ruleId": {
1458 "description": "ACL rule identifier.",
1459 "location": "path",
1460 "required": true,
1461 "type": "string"
1462 },
1463 "calendarId": {
1464 "required": true,
1465 "type": "string",
1466 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1467 "location": "path"
1468 }
1469 },
1470 "httpMethod": "DELETE"
1471 },
1472 "watch": {
1473 "description": "Watch for changes to ACL resources.",
1474 "request": {
1475 "parameterName": "resource",
1476 "$ref": "Channel"
1477 },
1478 "response": {
1479 "$ref": "Channel"
1480 },
1481 "httpMethod": "POST",
1482 "parameters": {
1483 "syncToken": {
1484 "location": "query",
1485 "description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.",
1486 "type": "string"
1487 },
1488 "pageToken": {
1489 "type": "string",
1490 "description": "Token specifying which result page to return. Optional.",
1491 "location": "query"
1492 },
1493 "showDeleted": {
1494 "type": "boolean",
1495 "location": "query",
1496 "description": "Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False."
1497 },
1498 "maxResults": {
1499 "description": "Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.",
1500 "minimum": "1",
1501 "format": "int32",
1502 "type": "integer",
1503 "location": "query"
1504 },
1505 "calendarId": {
1506 "location": "path",
1507 "required": true,
1508 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1509 "type": "string"
1510 }
1511 },
1512 "parameterOrder": [
1513 "calendarId"
1514 ],
1515 "scopes": [
1516 "https://www.googleapis.com/auth/calendar"
1517 ],
1518 "path": "calendars/{calendarId}/acl/watch",
1519 "supportsSubscription": true,
1520 "id": "calendar.acl.watch"
1521 },
1522 "get": {
1523 "path": "calendars/{calendarId}/acl/{ruleId}",
1524 "scopes": [
1525 "https://www.googleapis.com/auth/calendar",
1526 "https://www.googleapis.com/auth/calendar.readonly"
1527 ],
1528 "httpMethod": "GET",
1529 "parameters": {
1530 "ruleId": {
1531 "description": "ACL rule identifier.",
1532 "required": true,
1533 "type": "string",
1534 "location": "path"
1535 },
1536 "calendarId": {
1537 "required": true,
1538 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1539 "type": "string",
1540 "location": "path"
1541 }
1542 },
1543 "id": "calendar.acl.get",
1544 "parameterOrder": [
1545 "calendarId",
1546 "ruleId"
1547 ],
1548 "description": "Returns an access control rule.",
1549 "response": {
1550 "$ref": "AclRule"
1551 }
1552 },
1553 "insert": {
1554 "response": {
1555 "$ref": "AclRule"
1556 },
1557 "path": "calendars/{calendarId}/acl",
1558 "scopes": [
1559 "https://www.googleapis.com/auth/calendar"
1560 ],
1561 "httpMethod": "POST",
1562 "parameterOrder": [
1563 "calendarId"
1564 ],
1565 "description": "Creates an access control rule.",
1566 "id": "calendar.acl.insert",
1567 "request": {
1568 "$ref": "AclRule"
1569 },
1570 "parameters": {
1571 "calendarId": {
1572 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1573 "required": true,
1574 "location": "path",
1575 "type": "string"
1576 },
1577 "sendNotifications": {
1578 "type": "boolean",
1579 "location": "query",
1580 "description": "Whether to send notifications about the calendar sharing change. Optional. The default is True."
1581 }
1582 }
1583 },
1584 "patch": {
1585 "response": {
1586 "$ref": "AclRule"
1587 },
1588 "description": "Updates an access control rule. This method supports patch semantics.",
1589 "id": "calendar.acl.patch",
1590 "parameterOrder": [
1591 "calendarId",
1592 "ruleId"
1593 ],
1594 "parameters": {
1595 "calendarId": {
1596 "location": "path",
1597 "description": "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
1598 "required": true,
1599 "type": "string"
1600 },
1601 "sendNotifications": {
1602 "location": "query",
1603 "description": "Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.",
1604 "type": "boolean"
1605 },
1606 "ruleId": {
1607 "type": "string",
1608 "description": "ACL rule identifier.",
1609 "location": "path",
1610 "required": true
1611 }
1612 },
1613 "request": {
1614 "$ref": "AclRule"
1615 },
1616 "scopes": [
1617 "https://www.googleapis.com/auth/calendar"
1618 ],
1619 "httpMethod": "PATCH",
1620 "path": "calendars/{calendarId}/acl/{ruleId}"
1621 }
1622 }
1623 },
1624 "channels": {
1625 "methods": {
1626 "stop": {
1627 "path": "channels/stop",
1628 "httpMethod": "POST",
1629 "request": {
1630 "parameterName": "resource",
1631 "$ref": "Channel"
1632 },
1633 "id": "calendar.channels.stop",
1634 "scopes": [
1635 "https://www.googleapis.com/auth/calendar",
1636 "https://www.googleapis.com/auth/calendar.events",
1637 "https://www.googleapis.com/auth/calendar.events.readonly",
1638 "https://www.googleapis.com/auth/calendar.readonly",
1639 "https://www.googleapis.com/auth/calendar.settings.readonly"
1640 ],
1641 "description": "Stop watching resources through this channel"
1642 }
1643 }
1644 }
1645 },
1646 "basePath": "/calendar/v3/",
1647 "version": "v3",
1648 "revision": "20201028",
1649 "batchPath": "batch/calendar/v3",
1650 "auth": {
1651 "oauth2": {
1652 "scopes": {
1653 "https://www.googleapis.com/auth/calendar": {
1654 "description": "See, edit, share, and permanently delete all the calendars you can access using Google Calendar"
1655 },
1656 "https://www.googleapis.com/auth/calendar.settings.readonly": {
1657 "description": "View your Calendar settings"
1658 },
1659 "https://www.googleapis.com/auth/calendar.events": {
1660 "description": "View and edit events on all your calendars"
1661 },
1662 "https://www.googleapis.com/auth/calendar.readonly": {
1663 "description": "View your calendars"
1664 },
1665 "https://www.googleapis.com/auth/calendar.events.readonly": {
1666 "description": "View events on all your calendars"
1667 }
1668 }
1669 }
1670 },
1671 "protocol": "rest",
1672 "ownerDomain": "google.com",
1673 "kind": "discovery#restDescription",
1674 "discoveryVersion": "v1",
1675 "name": "calendar",
1676 "description": "Manipulates events and other calendar data.",
1677 "icons": {
1678 "x16": "http://fonts.gstatic.com/s/i/productlogos/calendar_2020q4/v8/web-16dp/logo_calendar_2020q4_color_1x_web_16dp.png",
1679 "x32": "http://fonts.gstatic.com/s/i/productlogos/calendar_2020q4/v8/web-32dp/logo_calendar_2020q4_color_1x_web_32dp.png"
1680 },
1681 "servicePath": "calendar/v3/",
1682 "title": "Calendar API",
1683 "baseUrl": "https://www.googleapis.com/calendar/v3/",
1684 "schemas": {
1685 "ConferenceParameters": {
1686 "type": "object",
1687 "properties": {
1688 "addOnParameters": {
1689 "description": "Additional add-on specific data.",
1690 "$ref": "ConferenceParametersAddOnParameters"
1691 }
1692 },
1693 "id": "ConferenceParameters"
1694 },
1695 "Acl": {
1696 "type": "object",
1697 "properties": {
1698 "nextSyncToken": {
1699 "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.",
1700 "type": "string"
1701 },
1702 "etag": {
1703 "type": "string",
1704 "description": "ETag of the collection."
1705 },
1706 "items": {
1707 "items": {
1708 "$ref": "AclRule"
1709 },
1710 "description": "List of rules on the access control list.",
1711 "type": "array"
1712 },
1713 "nextPageToken": {
1714 "type": "string",
1715 "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided."
1716 },
1717 "kind": {
1718 "description": "Type of the collection (\"calendar#acl\").",
1719 "type": "string",
1720 "default": "calendar#acl"
1721 }
1722 },
1723 "id": "Acl"
1724 },
1725 "TimePeriod": {
1726 "type": "object",
1727 "properties": {
1728 "start": {
1729 "type": "string",
1730 "format": "date-time",
1731 "description": "The (inclusive) start of the time period."
1732 },
1733 "end": {
1734 "type": "string",
1735 "description": "The (exclusive) end of the time period.",
1736 "format": "date-time"
1737 }
1738 },
1739 "id": "TimePeriod"
1740 },
1741 "AclRule": {
1742 "type": "object",
1743 "id": "AclRule",
1744 "properties": {
1745 "kind": {
1746 "description": "Type of the resource (\"calendar#aclRule\").",
1747 "default": "calendar#aclRule",
1748 "type": "string"
1749 },
1750 "role": {
1751 "description": "The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.",
1752 "type": "string",
1753 "annotations": {
1754 "required": [
1755 "calendar.acl.insert"
1756 ]
1757 }
1758 },
1759 "id": {
1760 "type": "string",
1761 "description": "Identifier of the ACL rule."
1762 },
1763 "scope": {
1764 "type": "object",
1765 "annotations": {
1766 "required": [
1767 "calendar.acl.insert",
1768 "calendar.acl.update"
1769 ]
1770 },
1771 "properties": {
1772 "type": {
1773 "description": "The type of the scope. Possible values are: \n- \"default\" - The public scope. This is the default value. \n- \"user\" - Limits the scope to a single user. \n- \"group\" - Limits the scope to a group. \n- \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not.",
1774 "annotations": {
1775 "required": [
1776 "calendar.acl.insert",
1777 "calendar.acl.update"
1778 ]
1779 },
1780 "type": "string"
1781 },
1782 "value": {
1783 "type": "string",
1784 "description": "The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"default\"."
1785 }
1786 },
1787 "description": "The scope of the rule."
1788 },
1789 "etag": {
1790 "description": "ETag of the resource.",
1791 "type": "string"
1792 }
1793 }
1794 },
1795 "Calendar": {
1796 "properties": {
1797 "summary": {
1798 "annotations": {
1799 "required": [
1800 "calendar.calendars.insert"
1801 ]
1802 },
1803 "description": "Title of the calendar.",
1804 "type": "string"
1805 },
1806 "description": {
1807 "description": "Description of the calendar. Optional.",
1808 "type": "string"
1809 },
1810 "location": {
1811 "description": "Geographic location of the calendar as free-form text. Optional.",
1812 "type": "string"
1813 },
1814 "timeZone": {
1815 "description": "The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional.",
1816 "type": "string"
1817 },
1818 "id": {
1819 "type": "string",
1820 "description": "Identifier of the calendar. To retrieve IDs call the calendarList.list() method."
1821 },
1822 "conferenceProperties": {
1823 "$ref": "ConferenceProperties",
1824 "description": "Conferencing properties for this calendar, for example what types of conferences are allowed."
1825 },
1826 "etag": {
1827 "type": "string",
1828 "description": "ETag of the resource."
1829 },
1830 "kind": {
1831 "default": "calendar#calendar",
1832 "type": "string",
1833 "description": "Type of the resource (\"calendar#calendar\")."
1834 }
1835 },
1836 "type": "object",
1837 "id": "Calendar"
1838 },
1839 "ConferenceRequestStatus": {
1840 "type": "object",
1841 "id": "ConferenceRequestStatus",
1842 "properties": {
1843 "statusCode": {
1844 "type": "string",
1845 "description": "The current status of the conference create request. Read-only.\nThe possible values are: \n- \"pending\": the conference create request is still being processed.\n- \"success\": the conference create request succeeded, the entry points are populated.\n- \"failure\": the conference create request failed, there are no entry points."
1846 }
1847 }
1848 },
1849 "Events": {
1850 "properties": {
1851 "accessRole": {
1852 "description": "The user's access role for this calendar. Read-only. Possible values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\" - The user has read access to free/busy information. \n- \"reader\" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.",
1853 "type": "string"
1854 },
1855 "nextPageToken": {
1856 "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.",
1857 "type": "string"
1858 },
1859 "description": {
1860 "type": "string",
1861 "description": "Description of the calendar. Read-only."
1862 },
1863 "nextSyncToken": {
1864 "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.",
1865 "type": "string"
1866 },
1867 "defaultReminders": {
1868 "description": "The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).",
1869 "items": {
1870 "$ref": "EventReminder"
1871 },
1872 "type": "array"
1873 },
1874 "updated": {
1875 "format": "date-time",
1876 "type": "string",
1877 "description": "Last modification time of the calendar (as a RFC3339 timestamp). Read-only."
1878 },
1879 "items": {
1880 "items": {
1881 "$ref": "Event"
1882 },
1883 "description": "List of events on the calendar.",
1884 "type": "array"
1885 },
1886 "kind": {
1887 "description": "Type of the collection (\"calendar#events\").",
1888 "type": "string",
1889 "default": "calendar#events"
1890 },
1891 "timeZone": {
1892 "description": "The time zone of the calendar. Read-only.",
1893 "type": "string"
1894 },
1895 "summary": {
1896 "description": "Title of the calendar. Read-only.",
1897 "type": "string"
1898 },
1899 "etag": {
1900 "type": "string",
1901 "description": "ETag of the collection."
1902 }
1903 },
1904 "id": "Events",
1905 "type": "object"
1906 },
1907 "ConferenceSolutionKey": {
1908 "id": "ConferenceSolutionKey",
1909 "properties": {
1910 "type": {
1911 "type": "string",
1912 "description": "The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (http://hangouts.google.com)\n- \"eventNamedHangout\" for classic Hangouts for Google Workspace users (http://hangouts.google.com)\n- \"hangoutsMeet\" for Google Meet (http://meet.google.com)\n- \"addOn\" for 3P conference providers"
1913 }
1914 },
1915 "type": "object"
1916 },
1917 "EventAttendee": {
1918 "type": "object",
1919 "properties": {
1920 "self": {
1921 "description": "Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.",
1922 "type": "boolean",
1923 "default": "false"
1924 },
1925 "responseStatus": {
1926 "description": "The attendee's response status. Possible values are: \n- \"needsAction\" - The attendee has not responded to the invitation. \n- \"declined\" - The attendee has declined the invitation. \n- \"tentative\" - The attendee has tentatively accepted the invitation. \n- \"accepted\" - The attendee has accepted the invitation.",
1927 "type": "string"
1928 },
1929 "displayName": {
1930 "type": "string",
1931 "description": "The attendee's name, if available. Optional."
1932 },
1933 "resource": {
1934 "description": "Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.",
1935 "default": "false",
1936 "type": "boolean"
1937 },
1938 "optional": {
1939 "description": "Whether this is an optional attendee. Optional. The default is False.",
1940 "default": "false",
1941 "type": "boolean"
1942 },
1943 "id": {
1944 "type": "string",
1945 "description": "The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API"
1946 },
1947 "comment": {
1948 "type": "string",
1949 "description": "The attendee's response comment. Optional."
1950 },
1951 "additionalGuests": {
1952 "format": "int32",
1953 "default": "0",
1954 "description": "Number of additional guests. Optional. The default is 0.",
1955 "type": "integer"
1956 },
1957 "organizer": {
1958 "type": "boolean",
1959 "description": "Whether the attendee is the organizer of the event. Read-only. The default is False."
1960 },
1961 "email": {
1962 "description": "The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.\nRequired when adding an attendee.",
1963 "type": "string"
1964 }
1965 },
1966 "id": "EventAttendee"
1967 },
1968 "FreeBusyRequest": {
1969 "id": "FreeBusyRequest",
1970 "properties": {
1971 "calendarExpansionMax": {
1972 "format": "int32",
1973 "description": "Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.",
1974 "type": "integer"
1975 },
1976 "timeMin": {
1977 "description": "The start of the interval for the query formatted as per RFC3339.",
1978 "format": "date-time",
1979 "type": "string"
1980 },
1981 "groupExpansionMax": {
1982 "format": "int32",
1983 "description": "Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.",
1984 "type": "integer"
1985 },
1986 "timeZone": {
1987 "type": "string",
1988 "description": "Time zone used in the response. Optional. The default is UTC.",
1989 "default": "UTC"
1990 },
1991 "timeMax": {
1992 "type": "string",
1993 "format": "date-time",
1994 "description": "The end of the interval for the query formatted as per RFC3339."
1995 },
1996 "items": {
1997 "type": "array",
1998 "items": {
1999 "$ref": "FreeBusyRequestItem"
2000 },
2001 "description": "List of calendars and/or groups to query."
2002 }
2003 },
2004 "type": "object"
2005 },
2006 "Error": {
2007 "properties": {
2008 "reason": {
2009 "description": "Specific reason for the error. Some of the possible values are: \n- \"groupTooBig\" - The group of users requested is too large for a single query. \n- \"tooManyCalendarsRequested\" - The number of calendars requested is too large for a single query. \n- \"notFound\" - The requested resource was not found. \n- \"internalError\" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.",
2010 "type": "string"
2011 },
2012 "domain": {
2013 "type": "string",
2014 "description": "Domain, or broad category, of the error."
2015 }
2016 },
2017 "type": "object",
2018 "id": "Error"
2019 },
2020 "EventAttachment": {
2021 "properties": {
2022 "iconLink": {
2023 "description": "URL link to the attachment's icon. Read-only.",
2024 "type": "string"
2025 },
2026 "fileId": {
2027 "type": "string",
2028 "description": "ID of the attached file. Read-only.\nFor Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API."
2029 },
2030 "fileUrl": {
2031 "type": "string",
2032 "description": "URL link to the attachment.\nFor adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.\nRequired when adding an attachment."
2033 },
2034 "title": {
2035 "description": "Attachment title.",
2036 "type": "string"
2037 },
2038 "mimeType": {
2039 "description": "Internet media type (MIME type) of the attachment.",
2040 "type": "string"
2041 }
2042 },
2043 "type": "object",
2044 "id": "EventAttachment"
2045 },
2046 "FreeBusyResponse": {
2047 "properties": {
2048 "kind": {
2049 "default": "calendar#freeBusy",
2050 "type": "string",
2051 "description": "Type of the resource (\"calendar#freeBusy\")."
2052 },
2053 "groups": {
2054 "additionalProperties": {
2055 "description": "List of calendars that are members of this group.",
2056 "$ref": "FreeBusyGroup"
2057 },
2058 "type": "object",
2059 "description": "Expansion of groups."
2060 },
2061 "calendars": {
2062 "type": "object",
2063 "description": "List of free/busy information for calendars.",
2064 "additionalProperties": {
2065 "description": "Free/busy expansions for a single calendar.",
2066 "$ref": "FreeBusyCalendar"
2067 }
2068 },
2069 "timeMax": {
2070 "description": "The end of the interval.",
2071 "format": "date-time",
2072 "type": "string"
2073 },
2074 "timeMin": {
2075 "format": "date-time",
2076 "type": "string",
2077 "description": "The start of the interval."
2078 }
2079 },
2080 "type": "object",
2081 "id": "FreeBusyResponse"
2082 },
2083 "EntryPoint": {
2084 "id": "EntryPoint",
2085 "properties": {
2086 "passcode": {
2087 "description": "The passcode to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.",
2088 "type": "string"
2089 },
2090 "entryPointFeatures": {
2091 "items": {
2092 "type": "string"
2093 },
2094 "type": "array",
2095 "description": "Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point."
2096 },
2097 "meetingCode": {
2098 "description": "The meeting code to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.",
2099 "type": "string"
2100 },
2101 "password": {
2102 "description": "The password to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.",
2103 "type": "string"
2104 },
2105 "regionCode": {
2106 "type": "string",
2107 "description": "The CLDR/ISO 3166 region code for the country associated with this phone access. Example: \"SE\" for Sweden.\nCalendar backend will populate this field only for EntryPointType.PHONE."
2108 },
2109 "uri": {
2110 "description": "The URI of the entry point. The maximum length is 1300 characters.\nFormat: \n- for video, http: or https: schema is required.\n- for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).\n- for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.\n- for more, http: or https: schema is required.",
2111 "type": "string"
2112 },
2113 "accessCode": {
2114 "description": "The access code to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.",
2115 "type": "string"
2116 },
2117 "pin": {
2118 "description": "The PIN to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.",
2119 "type": "string"
2120 },
2121 "label": {
2122 "type": "string",
2123 "description": "The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.\nExamples: \n- for video: meet.google.com/aaa-bbbb-ccc\n- for phone: +1 123 268 2601\n- for sip: 12345678@altostrat.com\n- for more: should not be filled \nOptional."
2124 },
2125 "entryPointType": {
2126 "type": "string",
2127 "description": "The type of the conference entry point.\nPossible values are: \n- \"video\" - joining a conference over HTTP. A conference can have zero or one video entry point.\n- \"phone\" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.\n- \"sip\" - joining a conference over SIP. A conference can have zero or one sip entry point.\n- \"more\" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference."
2128 }
2129 },
2130 "type": "object"
2131 },
2132 "CalendarNotification": {
2133 "properties": {
2134 "type": {
2135 "description": "The type of notification. Possible values are: \n- \"eventCreation\" - Notification sent when a new event is put on the calendar. \n- \"eventChange\" - Notification sent when an event is changed. \n- \"eventCancellation\" - Notification sent when an event is cancelled. \n- \"eventResponse\" - Notification sent when an attendee responds to the event invitation. \n- \"agenda\" - An agenda with the events of the day (sent out in the morning). \nRequired when adding a notification.",
2136 "type": "string"
2137 },
2138 "method": {
2139 "type": "string",
2140 "description": "The method used to deliver the notification. The possible value is: \n- \"email\" - Notifications are sent via email. \nRequired when adding a notification."
2141 }
2142 },
2143 "type": "object",
2144 "id": "CalendarNotification"
2145 },
2146 "Setting": {
2147 "properties": {
2148 "kind": {
2149 "description": "Type of the resource (\"calendar#setting\").",
2150 "type": "string",
2151 "default": "calendar#setting"
2152 },
2153 "id": {
2154 "description": "The id of the user setting.",
2155 "type": "string"
2156 },
2157 "value": {
2158 "description": "Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.",
2159 "type": "string"
2160 },
2161 "etag": {
2162 "type": "string",
2163 "description": "ETag of the resource."
2164 }
2165 },
2166 "type": "object",
2167 "id": "Setting"
2168 },
2169 "ConferenceSolution": {
2170 "id": "ConferenceSolution",
2171 "type": "object",
2172 "properties": {
2173 "iconUri": {
2174 "type": "string",
2175 "description": "The user-visible icon for this solution."
2176 },
2177 "key": {
2178 "description": "The key which can uniquely identify the conference solution for this event.",
2179 "$ref": "ConferenceSolutionKey"
2180 },
2181 "name": {
2182 "type": "string",
2183 "description": "The user-visible name of this solution. Not localized."
2184 }
2185 }
2186 },
2187 "EventDateTime": {
2188 "type": "object",
2189 "properties": {
2190 "dateTime": {
2191 "type": "string",
2192 "description": "The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.",
2193 "format": "date-time"
2194 },
2195 "date": {
2196 "description": "The date, in the format \"yyyy-mm-dd\", if this is an all-day event.",
2197 "format": "date",
2198 "type": "string"
2199 },
2200 "timeZone": {
2201 "type": "string",
2202 "description": "The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end."
2203 }
2204 },
2205 "id": "EventDateTime"
2206 },
2207 "ConferenceParametersAddOnParameters": {
2208 "type": "object",
2209 "id": "ConferenceParametersAddOnParameters",
2210 "properties": {
2211 "parameters": {
2212 "type": "object",
2213 "additionalProperties": {
2214 "type": "string"
2215 }
2216 }
2217 }
2218 },
2219 "FreeBusyRequestItem": {
2220 "id": "FreeBusyRequestItem",
2221 "properties": {
2222 "id": {
2223 "type": "string",
2224 "description": "The identifier of a calendar or a group."
2225 }
2226 },
2227 "type": "object"
2228 },
2229 "ConferenceData": {
2230 "type": "object",
2231 "id": "ConferenceData",
2232 "properties": {
2233 "conferenceId": {
2234 "description": "The ID of the conference.\nCan be used by developers to keep track of conferences, should not be displayed to users.\nValues for solution types: \n- \"eventHangout\": unset.\n- \"eventNamedHangout\": the name of the Hangout.\n- \"hangoutsMeet\": the 10-letter meeting code, for example \"aaa-bbbb-ccc\".\n- \"addOn\": defined by 3P conference provider. Optional.",
2235 "type": "string"
2236 },
2237 "createRequest": {
2238 "description": "A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.\nEither conferenceSolution and at least one entryPoint, or createRequest is required.",
2239 "$ref": "CreateConferenceRequest"
2240 },
2241 "parameters": {
2242 "$ref": "ConferenceParameters",
2243 "description": "Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming."
2244 },
2245 "signature": {
2246 "description": "The signature of the conference data.\nGenerated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.\nUnset for a conference with a failed create request.\nOptional for a conference with a pending create request.",
2247 "type": "string"
2248 },
2249 "notes": {
2250 "type": "string",
2251 "description": "Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional."
2252 },
2253 "conferenceSolution": {
2254 "description": "The conference solution, such as Hangouts or Google Meet.\nUnset for a conference with a failed create request.\nEither conferenceSolution and at least one entryPoint, or createRequest is required.",
2255 "$ref": "ConferenceSolution"
2256 },
2257 "entryPoints": {
2258 "description": "Information about individual conference entry points, such as URLs or phone numbers.\nAll of them must belong to the same conference.\nEither conferenceSolution and at least one entryPoint, or createRequest is required.",
2259 "items": {
2260 "$ref": "EntryPoint"
2261 },
2262 "type": "array"
2263 }
2264 }
2265 },
2266 "CalendarListEntry": {
2267 "properties": {
2268 "hidden": {
2269 "default": "false",
2270 "description": "Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.",
2271 "type": "boolean"
2272 },
2273 "accessRole": {
2274 "type": "string",
2275 "description": "The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs."
2276 },
2277 "location": {
2278 "description": "Geographic location of the calendar as free-form text. Optional. Read-only.",
2279 "type": "string"
2280 },
2281 "deleted": {
2282 "description": "Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.",
2283 "default": "false",
2284 "type": "boolean"
2285 },
2286 "kind": {
2287 "description": "Type of the resource (\"calendar#calendarListEntry\").",
2288 "default": "calendar#calendarListEntry",
2289 "type": "string"
2290 },
2291 "summaryOverride": {
2292 "description": "The summary that the authenticated user has set for this calendar. Optional.",
2293 "type": "string"
2294 },
2295 "id": {
2296 "description": "Identifier of the calendar.",
2297 "annotations": {
2298 "required": [
2299 "calendar.calendarList.insert"
2300 ]
2301 },
2302 "type": "string"
2303 },
2304 "timeZone": {
2305 "description": "The time zone of the calendar. Optional. Read-only.",
2306 "type": "string"
2307 },
2308 "foregroundColor": {
2309 "description": "The foreground color of the calendar in the hexadecimal format \"#ffffff\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.",
2310 "type": "string"
2311 },
2312 "description": {
2313 "type": "string",
2314 "description": "Description of the calendar. Optional. Read-only."
2315 },
2316 "backgroundColor": {
2317 "description": "The main color of the calendar in the hexadecimal format \"#0088aa\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.",
2318 "type": "string"
2319 },
2320 "summary": {
2321 "type": "string",
2322 "description": "Title of the calendar. Read-only."
2323 },
2324 "primary": {
2325 "default": "false",
2326 "description": "Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.",
2327 "type": "boolean"
2328 },
2329 "notificationSettings": {
2330 "description": "The notifications that the authenticated user is receiving for this calendar.",
2331 "type": "object",
2332 "properties": {
2333 "notifications": {
2334 "items": {
2335 "$ref": "CalendarNotification"
2336 },
2337 "type": "array",
2338 "description": "The list of notifications set for this calendar."
2339 }
2340 }
2341 },
2342 "defaultReminders": {
2343 "type": "array",
2344 "items": {
2345 "$ref": "EventReminder"
2346 },
2347 "description": "The default reminders that the authenticated user has for this calendar."
2348 },
2349 "etag": {
2350 "type": "string",
2351 "description": "ETag of the resource."
2352 },
2353 "selected": {
2354 "description": "Whether the calendar content shows up in the calendar UI. Optional. The default is False.",
2355 "default": "false",
2356 "type": "boolean"
2357 },
2358 "colorId": {
2359 "description": "The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.",
2360 "type": "string"
2361 },
2362 "conferenceProperties": {
2363 "$ref": "ConferenceProperties",
2364 "description": "Conferencing properties for this calendar, for example what types of conferences are allowed."
2365 }
2366 },
2367 "type": "object",
2368 "id": "CalendarListEntry"
2369 },
2370 "FreeBusyGroup": {
2371 "type": "object",
2372 "id": "FreeBusyGroup",
2373 "properties": {
2374 "errors": {
2375 "description": "Optional error(s) (if computation for the group failed).",
2376 "items": {
2377 "$ref": "Error"
2378 },
2379 "type": "array"
2380 },
2381 "calendars": {
2382 "description": "List of calendars' identifiers within a group.",
2383 "type": "array",
2384 "items": {
2385 "type": "string"
2386 }
2387 }
2388 }
2389 },
2390 "Channel": {
2391 "type": "object",
2392 "properties": {
2393 "kind": {
2394 "type": "string",
2395 "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".",
2396 "default": "api#channel"
2397 },
2398 "token": {
2399 "type": "string",
2400 "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional."
2401 },
2402 "resourceId": {
2403 "type": "string",
2404 "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions."
2405 },
2406 "payload": {
2407 "type": "boolean",
2408 "description": "A Boolean value to indicate whether payload is wanted. Optional."
2409 },
2410 "expiration": {
2411 "type": "string",
2412 "format": "int64",
2413 "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional."
2414 },
2415 "params": {
2416 "description": "Additional parameters controlling delivery channel behavior. Optional.",
2417 "additionalProperties": {
2418 "description": "Declares a new parameter by name.",
2419 "type": "string"
2420 },
2421 "type": "object"
2422 },
2423 "resourceUri": {
2424 "description": "A version-specific identifier for the watched resource.",
2425 "type": "string"
2426 },
2427 "address": {
2428 "description": "The address where notifications are delivered for this channel.",
2429 "type": "string"
2430 },
2431 "id": {
2432 "description": "A UUID or similar unique string that identifies this channel.",
2433 "type": "string"
2434 },
2435 "type": {
2436 "type": "string",
2437 "description": "The type of delivery mechanism used for this channel."
2438 }
2439 },
2440 "id": "Channel"
2441 },
2442 "Colors": {
2443 "id": "Colors",
2444 "properties": {
2445 "kind": {
2446 "type": "string",
2447 "description": "Type of the resource (\"calendar#colors\").",
2448 "default": "calendar#colors"
2449 },
2450 "calendar": {
2451 "additionalProperties": {
2452 "description": "A calendar color defintion.",
2453 "$ref": "ColorDefinition"
2454 },
2455 "description": "A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only.",
2456 "type": "object"
2457 },
2458 "updated": {
2459 "format": "date-time",
2460 "type": "string",
2461 "description": "Last modification time of the color palette (as a RFC3339 timestamp). Read-only."
2462 },
2463 "event": {
2464 "additionalProperties": {
2465 "description": "An event color definition.",
2466 "$ref": "ColorDefinition"
2467 },
2468 "description": "A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only.",
2469 "type": "object"
2470 }
2471 },
2472 "type": "object"
2473 },
2474 "CalendarList": {
2475 "properties": {
2476 "nextSyncToken": {
2477 "type": "string",
2478 "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided."
2479 },
2480 "nextPageToken": {
2481 "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.",
2482 "type": "string"
2483 },
2484 "etag": {
2485 "description": "ETag of the collection.",
2486 "type": "string"
2487 },
2488 "items": {
2489 "description": "Calendars that are present on the user's calendar list.",
2490 "type": "array",
2491 "items": {
2492 "$ref": "CalendarListEntry"
2493 }
2494 },
2495 "kind": {
2496 "default": "calendar#calendarList",
2497 "type": "string",
2498 "description": "Type of the collection (\"calendar#calendarList\")."
2499 }
2500 },
2501 "type": "object",
2502 "id": "CalendarList"
2503 },
2504 "CreateConferenceRequest": {
2505 "properties": {
2506 "status": {
2507 "description": "The status of the conference create request.",
2508 "$ref": "ConferenceRequestStatus"
2509 },
2510 "requestId": {
2511 "type": "string",
2512 "description": "The client-generated unique ID for this request.\nClients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored."
2513 },
2514 "conferenceSolutionKey": {
2515 "description": "The conference solution, such as Hangouts or Google Meet.",
2516 "$ref": "ConferenceSolutionKey"
2517 }
2518 },
2519 "id": "CreateConferenceRequest",
2520 "type": "object"
2521 },
2522 "FreeBusyCalendar": {
2523 "id": "FreeBusyCalendar",
2524 "type": "object",
2525 "properties": {
2526 "errors": {
2527 "items": {
2528 "$ref": "Error"
2529 },
2530 "description": "Optional error(s) (if computation for the calendar failed).",
2531 "type": "array"
2532 },
2533 "busy": {
2534 "description": "List of time ranges during which this calendar should be regarded as busy.",
2535 "type": "array",
2536 "items": {
2537 "$ref": "TimePeriod"
2538 }
2539 }
2540 }
2541 },
2542 "EventReminder": {
2543 "properties": {
2544 "minutes": {
2545 "description": "Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).\nRequired when adding a reminder.",
2546 "format": "int32",
2547 "type": "integer"
2548 },
2549 "method": {
2550 "type": "string",
2551 "description": "The method used by this reminder. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"popup\" - Reminders are sent via a UI popup. \nRequired when adding a reminder."
2552 }
2553 },
2554 "id": "EventReminder",
2555 "type": "object"
2556 },
2557 "ConferenceProperties": {
2558 "id": "ConferenceProperties",
2559 "properties": {
2560 "allowedConferenceSolutionTypes": {
2561 "description": "The types of conference solutions that are supported for this calendar.\nThe possible values are: \n- \"eventHangout\" \n- \"eventNamedHangout\" \n- \"hangoutsMeet\" Optional.",
2562 "items": {
2563 "type": "string"
2564 },
2565 "type": "array"
2566 }
2567 },
2568 "type": "object"
2569 },
2570 "Settings": {
2571 "properties": {
2572 "items": {
2573 "description": "List of user settings.",
2574 "type": "array",
2575 "items": {
2576 "$ref": "Setting"
2577 }
2578 },
2579 "nextSyncToken": {
2580 "type": "string",
2581 "description": "Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided."
2582 },
2583 "nextPageToken": {
2584 "type": "string",
2585 "description": "Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided."
2586 },
2587 "kind": {
2588 "description": "Type of the collection (\"calendar#settings\").",
2589 "type": "string",
2590 "default": "calendar#settings"
2591 },
2592 "etag": {
2593 "type": "string",
2594 "description": "Etag of the collection."
2595 }
2596 },
2597 "id": "Settings",
2598 "type": "object"
2599 },
2600 "Event": {
2601 "properties": {
2602 "recurringEventId": {
2603 "description": "For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.",
2604 "type": "string"
2605 },
2606 "summary": {
2607 "description": "Title of the event.",
2608 "type": "string"
2609 },
2610 "etag": {
2611 "description": "ETag of the resource.",
2612 "type": "string"
2613 },
2614 "colorId": {
2615 "type": "string",
2616 "description": "The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional."
2617 },
2618 "reminders": {
2619 "type": "object",
2620 "properties": {
2621 "useDefault": {
2622 "description": "Whether the default reminders of the calendar apply to the event.",
2623 "type": "boolean"
2624 },
2625 "overrides": {
2626 "type": "array",
2627 "items": {
2628 "$ref": "EventReminder"
2629 },
2630 "description": "If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5."
2631 }
2632 },
2633 "description": "Information about the event's reminders for the authenticated user."
2634 },
2635 "originalStartTime": {
2636 "$ref": "EventDateTime",
2637 "description": "For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable."
2638 },
2639 "organizer": {
2640 "properties": {
2641 "self": {
2642 "description": "Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.",
2643 "default": "false",
2644 "type": "boolean"
2645 },
2646 "displayName": {
2647 "type": "string",
2648 "description": "The organizer's name, if available."
2649 },
2650 "id": {
2651 "description": "The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API",
2652 "type": "string"
2653 },
2654 "email": {
2655 "description": "The organizer's email address, if available. It must be a valid email address as per RFC5322.",
2656 "type": "string"
2657 }
2658 },
2659 "description": "The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.",
2660 "type": "object"
2661 },
2662 "conferenceData": {
2663 "$ref": "ConferenceData",
2664 "description": "The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests."
2665 },
2666 "source": {
2667 "type": "object",
2668 "description": "Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.",
2669 "properties": {
2670 "title": {
2671 "type": "string",
2672 "description": "Title of the source; for example a title of a web page or an email subject."
2673 },
2674 "url": {
2675 "type": "string",
2676 "description": "URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS."
2677 }
2678 }
2679 },
2680 "guestsCanModify": {
2681 "default": "false",
2682 "description": "Whether attendees other than the organizer can modify the event. Optional. The default is False.",
2683 "type": "boolean"
2684 },
2685 "transparency": {
2686 "type": "string",
2687 "description": "Whether the event blocks time on the calendar. Optional. Possible values are: \n- \"opaque\" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. \n- \"transparent\" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.",
2688 "default": "opaque"
2689 },
2690 "kind": {
2691 "type": "string",
2692 "default": "calendar#event",
2693 "description": "Type of the resource (\"calendar#event\")."
2694 },
2695 "htmlLink": {
2696 "description": "An absolute link to this event in the Google Calendar Web UI. Read-only.",
2697 "type": "string"
2698 },
2699 "guestsCanSeeOtherGuests": {
2700 "default": "true",
2701 "type": "boolean",
2702 "description": "Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True."
2703 },
2704 "end": {
2705 "$ref": "EventDateTime",
2706 "description": "The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.",
2707 "annotations": {
2708 "required": [
2709 "calendar.events.import",
2710 "calendar.events.insert",
2711 "calendar.events.update"
2712 ]
2713 }
2714 },
2715 "extendedProperties": {
2716 "properties": {
2717 "shared": {
2718 "additionalProperties": {
2719 "description": "The name of the shared property and the corresponding value.",
2720 "type": "string"
2721 },
2722 "type": "object",
2723 "description": "Properties that are shared between copies of the event on other attendees' calendars."
2724 },
2725 "private": {
2726 "description": "Properties that are private to the copy of the event that appears on this calendar.",
2727 "type": "object",
2728 "additionalProperties": {
2729 "type": "string",
2730 "description": "The name of the private property and the corresponding value."
2731 }
2732 }
2733 },
2734 "type": "object",
2735 "description": "Extended properties of the event."
2736 },
2737 "created": {
2738 "format": "date-time",
2739 "description": "Creation time of the event (as a RFC3339 timestamp). Read-only.",
2740 "type": "string"
2741 },
2742 "anyoneCanAddSelf": {
2743 "default": "false",
2744 "type": "boolean",
2745 "description": "Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False."
2746 },
2747 "updated": {
2748 "type": "string",
2749 "description": "Last modification time of the event (as a RFC3339 timestamp). Read-only.",
2750 "format": "date-time"
2751 },
2752 "hangoutLink": {
2753 "type": "string",
2754 "description": "An absolute link to the Google+ hangout associated with this event. Read-only."
2755 },
2756 "guestsCanInviteOthers": {
2757 "type": "boolean",
2758 "description": "Whether attendees other than the organizer can invite others to the event. Optional. The default is True.",
2759 "default": "true"
2760 },
2761 "creator": {
2762 "description": "The creator of the event. Read-only.",
2763 "type": "object",
2764 "properties": {
2765 "displayName": {
2766 "description": "The creator's name, if available.",
2767 "type": "string"
2768 },
2769 "email": {
2770 "description": "The creator's email address, if available.",
2771 "type": "string"
2772 },
2773 "id": {
2774 "type": "string",
2775 "description": "The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API"
2776 },
2777 "self": {
2778 "type": "boolean",
2779 "description": "Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.",
2780 "default": "false"
2781 }
2782 }
2783 },
2784 "id": {
2785 "type": "string",
2786 "description": "Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: \n- characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 \n- the length of the ID must be between 5 and 1024 characters \n- the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.\nIf you do not specify an ID, it will be automatically generated by the server.\nNote that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs."
2787 },
2788 "locked": {
2789 "description": "Whether this is a locked event copy where no changes can be made to the main event fields \"summary\", \"description\", \"location\", \"start\", \"end\" or \"recurrence\". The default is False. Read-Only.",
2790 "default": "false",
2791 "type": "boolean"
2792 },
2793 "recurrence": {
2794 "items": {
2795 "type": "string"
2796 },
2797 "description": "List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.",
2798 "type": "array"
2799 },
2800 "status": {
2801 "description": "Status of the event. Optional. Possible values are: \n- \"confirmed\" - The event is confirmed. This is the default status. \n- \"tentative\" - The event is tentatively confirmed. \n- \"cancelled\" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.\nA cancelled status represents two different states depending on the event type: \n- Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.\nCancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. \n- All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.\nDeleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.\nIf an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.",
2802 "type": "string"
2803 },
2804 "endTimeUnspecified": {
2805 "default": "false",
2806 "description": "Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.",
2807 "type": "boolean"
2808 },
2809 "attendeesOmitted": {
2810 "description": "Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.",
2811 "default": "false",
2812 "type": "boolean"
2813 },
2814 "privateCopy": {
2815 "default": "false",
2816 "description": "If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.",
2817 "type": "boolean"
2818 },
2819 "location": {
2820 "type": "string",
2821 "description": "Geographic location of the event as free-form text. Optional."
2822 },
2823 "attendees": {
2824 "description": "The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.",
2825 "items": {
2826 "$ref": "EventAttendee"
2827 },
2828 "type": "array"
2829 },
2830 "start": {
2831 "description": "The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.",
2832 "annotations": {
2833 "required": [
2834 "calendar.events.import",
2835 "calendar.events.insert",
2836 "calendar.events.update"
2837 ]
2838 },
2839 "$ref": "EventDateTime"
2840 },
2841 "gadget": {
2842 "description": "A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.",
2843 "properties": {
2844 "iconLink": {
2845 "description": "The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.",
2846 "type": "string"
2847 },
2848 "type": {
2849 "description": "The gadget's type. Deprecated.",
2850 "type": "string"
2851 },
2852 "title": {
2853 "type": "string",
2854 "description": "The gadget's title. Deprecated."
2855 },
2856 "width": {
2857 "type": "integer",
2858 "format": "int32",
2859 "description": "The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated."
2860 },
2861 "height": {
2862 "format": "int32",
2863 "type": "integer",
2864 "description": "The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated."
2865 },
2866 "preferences": {
2867 "type": "object",
2868 "additionalProperties": {
2869 "type": "string",
2870 "description": "The preference name and corresponding value."
2871 },
2872 "description": "Preferences."
2873 },
2874 "link": {
2875 "type": "string",
2876 "description": "The gadget's URL. The URL scheme must be HTTPS. Deprecated."
2877 },
2878 "display": {
2879 "type": "string",
2880 "description": "The gadget's display mode. Deprecated. Possible values are: \n- \"icon\" - The gadget displays next to the event's title in the calendar view. \n- \"chip\" - The gadget displays when the event is clicked."
2881 }
2882 },
2883 "type": "object"
2884 },
2885 "sequence": {
2886 "type": "integer",
2887 "description": "Sequence number as per iCalendar.",
2888 "format": "int32"
2889 },
2890 "iCalUID": {
2891 "annotations": {
2892 "required": [
2893 "calendar.events.import"
2894 ]
2895 },
2896 "type": "string",
2897 "description": "Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.\nNote that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs."
2898 },
2899 "visibility": {
2900 "type": "string",
2901 "default": "default",
2902 "description": "Visibility of the event. Optional. Possible values are: \n- \"default\" - Uses the default visibility for events on the calendar. This is the default value. \n- \"public\" - The event is public and event details are visible to all readers of the calendar. \n- \"private\" - The event is private and only event attendees may view event details. \n- \"confidential\" - The event is private. This value is provided for compatibility reasons."
2903 },
2904 "description": {
2905 "type": "string",
2906 "description": "Description of the event. Can contain HTML. Optional."
2907 },
2908 "attachments": {
2909 "description": "File attachments for the event. Currently only Google Drive attachments are supported.\nIn order to modify attachments the supportsAttachments request parameter should be set to true.\nThere can be at most 25 attachments per event,",
2910 "items": {
2911 "$ref": "EventAttachment"
2912 },
2913 "type": "array"
2914 }
2915 },
2916 "type": "object",
2917 "id": "Event"
2918 },
2919 "ColorDefinition": {
2920 "id": "ColorDefinition",
2921 "type": "object",
2922 "properties": {
2923 "background": {
2924 "description": "The background color associated with this color definition.",
2925 "type": "string"
2926 },
2927 "foreground": {
2928 "type": "string",
2929 "description": "The foreground color that can be used to write on top of a background with 'background' color."
2930 }
2931 }
2932 }
2933 },
2934 "parameters": {
2935 "userIp": {
2936 "location": "query",
2937 "description": "Deprecated. Please use quotaUser instead.",
2938 "type": "string"
2939 },
2940 "prettyPrint": {
2941 "type": "boolean",
2942 "description": "Returns response with indentations and line breaks.",
2943 "location": "query",
2944 "default": "true"
2945 },
2946 "key": {
2947 "type": "string",
2948 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
2949 "location": "query"
2950 },
2951 "quotaUser": {
2952 "location": "query",
2953 "type": "string",
2954 "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
2955 },
2956 "alt": {
2957 "description": "Data format for the response.",
2958 "default": "json",
2959 "enum": [
2960 "json"
2961 ],
2962 "type": "string",
2963 "enumDescriptions": [
2964 "Responses with Content-Type of application/json"
2965 ],
2966 "location": "query"
2967 },
2968 "oauth_token": {
2969 "description": "OAuth 2.0 token for the current user.",
2970 "type": "string",
2971 "location": "query"
2972 },
2973 "fields": {
2974 "location": "query",
2975 "description": "Selector specifying which fields to include in a partial response.",
2976 "type": "string"
2977 }
2978 },
2979 "ownerName": "Google",
2980 "rootUrl": "https://www.googleapis.com/"
2981}