/
calendar_v3.events.html
3835 lines (3753 loc) 路 395 KB
/
calendar_v3.events.html
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
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.events.html">events</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(calendarId, eventId, sendNotifications=None, sendUpdates=None)</a></code></p>
<p class="firstline">Deletes an event.</p>
<p class="toc_element">
<code><a href="#get">get(calendarId, eventId, alwaysIncludeEmail=None, maxAttendees=None, timeZone=None)</a></code></p>
<p class="firstline">Returns an event.</p>
<p class="toc_element">
<code><a href="#import_">import_(calendarId, body=None, conferenceDataVersion=None, supportsAttachments=None)</a></code></p>
<p class="firstline">Imports an event. This operation is used to add a private copy of an existing event to a calendar.</p>
<p class="toc_element">
<code><a href="#insert">insert(calendarId, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)</a></code></p>
<p class="firstline">Creates an event.</p>
<p class="toc_element">
<code><a href="#instances">instances(calendarId, eventId, alwaysIncludeEmail=None, maxAttendees=None, maxResults=None, originalStart=None, pageToken=None, showDeleted=None, timeMax=None, timeMin=None, timeZone=None)</a></code></p>
<p class="firstline">Returns instances of the specified recurring event.</p>
<p class="toc_element">
<code><a href="#instances_next">instances_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#list">list(calendarId, alwaysIncludeEmail=None, iCalUID=None, maxAttendees=None, maxResults=None, orderBy=None, pageToken=None, privateExtendedProperty=None, q=None, sharedExtendedProperty=None, showDeleted=None, showHiddenInvitations=None, singleEvents=None, syncToken=None, timeMax=None, timeMin=None, timeZone=None, updatedMin=None)</a></code></p>
<p class="firstline">Returns events on the specified calendar.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#move">move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)</a></code></p>
<p class="firstline">Moves an event to another calendar, i.e. changes an event's organizer.</p>
<p class="toc_element">
<code><a href="#patch">patch(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)</a></code></p>
<p class="firstline">Updates an event. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#quickAdd">quickAdd(calendarId, text, sendNotifications=None, sendUpdates=None)</a></code></p>
<p class="firstline">Creates an event based on a simple text string.</p>
<p class="toc_element">
<code><a href="#update">update(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)</a></code></p>
<p class="firstline">Updates an event.</p>
<p class="toc_element">
<code><a href="#watch">watch(calendarId, alwaysIncludeEmail=None, body=None, iCalUID=None, maxAttendees=None, maxResults=None, orderBy=None, pageToken=None, privateExtendedProperty=None, q=None, sharedExtendedProperty=None, showDeleted=None, showHiddenInvitations=None, singleEvents=None, syncToken=None, timeMax=None, timeMin=None, timeZone=None, updatedMin=None)</a></code></p>
<p class="firstline">Watch for changes to Events resources.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(calendarId, eventId, sendNotifications=None, sendUpdates=None)</code>
<pre>Deletes an event.
Args:
calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
eventId: string, Event identifier. (required)
sendNotifications: boolean, Deprecated. Please use sendUpdates instead.
Whether 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.
sendUpdates: string, Guests who should receive notifications about the deletion of the event.
Allowed values
all - Notifications are sent to all guests.
externalOnly - Notifications are sent to non-Google Calendar guests only.
none - No notifications are sent. For calendar migration tasks, consider using the Events.import method instead.
</pre>
</div>
<div class="method">
<code class="details" id="get">get(calendarId, eventId, alwaysIncludeEmail=None, maxAttendees=None, timeZone=None)</code>
<pre>Returns an event.
Args:
calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
eventId: string, Event identifier. (required)
alwaysIncludeEmail: boolean, 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).
maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
Returns:
An object of the form:
{
"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
# In order to modify attachments the supportsAttachments request parameter should be set to true.
# There can be at most 25 attachments per event,
{
"fileId": "A String", # ID of the attached file. Read-only.
# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
"fileUrl": "A String", # URL link to the attachment.
# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
# Required when adding an attachment.
"iconLink": "A String", # URL link to the attachment's icon. Read-only.
"mimeType": "A String", # Internet media type (MIME type) of the attachment.
"title": "A String", # Attachment title.
},
],
"attendees": [ # 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.
{
"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
"comment": "A String", # The attendee's response comment. Optional.
"displayName": "A String", # The attendee's name, if available. Optional.
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
# Required when adding an attendee.
"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
"optional": false, # Whether this is an optional attendee. Optional. The default is False.
"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
"resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
"responseStatus": "A String", # The attendee's response status. Possible values are:
# - "needsAction" - The attendee has not responded to the invitation.
# - "declined" - The attendee has declined the invitation.
# - "tentative" - The attendee has tentatively accepted the invitation.
# - "accepted" - The attendee has accepted the invitation.
"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
},
],
"attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
"conferenceData": { # 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.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type: `
# - eventHangout: ID is not set.
# - eventNamedHangout: ID is the name of the Hangout.
# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.
# - addOn: ID is defined by the third-party provider. Optional.
"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
# Unset for a conference with a failed create request.
# Either conferenceSolution and at least one entryPoint, or createRequest is required.
"iconUri": "A String", # The user-visible icon for this solution.
"key": { # The key which can uniquely identify the conference solution for this event.
"type": "A String", # The conference solution type.
# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
# The possible values are:
# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)
# - "hangoutsMeet" for Google Meet (http://meet.google.com)
# - "addOn" for 3P conference providers
},
"name": "A String", # The user-visible name of this solution. Not localized.
},
"createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
# Either conferenceSolution and at least one entryPoint, or createRequest is required.
"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
"type": "A String", # The conference solution type.
# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
# The possible values are:
# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)
# - "hangoutsMeet" for Google Meet (http://meet.google.com)
# - "addOn" for 3P conference providers
},
"requestId": "A String", # The client-generated unique ID for this request.
# Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
"status": { # The status of the conference create request.
"statusCode": "A String", # The current status of the conference create request. Read-only.
# The possible values are:
# - "pending": the conference create request is still being processed.
# - "success": the conference create request succeeded, the entry points are populated.
# - "failure": the conference create request failed, there are no entry points.
},
},
"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
# All of them must belong to the same conference.
# Either conferenceSolution and at least one entryPoint, or createRequest is required.
{
"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
"A String",
],
"entryPointType": "A String", # The type of the conference entry point.
# Possible values are:
# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
# - "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.
"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
# Examples:
# - for video: meet.google.com/aaa-bbbb-ccc
# - for phone: +1 123 268 2601
# - for sip: 12345678@altostrat.com
# - for more: should not be filled
# Optional.
"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
"password": "A String", # The password to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
# Calendar backend will populate this field only for EntryPointType.PHONE.
"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
# Format:
# - for video, http: or https: schema is required.
# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
# - for more, http: or https: schema is required.
},
],
"notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
"addOnParameters": { # Additional add-on specific data.
"parameters": {
"a_key": "A String",
},
},
},
"signature": "A String", # The signature of the conference data.
# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
# Unset for a conference with a failed create request.
# Optional for a conference with a pending create request.
},
"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
"creator": { # The creator of the event. Read-only.
"displayName": "A String", # The creator's name, if available.
"email": "A String", # The creator's email address, if available.
"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
},
"description": "A String", # Description of the event. Can contain HTML. Optional.
"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
"timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
},
"endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
"etag": "A String", # ETag of the resource.
"eventType": "default", # Specific type of the event. Read-only. Possible values are:
# - "default" - A regular event or not further specified.
# - "outOfOffice" - An out-of-office event.
"extendedProperties": { # Extended properties of the event.
"private": { # Properties that are private to the copy of the event that appears on this calendar.
"a_key": "A String", # The name of the private property and the corresponding value.
},
"shared": { # Properties that are shared between copies of the event on other attendees' calendars.
"a_key": "A String", # The name of the shared property and the corresponding value.
},
},
"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.
"display": "A String", # The gadget's display mode. Deprecated. Possible values are:
# - "icon" - The gadget displays next to the event's title in the calendar view.
# - "chip" - The gadget displays when the event is clicked.
"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.
"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.
"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.
"preferences": { # Preferences.
"a_key": "A String", # The preference name and corresponding value.
},
"title": "A String", # The gadget's title. Deprecated.
"type": "A String", # The gadget's type. Deprecated.
"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.
},
"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
"iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
# - 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
# - the length of the ID must be between 5 and 1024 characters
# - 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.
# If you do not specify an ID, it will be automatically generated by the server.
# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
"kind": "calendar#event", # Type of the resource ("calendar#event").
"location": "A String", # Geographic location of the event as free-form text. Optional.
"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.
"displayName": "A String", # The organizer's name, if available.
"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
},
"originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
"timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
},
"privateCopy": false, # 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.
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
"A String",
],
"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
"reminders": { # Information about the event's reminders for the authenticated user.
"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
},
"sequence": 42, # Sequence number as per iCalendar.
"source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
},
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
"timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
},
"status": "A String", # Status of the event. Optional. Possible values are:
# - "confirmed" - The event is confirmed. This is the default status.
# - "tentative" - The event is tentatively confirmed.
# - "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.
# A cancelled status represents two different states depending on the event type:
# - 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.
# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
# - 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.
# Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
# If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
"summary": "A String", # Title of the event.
"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
# - "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.
# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
"visibility": "default", # Visibility of the event. Optional. Possible values are:
# - "default" - Uses the default visibility for events on the calendar. This is the default value.
# - "public" - The event is public and event details are visible to all readers of the calendar.
# - "private" - The event is private and only event attendees may view event details.
# - "confidential" - The event is private. This value is provided for compatibility reasons.
}</pre>
</div>
<div class="method">
<code class="details" id="import_">import_(calendarId, body=None, conferenceDataVersion=None, supportsAttachments=None)</code>
<pre>Imports an event. This operation is used to add a private copy of an existing event to a calendar.
Args:
calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
body: object, The request body.
The object takes the form of:
{
"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
# In order to modify attachments the supportsAttachments request parameter should be set to true.
# There can be at most 25 attachments per event,
{
"fileId": "A String", # ID of the attached file. Read-only.
# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
"fileUrl": "A String", # URL link to the attachment.
# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
# Required when adding an attachment.
"iconLink": "A String", # URL link to the attachment's icon. Read-only.
"mimeType": "A String", # Internet media type (MIME type) of the attachment.
"title": "A String", # Attachment title.
},
],
"attendees": [ # 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.
{
"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
"comment": "A String", # The attendee's response comment. Optional.
"displayName": "A String", # The attendee's name, if available. Optional.
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
# Required when adding an attendee.
"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
"optional": false, # Whether this is an optional attendee. Optional. The default is False.
"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
"resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
"responseStatus": "A String", # The attendee's response status. Possible values are:
# - "needsAction" - The attendee has not responded to the invitation.
# - "declined" - The attendee has declined the invitation.
# - "tentative" - The attendee has tentatively accepted the invitation.
# - "accepted" - The attendee has accepted the invitation.
"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
},
],
"attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
"conferenceData": { # 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.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type: `
# - eventHangout: ID is not set.
# - eventNamedHangout: ID is the name of the Hangout.
# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.
# - addOn: ID is defined by the third-party provider. Optional.
"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
# Unset for a conference with a failed create request.
# Either conferenceSolution and at least one entryPoint, or createRequest is required.
"iconUri": "A String", # The user-visible icon for this solution.
"key": { # The key which can uniquely identify the conference solution for this event.
"type": "A String", # The conference solution type.
# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
# The possible values are:
# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)
# - "hangoutsMeet" for Google Meet (http://meet.google.com)
# - "addOn" for 3P conference providers
},
"name": "A String", # The user-visible name of this solution. Not localized.
},
"createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
# Either conferenceSolution and at least one entryPoint, or createRequest is required.
"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
"type": "A String", # The conference solution type.
# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
# The possible values are:
# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)
# - "hangoutsMeet" for Google Meet (http://meet.google.com)
# - "addOn" for 3P conference providers
},
"requestId": "A String", # The client-generated unique ID for this request.
# Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
"status": { # The status of the conference create request.
"statusCode": "A String", # The current status of the conference create request. Read-only.
# The possible values are:
# - "pending": the conference create request is still being processed.
# - "success": the conference create request succeeded, the entry points are populated.
# - "failure": the conference create request failed, there are no entry points.
},
},
"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
# All of them must belong to the same conference.
# Either conferenceSolution and at least one entryPoint, or createRequest is required.
{
"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
"A String",
],
"entryPointType": "A String", # The type of the conference entry point.
# Possible values are:
# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
# - "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.
"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
# Examples:
# - for video: meet.google.com/aaa-bbbb-ccc
# - for phone: +1 123 268 2601
# - for sip: 12345678@altostrat.com
# - for more: should not be filled
# Optional.
"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
"password": "A String", # The password to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
# Calendar backend will populate this field only for EntryPointType.PHONE.
"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
# Format:
# - for video, http: or https: schema is required.
# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
# - for more, http: or https: schema is required.
},
],
"notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
"addOnParameters": { # Additional add-on specific data.
"parameters": {
"a_key": "A String",
},
},
},
"signature": "A String", # The signature of the conference data.
# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
# Unset for a conference with a failed create request.
# Optional for a conference with a pending create request.
},
"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
"creator": { # The creator of the event. Read-only.
"displayName": "A String", # The creator's name, if available.
"email": "A String", # The creator's email address, if available.
"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
},
"description": "A String", # Description of the event. Can contain HTML. Optional.
"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
"timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
},
"endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
"etag": "A String", # ETag of the resource.
"eventType": "default", # Specific type of the event. Read-only. Possible values are:
# - "default" - A regular event or not further specified.
# - "outOfOffice" - An out-of-office event.
"extendedProperties": { # Extended properties of the event.
"private": { # Properties that are private to the copy of the event that appears on this calendar.
"a_key": "A String", # The name of the private property and the corresponding value.
},
"shared": { # Properties that are shared between copies of the event on other attendees' calendars.
"a_key": "A String", # The name of the shared property and the corresponding value.
},
},
"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.
"display": "A String", # The gadget's display mode. Deprecated. Possible values are:
# - "icon" - The gadget displays next to the event's title in the calendar view.
# - "chip" - The gadget displays when the event is clicked.
"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.
"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.
"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.
"preferences": { # Preferences.
"a_key": "A String", # The preference name and corresponding value.
},
"title": "A String", # The gadget's title. Deprecated.
"type": "A String", # The gadget's type. Deprecated.
"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.
},
"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
"iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
# - 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
# - the length of the ID must be between 5 and 1024 characters
# - 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.
# If you do not specify an ID, it will be automatically generated by the server.
# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
"kind": "calendar#event", # Type of the resource ("calendar#event").
"location": "A String", # Geographic location of the event as free-form text. Optional.
"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.
"displayName": "A String", # The organizer's name, if available.
"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
},
"originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
"timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
},
"privateCopy": false, # 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.
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
"A String",
],
"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
"reminders": { # Information about the event's reminders for the authenticated user.
"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
},
"sequence": 42, # Sequence number as per iCalendar.
"source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
},
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
"timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
},
"status": "A String", # Status of the event. Optional. Possible values are:
# - "confirmed" - The event is confirmed. This is the default status.
# - "tentative" - The event is tentatively confirmed.
# - "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.
# A cancelled status represents two different states depending on the event type:
# - 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.
# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
# - 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.
# Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
# If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
"summary": "A String", # Title of the event.
"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
# - "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.
# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
"visibility": "default", # Visibility of the event. Optional. Possible values are:
# - "default" - Uses the default visibility for events on the calendar. This is the default value.
# - "public" - The event is public and event details are visible to all readers of the calendar.
# - "private" - The event is private and only event attendees may view event details.
# - "confidential" - The event is private. This value is provided for compatibility reasons.
}
conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.
Returns:
An object of the form:
{
"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
# In order to modify attachments the supportsAttachments request parameter should be set to true.
# There can be at most 25 attachments per event,
{
"fileId": "A String", # ID of the attached file. Read-only.
# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
"fileUrl": "A String", # URL link to the attachment.
# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
# Required when adding an attachment.
"iconLink": "A String", # URL link to the attachment's icon. Read-only.
"mimeType": "A String", # Internet media type (MIME type) of the attachment.
"title": "A String", # Attachment title.
},
],
"attendees": [ # 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.
{
"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
"comment": "A String", # The attendee's response comment. Optional.
"displayName": "A String", # The attendee's name, if available. Optional.
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
# Required when adding an attendee.
"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
"optional": false, # Whether this is an optional attendee. Optional. The default is False.
"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
"resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
"responseStatus": "A String", # The attendee's response status. Possible values are:
# - "needsAction" - The attendee has not responded to the invitation.
# - "declined" - The attendee has declined the invitation.
# - "tentative" - The attendee has tentatively accepted the invitation.
# - "accepted" - The attendee has accepted the invitation.
"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
},
],
"attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
"conferenceData": { # 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.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type: `
# - eventHangout: ID is not set.
# - eventNamedHangout: ID is the name of the Hangout.
# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.
# - addOn: ID is defined by the third-party provider. Optional.
"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
# Unset for a conference with a failed create request.
# Either conferenceSolution and at least one entryPoint, or createRequest is required.
"iconUri": "A String", # The user-visible icon for this solution.
"key": { # The key which can uniquely identify the conference solution for this event.
"type": "A String", # The conference solution type.
# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
# The possible values are:
# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)
# - "hangoutsMeet" for Google Meet (http://meet.google.com)
# - "addOn" for 3P conference providers
},
"name": "A String", # The user-visible name of this solution. Not localized.
},
"createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
# Either conferenceSolution and at least one entryPoint, or createRequest is required.
"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
"type": "A String", # The conference solution type.
# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
# The possible values are:
# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)
# - "hangoutsMeet" for Google Meet (http://meet.google.com)
# - "addOn" for 3P conference providers
},
"requestId": "A String", # The client-generated unique ID for this request.
# Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
"status": { # The status of the conference create request.
"statusCode": "A String", # The current status of the conference create request. Read-only.
# The possible values are:
# - "pending": the conference create request is still being processed.
# - "success": the conference create request succeeded, the entry points are populated.
# - "failure": the conference create request failed, there are no entry points.
},
},
"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
# All of them must belong to the same conference.
# Either conferenceSolution and at least one entryPoint, or createRequest is required.
{
"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
"A String",
],
"entryPointType": "A String", # The type of the conference entry point.
# Possible values are:
# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
# - "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.
"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
# Examples:
# - for video: meet.google.com/aaa-bbbb-ccc
# - for phone: +1 123 268 2601
# - for sip: 12345678@altostrat.com
# - for more: should not be filled
# Optional.
"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
"password": "A String", # The password to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
# Optional.
"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
# Calendar backend will populate this field only for EntryPointType.PHONE.
"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
# Format:
# - for video, http: or https: schema is required.
# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
# - for more, http: or https: schema is required.
},
],
"notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
"addOnParameters": { # Additional add-on specific data.
"parameters": {
"a_key": "A String",
},
},
},
"signature": "A String", # The signature of the conference data.
# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
# Unset for a conference with a failed create request.
# Optional for a conference with a pending create request.
},
"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
"creator": { # The creator of the event. Read-only.
"displayName": "A String", # The creator's name, if available.
"email": "A String", # The creator's email address, if available.
"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
},
"description": "A String", # Description of the event. Can contain HTML. Optional.
"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
"timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
},
"endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
"etag": "A String", # ETag of the resource.
"eventType": "default", # Specific type of the event. Read-only. Possible values are:
# - "default" - A regular event or not further specified.
# - "outOfOffice" - An out-of-office event.
"extendedProperties": { # Extended properties of the event.
"private": { # Properties that are private to the copy of the event that appears on this calendar.
"a_key": "A String", # The name of the private property and the corresponding value.
},
"shared": { # Properties that are shared between copies of the event on other attendees' calendars.
"a_key": "A String", # The name of the shared property and the corresponding value.
},
},
"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.
"display": "A String", # The gadget's display mode. Deprecated. Possible values are:
# - "icon" - The gadget displays next to the event's title in the calendar view.
# - "chip" - The gadget displays when the event is clicked.
"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.
"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.
"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.
"preferences": { # Preferences.
"a_key": "A String", # The preference name and corresponding value.
},
"title": "A String", # The gadget's title. Deprecated.
"type": "A String", # The gadget's type. Deprecated.
"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.
},
"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
"iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
"id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
# - 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
# - the length of the ID must be between 5 and 1024 characters
# - 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.
# If you do not specify an ID, it will be automatically generated by the server.
# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
"kind": "calendar#event", # Type of the resource ("calendar#event").
"location": "A String", # Geographic location of the event as free-form text. Optional.
"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.
"displayName": "A String", # The organizer's name, if available.
"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
},
"originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
"timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
},
"privateCopy": false, # 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.
"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
"A String",
],
"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
"reminders": { # Information about the event's reminders for the authenticated user.
"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.
{
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "popup" - Reminders are sent via a UI popup.
# Required when adding a reminder.
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
# Required when adding a reminder.
},
],
"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
},
"sequence": 42, # Sequence number as per iCalendar.
"source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
"title": "A String", # Title of the source; for example a title of a web page or an email subject.
"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
},
"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
"timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
},
"status": "A String", # Status of the event. Optional. Possible values are:
# - "confirmed" - The event is confirmed. This is the default status.
# - "tentative" - The event is tentatively confirmed.
# - "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.
# A cancelled status represents two different states depending on the event type:
# - 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.
# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
# - 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.
# Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
# If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
"summary": "A String", # Title of the event.
"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
# - "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.
# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
"visibility": "default", # Visibility of the event. Optional. Possible values are:
# - "default" - Uses the default visibility for events on the calendar. This is the default value.
# - "public" - The event is public and event details are visible to all readers of the calendar.
# - "private" - The event is private and only event attendees may view event details.
# - "confidential" - The event is private. This value is provided for compatibility reasons.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(calendarId, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)</code>
<pre>Creates an event.
Args:
calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
body: object, The request body.
The object takes the form of:
{
"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
# In order to modify attachments the supportsAttachments request parameter should be set to true.
# There can be at most 25 attachments per event,
{
"fileId": "A String", # ID of the attached file. Read-only.
# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
"fileUrl": "A String", # URL link to the attachment.
# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
# Required when adding an attachment.
"iconLink": "A String", # URL link to the attachment's icon. Read-only.
"mimeType": "A String", # Internet media type (MIME type) of the attachment.
"title": "A String", # Attachment title.
},
],
"attendees": [ # 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.
{
"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
"comment": "A String", # The attendee's response comment. Optional.
"displayName": "A String", # The attendee's name, if available. Optional.
"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
# Required when adding an attendee.
"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
"optional": false, # Whether this is an optional attendee. Optional. The default is False.
"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
"resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
"responseStatus": "A String", # The attendee's response status. Possible values are:
# - "needsAction" - The attendee has not responded to the invitation.
# - "declined" - The attendee has declined the invitation.
# - "tentative" - The attendee has tentatively accepted the invitation.
# - "accepted" - The attendee has accepted the invitation.
"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
},
],
"attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
"conferenceData": { # 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.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type: `
# - eventHangout: ID is not set.
# - eventNamedHangout: ID is the name of the Hangout.
# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.
# - addOn: ID is defined by the third-party provider. Optional.
"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
# Unset for a conference with a failed create request.
# Either conferenceSolution and at least one entryPoint, or createRequest is required.
"iconUri": "A String", # The user-visible icon for this solution.
"key": { # The key which can uniquely identify the conference solution for this event.
"type": "A String", # The conference solution type.
# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
# The possible values are: