-
Notifications
You must be signed in to change notification settings - Fork 0
/
google_calendar.yml
3731 lines (3672 loc) · 140 KB
/
google_calendar.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
servers:
- url: https://www.googleapis.com/calendar/v3
info:
contact:
name: Google
url: https://google.com
x-twitter: youtube
description: Manipulates events and other calendar data.
license:
name: Creative Commons Attribution 3.0
url: http://creativecommons.org/licenses/by/3.0/
termsOfService: https://developers.google.com/terms/
title: Calendar API
version: v3
x-apiClientRegistration:
url: https://console.developers.google.com
x-apisguru-categories:
- analytics
- media
x-logo:
url: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png
x-origin:
- format: google
url: https://calendar-json.googleapis.com/$discovery/rest?version=v3
version: v1
x-providerName: googleapis.com
x-serviceName: calendar
externalDocs:
url: https://developers.google.com/google-apps/calendar/firstapp
tags:
- name: acl
- name: calendarList
- name: calendars
- name: channels
- name: colors
- name: events
- name: freebusy
- name: settings
paths:
/calendars:
post:
operationId: create_calendar
x-originalOperationId: calendar.calendars.insert
description: Creates a secondary calendar.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Calendar"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Calendar"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- calendars
/calendars/{calendarId}:
delete:
operationId: delete_calendar
x-originalOperationId: calendar.calendars.delete
description:
Deletes a secondary calendar. Use calendars.clear for clearing
all events on primary calendars.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
responses:
"200":
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- calendars
get:
operationId: get_calendar
x-originalOperationId: calendar.calendars.get
description: Returns metadata for a calendar.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Calendar"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
- Oauth2:
- https://www.googleapis.com/auth/calendar.readonly
Oauth2c:
- https://www.googleapis.com/auth/calendar.readonly
tags:
- calendars
patch:
operationId: update_calendar
x-originalOperationId: calendar.calendars.patch
description: Updates metadata for a calendar. This method supports patch semantics.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Calendar"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Calendar"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- calendars
put:
operationId: update_calendar_entire
x-originalOperationId: calendar.calendars.update
description: Updates metadata for a calendar.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Calendar"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Calendar"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- calendars
/calendars/{calendarId}/acl:
get:
operationId: get_acl_rules
x-originalOperationId: calendar.acl.list
description: Returns the rules in the access control list for the calendar.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- 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.
in: query
name: maxResults
schema:
minimum: 1
type: integer
- description: Token specifying which result page to return. Optional.
in: query
name: pageToken
schema:
type: string
- 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.
in: query
name: showDeleted
schema:
type: boolean
- 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.
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.
Learn more about incremental synchronization.
Optional. The default is to return all entries."
in: query
name: syncToken
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Acl"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- acl
post:
operationId: create_acl_rule
x-originalOperationId: calendar.acl.insert
description: Creates an access control rule.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- description:
Whether to send notifications about the calendar sharing change.
Optional. The default is True.
in: query
name: sendNotifications
schema:
type: boolean
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AclRule"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AclRule"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- acl
/calendars/{calendarId}/acl/watch:
post:
operationId: watch_acl
x-originalOperationId: calendar.acl.watch
description: Watch for changes to ACL resources.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- 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.
in: query
name: maxResults
schema:
minimum: 1
type: integer
- description: Token specifying which result page to return. Optional.
in: query
name: pageToken
schema:
type: string
- 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.
in: query
name: showDeleted
schema:
type: boolean
- 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.
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.
Learn more about incremental synchronization.
Optional. The default is to return all entries."
in: query
name: syncToken
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Channel"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Channel"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- acl
/calendars/{calendarId}/acl/{ruleId}:
delete:
operationId: delete_acl_rule
x-originalOperationId: calendar.acl.delete
description: Deletes an access control rule.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- description: ACL rule identifier.
in: path
name: ruleId
required: true
schema:
type: string
responses:
"200":
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- acl
get:
operationId: get_acl_rule
x-originalOperationId: calendar.acl.get
description: Returns an access control rule.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- description: ACL rule identifier.
in: path
name: ruleId
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AclRule"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
- Oauth2:
- https://www.googleapis.com/auth/calendar.readonly
Oauth2c:
- https://www.googleapis.com/auth/calendar.readonly
tags:
- acl
patch:
operationId: update_acl_rule
x-originalOperationId: calendar.acl.patch
description: Updates an access control rule. This method supports patch semantics.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- description: ACL rule identifier.
in: path
name: ruleId
required: true
schema:
type: string
- description:
Whether to send notifications about the calendar sharing change.
Note that there are no notifications on access removal. Optional. The default
is True.
in: query
name: sendNotifications
schema:
type: boolean
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AclRule"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AclRule"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- acl
put:
operationId: update_acl_rule_all
x-originalOperationId: calendar.acl.update
description: Updates an access control rule.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- description: ACL rule identifier.
in: path
name: ruleId
required: true
schema:
type: string
- description:
Whether to send notifications about the calendar sharing change.
Note that there are no notifications on access removal. Optional. The default
is True.
in: query
name: sendNotifications
schema:
type: boolean
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AclRule"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/AclRule"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- acl
/calendars/{calendarId}/clear:
post:
operationId: clear_calendar
x-originalOperationId: calendar.calendars.clear
description:
Clears a primary calendar. This operation deletes all events associated
with the primary calendar of an account.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
responses:
"200":
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
tags:
- calendars
/calendars/{calendarId}/events:
get:
operationId: get_calendar_events
x-originalOperationId: calendar.events.list
description: Returns events on the specified calendar.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- 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).
in: query
name: alwaysIncludeEmail
schema:
type: boolean
- description:
Specifies event ID in the iCalendar format to be included in
the response. Optional.
in: query
name: iCalUID
schema:
type: string
- 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.
in: query
name: maxAttendees
schema:
minimum: 1
type: integer
- 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.
in: query
name: maxResults
schema:
minimum: 1
type: integer
- description:
The order of the events returned in the result. Optional. The
default is an unspecified, stable order.
in: query
name: orderBy
schema:
enum:
- startTime
- updated
type: string
- description: Token specifying which result page to return. Optional.
in: query
name: pageToken
schema:
type: string
- 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.
explode: true
in: query
name: privateExtendedProperty
schema:
items:
type: string
type: array
style: form
- description:
Free text search terms to find events that match these terms
in any field, except for extended properties. Optional.
in: query
name: q
schema:
type: string
- 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.
explode: true
in: query
name: sharedExtendedProperty
schema:
items:
type: string
type: array
style: form
- 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.
in: query
name: showDeleted
schema:
type: boolean
- description:
Whether to include hidden invitations in the result. Optional.
The default is False.
in: query
name: showHiddenInvitations
schema:
type: boolean
- 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.
in: query
name: singleEvents
schema:
type: boolean
- 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.\n\
Learn more about incremental synchronization.\nOptional. The default is\
\ to return all entries."
in: query
name: syncToken
schema:
type: string
- 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.
in: query
name: timeMax
schema:
type: string
- 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.
in: query
name: timeMin
schema:
type: string
- description:
Time zone used in the response. Optional. The default is the
time zone of the calendar.
in: query
name: timeZone
schema:
type: string
- 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.
in: query
name: updatedMin
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Events"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
- Oauth2:
- https://www.googleapis.com/auth/calendar.events
Oauth2c:
- https://www.googleapis.com/auth/calendar.events
- Oauth2:
- https://www.googleapis.com/auth/calendar.events.readonly
Oauth2c:
- https://www.googleapis.com/auth/calendar.events.readonly
- Oauth2:
- https://www.googleapis.com/auth/calendar.readonly
Oauth2c:
- https://www.googleapis.com/auth/calendar.readonly
tags:
- events
post:
operationId: create_calendar_event
x-originalOperationId: calendar.events.insert
description: Creates an event.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- 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.
in: query
name: conferenceDataVersion
schema:
maximum: 1
minimum: 0
type: integer
- 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.
in: query
name: maxAttendees
schema:
minimum: 1
type: integer
- description: "Deprecated. Please use sendUpdates instead.
Whether 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."
in: query
name: sendNotifications
schema:
type: boolean
- description:
Whether to send notifications about the creation of the new event.
Note that some emails might still be sent. The default is false.
in: query
name: sendUpdates
schema:
enum:
- all
- externalOnly
- none
type: string
- description:
Whether API client performing operation supports event attachments.
Optional. The default is False.
in: query
name: supportsAttachments
schema:
type: boolean
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
- Oauth2:
- https://www.googleapis.com/auth/calendar.events
Oauth2c:
- https://www.googleapis.com/auth/calendar.events
tags:
- events
/calendars/{calendarId}/events/import:
post:
operationId: import_calendar_event
x-originalOperationId: calendar.events.import
description:
Imports an event. This operation is used to add a private copy
of an existing event to a calendar.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- 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.
in: query
name: conferenceDataVersion
schema:
maximum: 1
minimum: 0
type: integer
- description:
Whether API client performing operation supports event attachments.
Optional. The default is False.
in: query
name: supportsAttachments
schema:
type: boolean
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
- Oauth2:
- https://www.googleapis.com/auth/calendar.events
Oauth2c:
- https://www.googleapis.com/auth/calendar.events
tags:
- events
/calendars/{calendarId}/events/quickAdd:
post:
operationId: quickAdd_calendar_event
x-originalOperationId: calendar.events.quickAdd
description: Creates an event based on a simple text string.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- description: The text describing the event to be created.
in: query
name: text
required: true
schema:
type: string
- description: "Deprecated. Please use sendUpdates instead.
Whether 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."
in: query
name: sendNotifications
schema:
type: boolean
- description:
Guests who should receive notifications about the creation of
the new event.
in: query
name: sendUpdates
schema:
enum:
- all
- externalOnly
- none
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/calendar
Oauth2c:
- https://www.googleapis.com/auth/calendar
- Oauth2:
- https://www.googleapis.com/auth/calendar.events
Oauth2c:
- https://www.googleapis.com/auth/calendar.events
tags:
- events
/calendars/{calendarId}/events/watch:
post:
operationId: watch_calendar_events
x-originalOperationId: calendar.events.watch
description: Watch for changes to Events resources.
parameters:
- description:
Calendar identifier. To retrieve calendar IDs call the get_calendarlist
method. If you want to access the primary calendar of the currently logged
in user, use the "primary" keyword.
in: path
name: calendarId
required: true
schema:
type: string
- 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).
in: query
name: alwaysIncludeEmail
schema:
type: boolean
- description:
Specifies event ID in the iCalendar format to be included in
the response. Optional.
in: query
name: iCalUID
schema:
type: string