• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.calendarList.html">calendarList</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(calendarId)</a></code></p>
79<p class="firstline">Removes a calendar from the user's calendar list.</p>
80<p class="toc_element">
81  <code><a href="#get">get(calendarId)</a></code></p>
82<p class="firstline">Returns a calendar from the user's calendar list.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(body, colorRgbFormat=None)</a></code></p>
85<p class="firstline">Inserts an existing calendar into the user's calendar list.</p>
86<p class="toc_element">
87  <code><a href="#list">list(syncToken=None, minAccessRole=None, maxResults=None, showDeleted=None, showHidden=None, pageToken=None)</a></code></p>
88<p class="firstline">Returns the calendars on the user's calendar list.</p>
89<p class="toc_element">
90  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93  <code><a href="#patch">patch(calendarId, body, colorRgbFormat=None)</a></code></p>
94<p class="firstline">Updates an existing calendar on the user's calendar list. This method supports patch semantics.</p>
95<p class="toc_element">
96  <code><a href="#update">update(calendarId, body, colorRgbFormat=None)</a></code></p>
97<p class="firstline">Updates an existing calendar on the user's calendar list.</p>
98<p class="toc_element">
99  <code><a href="#watch">watch(body, syncToken=None, minAccessRole=None, maxResults=None, showDeleted=None, showHidden=None, pageToken=None)</a></code></p>
100<p class="firstline">Watch for changes to CalendarList resources.</p>
101<h3>Method Details</h3>
102<div class="method">
103    <code class="details" id="delete">delete(calendarId)</code>
104  <pre>Removes a calendar from the user's calendar list.
105
106Args:
107  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)
108</pre>
109</div>
110
111<div class="method">
112    <code class="details" id="get">get(calendarId)</code>
113  <pre>Returns a calendar from the user's calendar list.
114
115Args:
116  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)
117
118Returns:
119  An object of the form:
120
121    {
122      "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
123        "notifications": [ # The list of notifications set for this calendar.
124          {
125            "type": "A String", # The type of notification. Possible values are:
126                # - "eventCreation" - Notification sent when a new event is put on the calendar.
127                # - "eventChange" - Notification sent when an event is changed.
128                # - "eventCancellation" - Notification sent when an event is cancelled.
129                # - "eventResponse" - Notification sent when an attendee responds to the event invitation.
130                # - "agenda" - An agenda with the events of the day (sent out in the morning).
131                # Required when adding a notification.
132            "method": "A String", # The method used to deliver the notification. Possible values are:
133                # - "email" - Notifications are sent via email.
134                # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See  Google Calendar SMS notifications to be removed for more information.
135                # Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.
136                # Required when adding a notification.
137          },
138        ],
139      },
140      "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
141      "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.
142      "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
143        {
144          "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).
145              # Required when adding a reminder.
146          "method": "A String", # The method used by this reminder. Possible values are:
147              # - "email" - Reminders are sent via email.
148              # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See  Google Calendar SMS notifications to be removed for more information.
149              # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
150              # - "popup" - Reminders are sent via a UI popup.
151              # Required when adding a reminder.
152        },
153      ],
154      "description": "A String", # Description of the calendar. Optional. Read-only.
155      "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
156      "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.
157      "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
158      "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
159        "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
160            # The possible values are:
161            # - "eventHangout"
162            # - "eventNamedHangout"
163            # - "hangoutsMeet"  Optional.
164          "A String",
165        ],
166      },
167      "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
168      "etag": "A String", # ETag of the resource.
169      "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
170      "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.
171      "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
172      "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
173      "hidden": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
174      "summary": "A String", # Title of the calendar. Read-only.
175      "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
176          # - "freeBusyReader" - Provides read access to free/busy information.
177          # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
178          # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
179          # - "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.
180      "id": "A String", # Identifier of the calendar.
181    }</pre>
182</div>
183
184<div class="method">
185    <code class="details" id="insert">insert(body, colorRgbFormat=None)</code>
186  <pre>Inserts an existing calendar into the user's calendar list.
187
188Args:
189  body: object, The request body. (required)
190    The object takes the form of:
191
192{
193    "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
194      "notifications": [ # The list of notifications set for this calendar.
195        {
196          "type": "A String", # The type of notification. Possible values are:
197              # - "eventCreation" - Notification sent when a new event is put on the calendar.
198              # - "eventChange" - Notification sent when an event is changed.
199              # - "eventCancellation" - Notification sent when an event is cancelled.
200              # - "eventResponse" - Notification sent when an attendee responds to the event invitation.
201              # - "agenda" - An agenda with the events of the day (sent out in the morning).
202              # Required when adding a notification.
203          "method": "A String", # The method used to deliver the notification. Possible values are:
204              # - "email" - Notifications are sent via email.
205              # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See  Google Calendar SMS notifications to be removed for more information.
206              # Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.
207              # Required when adding a notification.
208        },
209      ],
210    },
211    "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
212    "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.
213    "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
214      {
215        "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).
216            # Required when adding a reminder.
217        "method": "A String", # The method used by this reminder. Possible values are:
218            # - "email" - Reminders are sent via email.
219            # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See  Google Calendar SMS notifications to be removed for more information.
220            # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
221            # - "popup" - Reminders are sent via a UI popup.
222            # Required when adding a reminder.
223      },
224    ],
225    "description": "A String", # Description of the calendar. Optional. Read-only.
226    "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
227    "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.
228    "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
229    "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
230      "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
231          # The possible values are:
232          # - "eventHangout"
233          # - "eventNamedHangout"
234          # - "hangoutsMeet"  Optional.
235        "A String",
236      ],
237    },
238    "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
239    "etag": "A String", # ETag of the resource.
240    "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
241    "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.
242    "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
243    "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
244    "hidden": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
245    "summary": "A String", # Title of the calendar. Read-only.
246    "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
247        # - "freeBusyReader" - Provides read access to free/busy information.
248        # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
249        # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
250        # - "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.
251    "id": "A String", # Identifier of the calendar.
252  }
253
254  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.
255
256Returns:
257  An object of the form:
258
259    {
260      "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
261        "notifications": [ # The list of notifications set for this calendar.
262          {
263            "type": "A String", # The type of notification. Possible values are:
264                # - "eventCreation" - Notification sent when a new event is put on the calendar.
265                # - "eventChange" - Notification sent when an event is changed.
266                # - "eventCancellation" - Notification sent when an event is cancelled.
267                # - "eventResponse" - Notification sent when an attendee responds to the event invitation.
268                # - "agenda" - An agenda with the events of the day (sent out in the morning).
269                # Required when adding a notification.
270            "method": "A String", # The method used to deliver the notification. Possible values are:
271                # - "email" - Notifications are sent via email.
272                # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See  Google Calendar SMS notifications to be removed for more information.
273                # Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.
274                # Required when adding a notification.
275          },
276        ],
277      },
278      "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
279      "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.
280      "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
281        {
282          "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).
283              # Required when adding a reminder.
284          "method": "A String", # The method used by this reminder. Possible values are:
285              # - "email" - Reminders are sent via email.
286              # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See  Google Calendar SMS notifications to be removed for more information.
287              # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
288              # - "popup" - Reminders are sent via a UI popup.
289              # Required when adding a reminder.
290        },
291      ],
292      "description": "A String", # Description of the calendar. Optional. Read-only.
293      "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
294      "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.
295      "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
296      "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
297        "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
298            # The possible values are:
299            # - "eventHangout"
300            # - "eventNamedHangout"
301            # - "hangoutsMeet"  Optional.
302          "A String",
303        ],
304      },
305      "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
306      "etag": "A String", # ETag of the resource.
307      "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
308      "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.
309      "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
310      "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
311      "hidden": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
312      "summary": "A String", # Title of the calendar. Read-only.
313      "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
314          # - "freeBusyReader" - Provides read access to free/busy information.
315          # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
316          # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
317          # - "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.
318      "id": "A String", # Identifier of the calendar.
319    }</pre>
320</div>
321
322<div class="method">
323    <code class="details" id="list">list(syncToken=None, minAccessRole=None, maxResults=None, showDeleted=None, showHidden=None, pageToken=None)</code>
324  <pre>Returns the calendars on the user's calendar list.
325
326Args:
327  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.
328To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.
329If 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.
330Learn more about incremental synchronization.
331Optional. The default is to return all entries.
332  minAccessRole: string, The minimum access role for the user in the returned entries. Optional. The default is no restriction.
333    Allowed values
334      freeBusyReader - The user can read free/busy information.
335      owner - The user can read and modify events and access control lists.
336      reader - The user can read events that are not private.
337      writer - The user can read and modify events.
338  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.
339  showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False.
340  showHidden: boolean, Whether to show hidden entries. Optional. The default is False.
341  pageToken: string, Token specifying which result page to return. Optional.
342
343Returns:
344  An object of the form:
345
346    {
347    "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.
348    "items": [ # Calendars that are present on the user's calendar list.
349      {
350          "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
351            "notifications": [ # The list of notifications set for this calendar.
352              {
353                "type": "A String", # The type of notification. Possible values are:
354                    # - "eventCreation" - Notification sent when a new event is put on the calendar.
355                    # - "eventChange" - Notification sent when an event is changed.
356                    # - "eventCancellation" - Notification sent when an event is cancelled.
357                    # - "eventResponse" - Notification sent when an attendee responds to the event invitation.
358                    # - "agenda" - An agenda with the events of the day (sent out in the morning).
359                    # Required when adding a notification.
360                "method": "A String", # The method used to deliver the notification. Possible values are:
361                    # - "email" - Notifications are sent via email.
362                    # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See  Google Calendar SMS notifications to be removed for more information.
363                    # Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.
364                    # Required when adding a notification.
365              },
366            ],
367          },
368          "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
369          "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.
370          "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
371            {
372              "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).
373                  # Required when adding a reminder.
374              "method": "A String", # The method used by this reminder. Possible values are:
375                  # - "email" - Reminders are sent via email.
376                  # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See  Google Calendar SMS notifications to be removed for more information.
377                  # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
378                  # - "popup" - Reminders are sent via a UI popup.
379                  # Required when adding a reminder.
380            },
381          ],
382          "description": "A String", # Description of the calendar. Optional. Read-only.
383          "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
384          "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.
385          "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
386          "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
387            "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
388                # The possible values are:
389                # - "eventHangout"
390                # - "eventNamedHangout"
391                # - "hangoutsMeet"  Optional.
392              "A String",
393            ],
394          },
395          "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
396          "etag": "A String", # ETag of the resource.
397          "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
398          "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.
399          "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
400          "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
401          "hidden": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
402          "summary": "A String", # Title of the calendar. Read-only.
403          "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
404              # - "freeBusyReader" - Provides read access to free/busy information.
405              # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
406              # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
407              # - "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.
408          "id": "A String", # Identifier of the calendar.
409        },
410    ],
411    "kind": "calendar#calendarList", # Type of the collection ("calendar#calendarList").
412    "etag": "A String", # ETag of the collection.
413    "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.
414  }</pre>
415</div>
416
417<div class="method">
418    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
419  <pre>Retrieves the next page of results.
420
421Args:
422  previous_request: The request for the previous page. (required)
423  previous_response: The response from the request for the previous page. (required)
424
425Returns:
426  A request object that you can call 'execute()' on to request the next
427  page. Returns None if there are no more items in the collection.
428    </pre>
429</div>
430
431<div class="method">
432    <code class="details" id="patch">patch(calendarId, body, colorRgbFormat=None)</code>
433  <pre>Updates an existing calendar on the user's calendar list. This method supports patch semantics.
434
435Args:
436  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)
437  body: object, The request body. (required)
438    The object takes the form of:
439
440{
441    "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
442      "notifications": [ # The list of notifications set for this calendar.
443        {
444          "type": "A String", # The type of notification. Possible values are:
445              # - "eventCreation" - Notification sent when a new event is put on the calendar.
446              # - "eventChange" - Notification sent when an event is changed.
447              # - "eventCancellation" - Notification sent when an event is cancelled.
448              # - "eventResponse" - Notification sent when an attendee responds to the event invitation.
449              # - "agenda" - An agenda with the events of the day (sent out in the morning).
450              # Required when adding a notification.
451          "method": "A String", # The method used to deliver the notification. Possible values are:
452              # - "email" - Notifications are sent via email.
453              # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See  Google Calendar SMS notifications to be removed for more information.
454              # Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.
455              # Required when adding a notification.
456        },
457      ],
458    },
459    "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
460    "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.
461    "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
462      {
463        "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).
464            # Required when adding a reminder.
465        "method": "A String", # The method used by this reminder. Possible values are:
466            # - "email" - Reminders are sent via email.
467            # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See  Google Calendar SMS notifications to be removed for more information.
468            # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
469            # - "popup" - Reminders are sent via a UI popup.
470            # Required when adding a reminder.
471      },
472    ],
473    "description": "A String", # Description of the calendar. Optional. Read-only.
474    "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
475    "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.
476    "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
477    "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
478      "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
479          # The possible values are:
480          # - "eventHangout"
481          # - "eventNamedHangout"
482          # - "hangoutsMeet"  Optional.
483        "A String",
484      ],
485    },
486    "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
487    "etag": "A String", # ETag of the resource.
488    "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
489    "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.
490    "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
491    "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
492    "hidden": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
493    "summary": "A String", # Title of the calendar. Read-only.
494    "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
495        # - "freeBusyReader" - Provides read access to free/busy information.
496        # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
497        # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
498        # - "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.
499    "id": "A String", # Identifier of the calendar.
500  }
501
502  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.
503
504Returns:
505  An object of the form:
506
507    {
508      "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
509        "notifications": [ # The list of notifications set for this calendar.
510          {
511            "type": "A String", # The type of notification. Possible values are:
512                # - "eventCreation" - Notification sent when a new event is put on the calendar.
513                # - "eventChange" - Notification sent when an event is changed.
514                # - "eventCancellation" - Notification sent when an event is cancelled.
515                # - "eventResponse" - Notification sent when an attendee responds to the event invitation.
516                # - "agenda" - An agenda with the events of the day (sent out in the morning).
517                # Required when adding a notification.
518            "method": "A String", # The method used to deliver the notification. Possible values are:
519                # - "email" - Notifications are sent via email.
520                # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See  Google Calendar SMS notifications to be removed for more information.
521                # Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.
522                # Required when adding a notification.
523          },
524        ],
525      },
526      "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
527      "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.
528      "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
529        {
530          "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).
531              # Required when adding a reminder.
532          "method": "A String", # The method used by this reminder. Possible values are:
533              # - "email" - Reminders are sent via email.
534              # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See  Google Calendar SMS notifications to be removed for more information.
535              # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
536              # - "popup" - Reminders are sent via a UI popup.
537              # Required when adding a reminder.
538        },
539      ],
540      "description": "A String", # Description of the calendar. Optional. Read-only.
541      "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
542      "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.
543      "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
544      "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
545        "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
546            # The possible values are:
547            # - "eventHangout"
548            # - "eventNamedHangout"
549            # - "hangoutsMeet"  Optional.
550          "A String",
551        ],
552      },
553      "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
554      "etag": "A String", # ETag of the resource.
555      "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
556      "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.
557      "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
558      "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
559      "hidden": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
560      "summary": "A String", # Title of the calendar. Read-only.
561      "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
562          # - "freeBusyReader" - Provides read access to free/busy information.
563          # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
564          # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
565          # - "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.
566      "id": "A String", # Identifier of the calendar.
567    }</pre>
568</div>
569
570<div class="method">
571    <code class="details" id="update">update(calendarId, body, colorRgbFormat=None)</code>
572  <pre>Updates an existing calendar on the user's calendar list.
573
574Args:
575  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)
576  body: object, The request body. (required)
577    The object takes the form of:
578
579{
580    "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
581      "notifications": [ # The list of notifications set for this calendar.
582        {
583          "type": "A String", # The type of notification. Possible values are:
584              # - "eventCreation" - Notification sent when a new event is put on the calendar.
585              # - "eventChange" - Notification sent when an event is changed.
586              # - "eventCancellation" - Notification sent when an event is cancelled.
587              # - "eventResponse" - Notification sent when an attendee responds to the event invitation.
588              # - "agenda" - An agenda with the events of the day (sent out in the morning).
589              # Required when adding a notification.
590          "method": "A String", # The method used to deliver the notification. Possible values are:
591              # - "email" - Notifications are sent via email.
592              # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See  Google Calendar SMS notifications to be removed for more information.
593              # Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.
594              # Required when adding a notification.
595        },
596      ],
597    },
598    "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
599    "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.
600    "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
601      {
602        "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).
603            # Required when adding a reminder.
604        "method": "A String", # The method used by this reminder. Possible values are:
605            # - "email" - Reminders are sent via email.
606            # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See  Google Calendar SMS notifications to be removed for more information.
607            # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
608            # - "popup" - Reminders are sent via a UI popup.
609            # Required when adding a reminder.
610      },
611    ],
612    "description": "A String", # Description of the calendar. Optional. Read-only.
613    "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
614    "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.
615    "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
616    "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
617      "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
618          # The possible values are:
619          # - "eventHangout"
620          # - "eventNamedHangout"
621          # - "hangoutsMeet"  Optional.
622        "A String",
623      ],
624    },
625    "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
626    "etag": "A String", # ETag of the resource.
627    "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
628    "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.
629    "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
630    "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
631    "hidden": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
632    "summary": "A String", # Title of the calendar. Read-only.
633    "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
634        # - "freeBusyReader" - Provides read access to free/busy information.
635        # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
636        # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
637        # - "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.
638    "id": "A String", # Identifier of the calendar.
639  }
640
641  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.
642
643Returns:
644  An object of the form:
645
646    {
647      "notificationSettings": { # The notifications that the authenticated user is receiving for this calendar.
648        "notifications": [ # The list of notifications set for this calendar.
649          {
650            "type": "A String", # The type of notification. Possible values are:
651                # - "eventCreation" - Notification sent when a new event is put on the calendar.
652                # - "eventChange" - Notification sent when an event is changed.
653                # - "eventCancellation" - Notification sent when an event is cancelled.
654                # - "eventResponse" - Notification sent when an attendee responds to the event invitation.
655                # - "agenda" - An agenda with the events of the day (sent out in the morning).
656                # Required when adding a notification.
657            "method": "A String", # The method used to deliver the notification. Possible values are:
658                # - "email" - Notifications are sent via email.
659                # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See  Google Calendar SMS notifications to be removed for more information.
660                # Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.
661                # Required when adding a notification.
662          },
663        ],
664      },
665      "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
666      "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.
667      "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
668        {
669          "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).
670              # Required when adding a reminder.
671          "method": "A String", # The method used by this reminder. Possible values are:
672              # - "email" - Reminders are sent via email.
673              # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See  Google Calendar SMS notifications to be removed for more information.
674              # Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
675              # - "popup" - Reminders are sent via a UI popup.
676              # Required when adding a reminder.
677        },
678      ],
679      "description": "A String", # Description of the calendar. Optional. Read-only.
680      "deleted": false, # Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
681      "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.
682      "selected": false, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
683      "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
684        "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
685            # The possible values are:
686            # - "eventHangout"
687            # - "eventNamedHangout"
688            # - "hangoutsMeet"  Optional.
689          "A String",
690        ],
691      },
692      "primary": false, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
693      "etag": "A String", # ETag of the resource.
694      "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
695      "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.
696      "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
697      "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
698      "hidden": false, # Whether the calendar has been hidden from the list. Optional. The default is False.
699      "summary": "A String", # Title of the calendar. Read-only.
700      "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
701          # - "freeBusyReader" - Provides read access to free/busy information.
702          # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
703          # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
704          # - "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.
705      "id": "A String", # Identifier of the calendar.
706    }</pre>
707</div>
708
709<div class="method">
710    <code class="details" id="watch">watch(body, syncToken=None, minAccessRole=None, maxResults=None, showDeleted=None, showHidden=None, pageToken=None)</code>
711  <pre>Watch for changes to CalendarList resources.
712
713Args:
714  body: object, The request body. (required)
715    The object takes the form of:
716
717{
718    "resourceUri": "A String", # A version-specific identifier for the watched resource.
719    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
720    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
721    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
722    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
723    "params": { # Additional parameters controlling delivery channel behavior. Optional.
724      "a_key": "A String", # Declares a new parameter by name.
725    },
726    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
727    "address": "A String", # The address where notifications are delivered for this channel.
728    "type": "A String", # The type of delivery mechanism used for this channel.
729    "id": "A String", # A UUID or similar unique string that identifies this channel.
730  }
731
732  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.
733To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.
734If 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.
735Learn more about incremental synchronization.
736Optional. The default is to return all entries.
737  minAccessRole: string, The minimum access role for the user in the returned entries. Optional. The default is no restriction.
738    Allowed values
739      freeBusyReader - The user can read free/busy information.
740      owner - The user can read and modify events and access control lists.
741      reader - The user can read events that are not private.
742      writer - The user can read and modify events.
743  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.
744  showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False.
745  showHidden: boolean, Whether to show hidden entries. Optional. The default is False.
746  pageToken: string, Token specifying which result page to return. Optional.
747
748Returns:
749  An object of the form:
750
751    {
752      "resourceUri": "A String", # A version-specific identifier for the watched resource.
753      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
754      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
755      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
756      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
757      "params": { # Additional parameters controlling delivery channel behavior. Optional.
758        "a_key": "A String", # Declares a new parameter by name.
759      },
760      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
761      "address": "A String", # The address where notifications are delivered for this channel.
762      "type": "A String", # The type of delivery mechanism used for this channel.
763      "id": "A String", # A UUID or similar unique string that identifies this channel.
764    }</pre>
765</div>
766
767</body></html>