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
|
<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.calendarList.html">calendarList</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)</a></code></p>
<p class="firstline">Removes a calendar from the user's calendar list.</p>
<p class="toc_element">
<code><a href="#get">get(calendarId)</a></code></p>
<p class="firstline">Returns a calendar from the user's calendar list.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, colorRgbFormat=None)</a></code></p>
<p class="firstline">Inserts an existing calendar into the user's calendar list.</p>
<p class="toc_element">
<code><a href="#list">list(maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)</a></code></p>
<p class="firstline">Returns the calendars on the user's calendar list.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(calendarId, body=None, colorRgbFormat=None)</a></code></p>
<p class="firstline">Updates an existing calendar on the user's calendar list. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(calendarId, body=None, colorRgbFormat=None)</a></code></p>
<p class="firstline">Updates an existing calendar on the user's calendar list.</p>
<p class="toc_element">
<code><a href="#watch">watch(body=None, maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)</a></code></p>
<p class="firstline">Watch for changes to CalendarList 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)</code>
<pre>Removes a calendar from the user's calendar list.
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)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(calendarId)</code>
<pre>Returns a calendar from the user's calendar list.
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)
Returns:
An object of the form:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
"allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
# The possible values are:
# - "eventHangout"
# - "eventNamedHangout"
# - "hangoutsMeet" Optional.
"A String",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"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.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body=None, colorRgbFormat=None)</code>
<pre>Inserts an existing calendar into the user's calendar list.
Args:
body: object, The request body.
The object takes the form of:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
"allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
# The possible values are:
# - "eventHangout"
# - "eventNamedHangout"
# - "hangoutsMeet" Optional.
"A String",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"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.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}
colorRgbFormat: boolean, Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
Returns:
An object of the form:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
"allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
# The possible values are:
# - "eventHangout"
# - "eventNamedHangout"
# - "hangoutsMeet" Optional.
"A String",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"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.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)</code>
<pre>Returns the calendars on the user's calendar list.
Args:
maxResults: integer, 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.
minAccessRole: string, The minimum access role for the user in the returned entries. Optional. The default is no restriction.
Allowed values
freeBusyReader - The user can read free/busy information.
owner - The user can read and modify events and access control lists.
reader - The user can read events that are not private.
writer - The user can read and modify events.
pageToken: string, Token specifying which result page to return. Optional.
showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False.
showHidden: boolean, Whether to show hidden entries. Optional. The default is False.
syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.
To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.
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.
Returns:
An object of the form:
{
"etag": "A String", # ETag of the collection.
"items": [ # Calendars that are present on the user's calendar list.
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
"allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
# The possible values are:
# - "eventHangout"
# - "eventNamedHangout"
# - "hangoutsMeet" Optional.
"A String",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"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.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
},
],
"kind": "calendar#calendarList", # Type of the collection ("calendar#calendarList").
"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
"nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(calendarId, body=None, colorRgbFormat=None)</code>
<pre>Updates an existing calendar on the user's calendar list. This method supports patch semantics.
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:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
"allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
# The possible values are:
# - "eventHangout"
# - "eventNamedHangout"
# - "hangoutsMeet" Optional.
"A String",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"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.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}
colorRgbFormat: boolean, Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
Returns:
An object of the form:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
"allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
# The possible values are:
# - "eventHangout"
# - "eventNamedHangout"
# - "hangoutsMeet" Optional.
"A String",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"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.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(calendarId, body=None, colorRgbFormat=None)</code>
<pre>Updates an existing calendar on the user's calendar list.
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:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
"allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
# The possible values are:
# - "eventHangout"
# - "eventNamedHangout"
# - "hangoutsMeet" Optional.
"A String",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"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.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}
colorRgbFormat: boolean, Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
Returns:
An object of the form:
{
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"backgroundColor": "A String", # The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
"conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
"allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
# The possible values are:
# - "eventHangout"
# - "eventNamedHangout"
# - "hangoutsMeet" Optional.
"A String",
],
},
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"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.
},
],
"deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
"description": "A String", # Description of the calendar. Optional. Read-only.
"etag": "A String", # ETag of the resource.
"foregroundColor": "A String", # The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
"hidden": false, # Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
"id": "A String", # Identifier of the calendar.
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
"notifications": [ # The list of notifications set for this calendar.
{
"method": "A String", # The method used to deliver the notification. The possible value is:
# - "email" - Notifications are sent via email.
# Required when adding a notification.
"type": "A String", # The type of notification. Possible values are:
# - "eventCreation" - Notification sent when a new event is put on the calendar.
# - "eventChange" - Notification sent when an event is changed.
# - "eventCancellation" - Notification sent when an event is cancelled.
# - "eventResponse" - Notification sent when an attendee responds to the event invitation.
# - "agenda" - An agenda with the events of the day (sent out in the morning).
# Required when adding a notification.
},
],
},
"primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
"selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="watch">watch(body=None, maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)</code>
<pre>Watch for changes to CalendarList resources.
Args:
body: object, The request body.
The object takes the form of:
{
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
}
maxResults: integer, 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.
minAccessRole: string, The minimum access role for the user in the returned entries. Optional. The default is no restriction.
Allowed values
freeBusyReader - The user can read free/busy information.
owner - The user can read and modify events and access control lists.
reader - The user can read events that are not private.
writer - The user can read and modify events.
pageToken: string, Token specifying which result page to return. Optional.
showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False.
showHidden: boolean, Whether to show hidden entries. Optional. The default is False.
syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.
To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.
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.
Returns:
An object of the form:
{
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
}</pre>
</div>
</body></html>
|
