Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / calendar_v3.events.html
blob: 0b35ed954bf39d81ed177d1da6dd6517ebef44bc [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame^]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.events.html">events</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(calendarId, eventId, sendNotifications=None)</a></code></p>
79<p class="firstline">Deletes an event.</p>
80<p class="toc_element">
81 <code><a href="#get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</a></code></p>
82<p class="firstline">Returns an event.</p>
83<p class="toc_element">
84 <code><a href="#import_">import_(calendarId, body)</a></code></p>
85<p class="firstline">Imports an event. This operation is used to add a private copy of an existing event to a calendar.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(calendarId, body, sendNotifications=None, maxAttendees=None)</a></code></p>
88<p class="firstline">Creates an event.</p>
89<p class="toc_element">
90 <code><a href="#instances">instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</a></code></p>
91<p class="firstline">Returns instances of the specified recurring event.</p>
92<p class="toc_element">
93 <code><a href="#instances_next">instances_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#list">list(calendarId, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</a></code></p>
97<p class="firstline">Returns events on the specified calendar.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#move">move(calendarId, eventId, destination, sendNotifications=None)</a></code></p>
103<p class="firstline">Moves an event to another calendar, i.e. changes an event's organizer.</p>
104<p class="toc_element">
105 <code><a href="#patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</a></code></p>
106<p class="firstline">Updates an event. This method supports patch semantics.</p>
107<p class="toc_element">
108 <code><a href="#quickAdd">quickAdd(calendarId, text, sendNotifications=None)</a></code></p>
109<p class="firstline">Creates an event based on a simple text string.</p>
110<p class="toc_element">
111 <code><a href="#update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</a></code></p>
112<p class="firstline">Updates an event.</p>
113<p class="toc_element">
114 <code><a href="#watch">watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</a></code></p>
115<p class="firstline">Watch for changes to Events resources.</p>
116<h3>Method Details</h3>
117<div class="method">
118 <code class="details" id="delete">delete(calendarId, eventId, sendNotifications=None)</code>
119 <pre>Deletes an event.
120
121Args:
122 calendarId: string, Calendar identifier. (required)
123 eventId: string, Event identifier. (required)
124 sendNotifications: boolean, Whether to send notifications about the deletion of the event. Optional. The default is False.
125</pre>
126</div>
127
128<div class="method">
129 <code class="details" id="get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</code>
130 <pre>Returns an event.
131
132Args:
133 calendarId: string, Calendar identifier. (required)
134 eventId: string, Event identifier. (required)
135 alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
136 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
137 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
138
139Returns:
140 An object of the form:
141
142 {
143 "creator": { # The creator of the event. Read-only.
144 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
145 "displayName": "A String", # The creator's name, if available.
146 "email": "A String", # The creator's email address, if available.
147 "id": "A String", # The creator's Profile ID, if available.
148 },
149 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
150 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
151 "displayName": "A String", # The organizer's name, if available.
152 "email": "A String", # The organizer's email address, if available.
153 "id": "A String", # The organizer's Profile ID, if available.
154 },
155 "summary": "A String", # Title of the event.
156 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
157 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
158 # - the length of the ID must be between 5 and 1024 characters
159 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
160 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
161 "attendees": [ # The attendees of the event.
162 {
163 "comment": "A String", # The attendee's response comment. Optional.
164 "displayName": "A String", # The attendee's name, if available. Optional.
165 "responseStatus": "A String", # The attendee's response status. Possible values are:
166 # - "needsAction" - The attendee has not responded to the invitation.
167 # - "declined" - The attendee has declined the invitation.
168 # - "tentative" - The attendee has tentatively accepted the invitation.
169 # - "accepted" - The attendee has accepted the invitation.
170 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
171 "id": "A String", # The attendee's Profile ID, if available.
172 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
173 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
174 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
175 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
176 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
177 },
178 ],
179 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
180 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
181 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
182 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
183 },
184 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
185 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
186 "A String",
187 ],
188 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
189 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
190 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
191 },
192 "etag": "A String", # ETag of the resource.
193 "location": "A String", # Geographic location of the event as free-form text. Optional.
194 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
195 "gadget": { # A gadget that extends this event.
196 "preferences": { # Preferences.
197 "a_key": "A String", # The preference name and corresponding value.
198 },
199 "title": "A String", # The gadget's title.
200 "height": 42, # The gadget's height in pixels. Optional.
201 "width": 42, # The gadget's width in pixels. Optional.
202 "link": "A String", # The gadget's URL.
203 "type": "A String", # The gadget's type.
204 "display": "A String", # The gadget's display mode. Optional. Possible values are:
205 # - "icon" - The gadget displays next to the event's title in the calendar view.
206 # - "chip" - The gadget displays when the event is clicked.
207 "iconLink": "A String", # The gadget's icon URL.
208 },
209 "status": "A String", # Status of the event. Optional. Possible values are:
210 # - "confirmed" - The event is confirmed. This is the default status.
211 # - "tentative" - The event is tentatively confirmed.
212 # - "cancelled" - The event is cancelled.
213 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
214 "description": "A String", # Description of the event. Optional.
215 "iCalUID": "A String", # Event ID in the iCalendar format.
216 "extendedProperties": { # Extended properties of the event.
217 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
218 "a_key": "A String", # The name of the shared property and the corresponding value.
219 },
220 "private": { # Properties that are private to the copy of the event that appears on this calendar.
221 "a_key": "A String", # The name of the private property and the corresponding value.
222 },
223 },
224 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
225 "sequence": 42, # Sequence number as per iCalendar.
226 "visibility": "default", # Visibility of the event. Optional. Possible values are:
227 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
228 # - "public" - The event is public and event details are visible to all readers of the calendar.
229 # - "private" - The event is private and only event attendees may view event details.
230 # - "confidential" - The event is private. This value is provided for compatibility reasons.
231 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
232 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
233 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
234 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
235 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
236 },
237 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
238 "kind": "calendar#event", # Type of the resource ("calendar#event").
239 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
240 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
241 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
242 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
243 "reminders": { # Information about the event's reminders for the authenticated user.
244 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
245 {
246 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
247 "method": "A String", # The method used by this reminder. Possible values are:
248 # - "email" - Reminders are sent via email.
249 # - "sms" - Reminders are sent via SMS.
250 # - "popup" - Reminders are sent via a UI popup.
251 },
252 ],
253 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
254 },
255 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
256 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
257 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
258 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
259 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
260 },
261 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
262 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
263 # - "opaque" - The event blocks time on the calendar. This is the default value.
264 # - "transparent" - The event does not block time on the calendar.
265 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
266 }</pre>
267</div>
268
269<div class="method">
270 <code class="details" id="import_">import_(calendarId, body)</code>
271 <pre>Imports an event. This operation is used to add a private copy of an existing event to a calendar.
272
273Args:
274 calendarId: string, Calendar identifier. (required)
275 body: object, The request body. (required)
276 The object takes the form of:
277
278{
279 "creator": { # The creator of the event. Read-only.
280 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
281 "displayName": "A String", # The creator's name, if available.
282 "email": "A String", # The creator's email address, if available.
283 "id": "A String", # The creator's Profile ID, if available.
284 },
285 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
286 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
287 "displayName": "A String", # The organizer's name, if available.
288 "email": "A String", # The organizer's email address, if available.
289 "id": "A String", # The organizer's Profile ID, if available.
290 },
291 "summary": "A String", # Title of the event.
292 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
293 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
294 # - the length of the ID must be between 5 and 1024 characters
295 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
296 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
297 "attendees": [ # The attendees of the event.
298 {
299 "comment": "A String", # The attendee's response comment. Optional.
300 "displayName": "A String", # The attendee's name, if available. Optional.
301 "responseStatus": "A String", # The attendee's response status. Possible values are:
302 # - "needsAction" - The attendee has not responded to the invitation.
303 # - "declined" - The attendee has declined the invitation.
304 # - "tentative" - The attendee has tentatively accepted the invitation.
305 # - "accepted" - The attendee has accepted the invitation.
306 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
307 "id": "A String", # The attendee's Profile ID, if available.
308 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
309 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
310 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
311 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
312 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
313 },
314 ],
315 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
316 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
317 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
318 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
319 },
320 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
321 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
322 "A String",
323 ],
324 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
325 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
326 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
327 },
328 "etag": "A String", # ETag of the resource.
329 "location": "A String", # Geographic location of the event as free-form text. Optional.
330 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
331 "gadget": { # A gadget that extends this event.
332 "preferences": { # Preferences.
333 "a_key": "A String", # The preference name and corresponding value.
334 },
335 "title": "A String", # The gadget's title.
336 "height": 42, # The gadget's height in pixels. Optional.
337 "width": 42, # The gadget's width in pixels. Optional.
338 "link": "A String", # The gadget's URL.
339 "type": "A String", # The gadget's type.
340 "display": "A String", # The gadget's display mode. Optional. Possible values are:
341 # - "icon" - The gadget displays next to the event's title in the calendar view.
342 # - "chip" - The gadget displays when the event is clicked.
343 "iconLink": "A String", # The gadget's icon URL.
344 },
345 "status": "A String", # Status of the event. Optional. Possible values are:
346 # - "confirmed" - The event is confirmed. This is the default status.
347 # - "tentative" - The event is tentatively confirmed.
348 # - "cancelled" - The event is cancelled.
349 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
350 "description": "A String", # Description of the event. Optional.
351 "iCalUID": "A String", # Event ID in the iCalendar format.
352 "extendedProperties": { # Extended properties of the event.
353 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
354 "a_key": "A String", # The name of the shared property and the corresponding value.
355 },
356 "private": { # Properties that are private to the copy of the event that appears on this calendar.
357 "a_key": "A String", # The name of the private property and the corresponding value.
358 },
359 },
360 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
361 "sequence": 42, # Sequence number as per iCalendar.
362 "visibility": "default", # Visibility of the event. Optional. Possible values are:
363 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
364 # - "public" - The event is public and event details are visible to all readers of the calendar.
365 # - "private" - The event is private and only event attendees may view event details.
366 # - "confidential" - The event is private. This value is provided for compatibility reasons.
367 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
368 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
369 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
370 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
371 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
372 },
373 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
374 "kind": "calendar#event", # Type of the resource ("calendar#event").
375 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
376 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
377 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
378 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
379 "reminders": { # Information about the event's reminders for the authenticated user.
380 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
381 {
382 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
383 "method": "A String", # The method used by this reminder. Possible values are:
384 # - "email" - Reminders are sent via email.
385 # - "sms" - Reminders are sent via SMS.
386 # - "popup" - Reminders are sent via a UI popup.
387 },
388 ],
389 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
390 },
391 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
392 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
393 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
394 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
395 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
396 },
397 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
398 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
399 # - "opaque" - The event blocks time on the calendar. This is the default value.
400 # - "transparent" - The event does not block time on the calendar.
401 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
402 }
403
404
405Returns:
406 An object of the form:
407
408 {
409 "creator": { # The creator of the event. Read-only.
410 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
411 "displayName": "A String", # The creator's name, if available.
412 "email": "A String", # The creator's email address, if available.
413 "id": "A String", # The creator's Profile ID, if available.
414 },
415 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
416 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
417 "displayName": "A String", # The organizer's name, if available.
418 "email": "A String", # The organizer's email address, if available.
419 "id": "A String", # The organizer's Profile ID, if available.
420 },
421 "summary": "A String", # Title of the event.
422 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
423 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
424 # - the length of the ID must be between 5 and 1024 characters
425 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
426 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
427 "attendees": [ # The attendees of the event.
428 {
429 "comment": "A String", # The attendee's response comment. Optional.
430 "displayName": "A String", # The attendee's name, if available. Optional.
431 "responseStatus": "A String", # The attendee's response status. Possible values are:
432 # - "needsAction" - The attendee has not responded to the invitation.
433 # - "declined" - The attendee has declined the invitation.
434 # - "tentative" - The attendee has tentatively accepted the invitation.
435 # - "accepted" - The attendee has accepted the invitation.
436 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
437 "id": "A String", # The attendee's Profile ID, if available.
438 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
439 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
440 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
441 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
442 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
443 },
444 ],
445 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
446 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
447 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
448 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
449 },
450 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
451 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
452 "A String",
453 ],
454 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
455 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
456 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
457 },
458 "etag": "A String", # ETag of the resource.
459 "location": "A String", # Geographic location of the event as free-form text. Optional.
460 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
461 "gadget": { # A gadget that extends this event.
462 "preferences": { # Preferences.
463 "a_key": "A String", # The preference name and corresponding value.
464 },
465 "title": "A String", # The gadget's title.
466 "height": 42, # The gadget's height in pixels. Optional.
467 "width": 42, # The gadget's width in pixels. Optional.
468 "link": "A String", # The gadget's URL.
469 "type": "A String", # The gadget's type.
470 "display": "A String", # The gadget's display mode. Optional. Possible values are:
471 # - "icon" - The gadget displays next to the event's title in the calendar view.
472 # - "chip" - The gadget displays when the event is clicked.
473 "iconLink": "A String", # The gadget's icon URL.
474 },
475 "status": "A String", # Status of the event. Optional. Possible values are:
476 # - "confirmed" - The event is confirmed. This is the default status.
477 # - "tentative" - The event is tentatively confirmed.
478 # - "cancelled" - The event is cancelled.
479 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
480 "description": "A String", # Description of the event. Optional.
481 "iCalUID": "A String", # Event ID in the iCalendar format.
482 "extendedProperties": { # Extended properties of the event.
483 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
484 "a_key": "A String", # The name of the shared property and the corresponding value.
485 },
486 "private": { # Properties that are private to the copy of the event that appears on this calendar.
487 "a_key": "A String", # The name of the private property and the corresponding value.
488 },
489 },
490 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
491 "sequence": 42, # Sequence number as per iCalendar.
492 "visibility": "default", # Visibility of the event. Optional. Possible values are:
493 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
494 # - "public" - The event is public and event details are visible to all readers of the calendar.
495 # - "private" - The event is private and only event attendees may view event details.
496 # - "confidential" - The event is private. This value is provided for compatibility reasons.
497 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
498 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
499 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
500 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
501 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
502 },
503 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
504 "kind": "calendar#event", # Type of the resource ("calendar#event").
505 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
506 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
507 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
508 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
509 "reminders": { # Information about the event's reminders for the authenticated user.
510 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
511 {
512 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
513 "method": "A String", # The method used by this reminder. Possible values are:
514 # - "email" - Reminders are sent via email.
515 # - "sms" - Reminders are sent via SMS.
516 # - "popup" - Reminders are sent via a UI popup.
517 },
518 ],
519 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
520 },
521 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
522 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
523 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
524 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
525 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
526 },
527 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
528 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
529 # - "opaque" - The event blocks time on the calendar. This is the default value.
530 # - "transparent" - The event does not block time on the calendar.
531 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
532 }</pre>
533</div>
534
535<div class="method">
536 <code class="details" id="insert">insert(calendarId, body, sendNotifications=None, maxAttendees=None)</code>
537 <pre>Creates an event.
538
539Args:
540 calendarId: string, Calendar identifier. (required)
541 body: object, The request body. (required)
542 The object takes the form of:
543
544{
545 "creator": { # The creator of the event. Read-only.
546 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
547 "displayName": "A String", # The creator's name, if available.
548 "email": "A String", # The creator's email address, if available.
549 "id": "A String", # The creator's Profile ID, if available.
550 },
551 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
552 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
553 "displayName": "A String", # The organizer's name, if available.
554 "email": "A String", # The organizer's email address, if available.
555 "id": "A String", # The organizer's Profile ID, if available.
556 },
557 "summary": "A String", # Title of the event.
558 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
559 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
560 # - the length of the ID must be between 5 and 1024 characters
561 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
562 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
563 "attendees": [ # The attendees of the event.
564 {
565 "comment": "A String", # The attendee's response comment. Optional.
566 "displayName": "A String", # The attendee's name, if available. Optional.
567 "responseStatus": "A String", # The attendee's response status. Possible values are:
568 # - "needsAction" - The attendee has not responded to the invitation.
569 # - "declined" - The attendee has declined the invitation.
570 # - "tentative" - The attendee has tentatively accepted the invitation.
571 # - "accepted" - The attendee has accepted the invitation.
572 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
573 "id": "A String", # The attendee's Profile ID, if available.
574 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
575 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
576 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
577 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
578 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
579 },
580 ],
581 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
582 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
583 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
584 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
585 },
586 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
587 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
588 "A String",
589 ],
590 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
591 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
592 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
593 },
594 "etag": "A String", # ETag of the resource.
595 "location": "A String", # Geographic location of the event as free-form text. Optional.
596 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
597 "gadget": { # A gadget that extends this event.
598 "preferences": { # Preferences.
599 "a_key": "A String", # The preference name and corresponding value.
600 },
601 "title": "A String", # The gadget's title.
602 "height": 42, # The gadget's height in pixels. Optional.
603 "width": 42, # The gadget's width in pixels. Optional.
604 "link": "A String", # The gadget's URL.
605 "type": "A String", # The gadget's type.
606 "display": "A String", # The gadget's display mode. Optional. Possible values are:
607 # - "icon" - The gadget displays next to the event's title in the calendar view.
608 # - "chip" - The gadget displays when the event is clicked.
609 "iconLink": "A String", # The gadget's icon URL.
610 },
611 "status": "A String", # Status of the event. Optional. Possible values are:
612 # - "confirmed" - The event is confirmed. This is the default status.
613 # - "tentative" - The event is tentatively confirmed.
614 # - "cancelled" - The event is cancelled.
615 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
616 "description": "A String", # Description of the event. Optional.
617 "iCalUID": "A String", # Event ID in the iCalendar format.
618 "extendedProperties": { # Extended properties of the event.
619 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
620 "a_key": "A String", # The name of the shared property and the corresponding value.
621 },
622 "private": { # Properties that are private to the copy of the event that appears on this calendar.
623 "a_key": "A String", # The name of the private property and the corresponding value.
624 },
625 },
626 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
627 "sequence": 42, # Sequence number as per iCalendar.
628 "visibility": "default", # Visibility of the event. Optional. Possible values are:
629 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
630 # - "public" - The event is public and event details are visible to all readers of the calendar.
631 # - "private" - The event is private and only event attendees may view event details.
632 # - "confidential" - The event is private. This value is provided for compatibility reasons.
633 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
634 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
635 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
636 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
637 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
638 },
639 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
640 "kind": "calendar#event", # Type of the resource ("calendar#event").
641 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
642 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
643 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
644 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
645 "reminders": { # Information about the event's reminders for the authenticated user.
646 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
647 {
648 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
649 "method": "A String", # The method used by this reminder. Possible values are:
650 # - "email" - Reminders are sent via email.
651 # - "sms" - Reminders are sent via SMS.
652 # - "popup" - Reminders are sent via a UI popup.
653 },
654 ],
655 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
656 },
657 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
658 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
659 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
660 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
661 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
662 },
663 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
664 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
665 # - "opaque" - The event blocks time on the calendar. This is the default value.
666 # - "transparent" - The event does not block time on the calendar.
667 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
668 }
669
670 sendNotifications: boolean, Whether to send notifications about the creation of the new event. Optional. The default is False.
671 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
672
673Returns:
674 An object of the form:
675
676 {
677 "creator": { # The creator of the event. Read-only.
678 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
679 "displayName": "A String", # The creator's name, if available.
680 "email": "A String", # The creator's email address, if available.
681 "id": "A String", # The creator's Profile ID, if available.
682 },
683 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
684 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
685 "displayName": "A String", # The organizer's name, if available.
686 "email": "A String", # The organizer's email address, if available.
687 "id": "A String", # The organizer's Profile ID, if available.
688 },
689 "summary": "A String", # Title of the event.
690 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
691 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
692 # - the length of the ID must be between 5 and 1024 characters
693 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
694 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
695 "attendees": [ # The attendees of the event.
696 {
697 "comment": "A String", # The attendee's response comment. Optional.
698 "displayName": "A String", # The attendee's name, if available. Optional.
699 "responseStatus": "A String", # The attendee's response status. Possible values are:
700 # - "needsAction" - The attendee has not responded to the invitation.
701 # - "declined" - The attendee has declined the invitation.
702 # - "tentative" - The attendee has tentatively accepted the invitation.
703 # - "accepted" - The attendee has accepted the invitation.
704 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
705 "id": "A String", # The attendee's Profile ID, if available.
706 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
707 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
708 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
709 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
710 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
711 },
712 ],
713 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
714 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
715 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
716 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
717 },
718 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
719 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
720 "A String",
721 ],
722 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
723 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
724 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
725 },
726 "etag": "A String", # ETag of the resource.
727 "location": "A String", # Geographic location of the event as free-form text. Optional.
728 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
729 "gadget": { # A gadget that extends this event.
730 "preferences": { # Preferences.
731 "a_key": "A String", # The preference name and corresponding value.
732 },
733 "title": "A String", # The gadget's title.
734 "height": 42, # The gadget's height in pixels. Optional.
735 "width": 42, # The gadget's width in pixels. Optional.
736 "link": "A String", # The gadget's URL.
737 "type": "A String", # The gadget's type.
738 "display": "A String", # The gadget's display mode. Optional. Possible values are:
739 # - "icon" - The gadget displays next to the event's title in the calendar view.
740 # - "chip" - The gadget displays when the event is clicked.
741 "iconLink": "A String", # The gadget's icon URL.
742 },
743 "status": "A String", # Status of the event. Optional. Possible values are:
744 # - "confirmed" - The event is confirmed. This is the default status.
745 # - "tentative" - The event is tentatively confirmed.
746 # - "cancelled" - The event is cancelled.
747 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
748 "description": "A String", # Description of the event. Optional.
749 "iCalUID": "A String", # Event ID in the iCalendar format.
750 "extendedProperties": { # Extended properties of the event.
751 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
752 "a_key": "A String", # The name of the shared property and the corresponding value.
753 },
754 "private": { # Properties that are private to the copy of the event that appears on this calendar.
755 "a_key": "A String", # The name of the private property and the corresponding value.
756 },
757 },
758 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
759 "sequence": 42, # Sequence number as per iCalendar.
760 "visibility": "default", # Visibility of the event. Optional. Possible values are:
761 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
762 # - "public" - The event is public and event details are visible to all readers of the calendar.
763 # - "private" - The event is private and only event attendees may view event details.
764 # - "confidential" - The event is private. This value is provided for compatibility reasons.
765 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
766 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
767 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
768 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
769 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
770 },
771 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
772 "kind": "calendar#event", # Type of the resource ("calendar#event").
773 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
774 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
775 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
776 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
777 "reminders": { # Information about the event's reminders for the authenticated user.
778 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
779 {
780 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
781 "method": "A String", # The method used by this reminder. Possible values are:
782 # - "email" - Reminders are sent via email.
783 # - "sms" - Reminders are sent via SMS.
784 # - "popup" - Reminders are sent via a UI popup.
785 },
786 ],
787 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
788 },
789 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
790 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
791 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
792 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
793 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
794 },
795 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
796 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
797 # - "opaque" - The event blocks time on the calendar. This is the default value.
798 # - "transparent" - The event does not block time on the calendar.
799 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
800 }</pre>
801</div>
802
803<div class="method">
804 <code class="details" id="instances">instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</code>
805 <pre>Returns instances of the specified recurring event.
806
807Args:
808 calendarId: string, Calendar identifier. (required)
809 eventId: string, Recurring event identifier. (required)
810 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
811 showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events will still be included if 'singleEvents' is False. Optional. The default is False.
812 alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
813 pageToken: string, Token specifying which result page to return. Optional.
814 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
815 maxResults: integer, Maximum number of events returned on one result page. Optional.
816 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
817 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
818 originalStart: string, The original start time of the instance in the result. Optional.
819
820Returns:
821 An object of the form:
822
823 {
824 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
825 "kind": "calendar#events", # Type of the collection ("calendar#events").
826 "defaultReminders": [ # The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have 'reminders.useDefault' set to 'true').
827 {
828 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
829 "method": "A String", # The method used by this reminder. Possible values are:
830 # - "email" - Reminders are sent via email.
831 # - "sms" - Reminders are sent via SMS.
832 # - "popup" - Reminders are sent via a UI popup.
833 },
834 ],
835 "description": "A String", # Description of the calendar. Read-only.
836 "items": [ # List of events on the calendar.
837 {
838 "creator": { # The creator of the event. Read-only.
839 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
840 "displayName": "A String", # The creator's name, if available.
841 "email": "A String", # The creator's email address, if available.
842 "id": "A String", # The creator's Profile ID, if available.
843 },
844 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
845 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
846 "displayName": "A String", # The organizer's name, if available.
847 "email": "A String", # The organizer's email address, if available.
848 "id": "A String", # The organizer's Profile ID, if available.
849 },
850 "summary": "A String", # Title of the event.
851 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
852 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
853 # - the length of the ID must be between 5 and 1024 characters
854 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
855 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
856 "attendees": [ # The attendees of the event.
857 {
858 "comment": "A String", # The attendee's response comment. Optional.
859 "displayName": "A String", # The attendee's name, if available. Optional.
860 "responseStatus": "A String", # The attendee's response status. Possible values are:
861 # - "needsAction" - The attendee has not responded to the invitation.
862 # - "declined" - The attendee has declined the invitation.
863 # - "tentative" - The attendee has tentatively accepted the invitation.
864 # - "accepted" - The attendee has accepted the invitation.
865 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
866 "id": "A String", # The attendee's Profile ID, if available.
867 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
868 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
869 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
870 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
871 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
872 },
873 ],
874 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
875 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
876 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
877 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
878 },
879 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
880 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
881 "A String",
882 ],
883 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
884 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
885 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
886 },
887 "etag": "A String", # ETag of the resource.
888 "location": "A String", # Geographic location of the event as free-form text. Optional.
889 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
890 "gadget": { # A gadget that extends this event.
891 "preferences": { # Preferences.
892 "a_key": "A String", # The preference name and corresponding value.
893 },
894 "title": "A String", # The gadget's title.
895 "height": 42, # The gadget's height in pixels. Optional.
896 "width": 42, # The gadget's width in pixels. Optional.
897 "link": "A String", # The gadget's URL.
898 "type": "A String", # The gadget's type.
899 "display": "A String", # The gadget's display mode. Optional. Possible values are:
900 # - "icon" - The gadget displays next to the event's title in the calendar view.
901 # - "chip" - The gadget displays when the event is clicked.
902 "iconLink": "A String", # The gadget's icon URL.
903 },
904 "status": "A String", # Status of the event. Optional. Possible values are:
905 # - "confirmed" - The event is confirmed. This is the default status.
906 # - "tentative" - The event is tentatively confirmed.
907 # - "cancelled" - The event is cancelled.
908 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
909 "description": "A String", # Description of the event. Optional.
910 "iCalUID": "A String", # Event ID in the iCalendar format.
911 "extendedProperties": { # Extended properties of the event.
912 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
913 "a_key": "A String", # The name of the shared property and the corresponding value.
914 },
915 "private": { # Properties that are private to the copy of the event that appears on this calendar.
916 "a_key": "A String", # The name of the private property and the corresponding value.
917 },
918 },
919 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
920 "sequence": 42, # Sequence number as per iCalendar.
921 "visibility": "default", # Visibility of the event. Optional. Possible values are:
922 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
923 # - "public" - The event is public and event details are visible to all readers of the calendar.
924 # - "private" - The event is private and only event attendees may view event details.
925 # - "confidential" - The event is private. This value is provided for compatibility reasons.
926 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
927 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
928 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
929 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
930 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
931 },
932 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
933 "kind": "calendar#event", # Type of the resource ("calendar#event").
934 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
935 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
936 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
937 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
938 "reminders": { # Information about the event's reminders for the authenticated user.
939 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
940 {
941 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
942 "method": "A String", # The method used by this reminder. Possible values are:
943 # - "email" - Reminders are sent via email.
944 # - "sms" - Reminders are sent via SMS.
945 # - "popup" - Reminders are sent via a UI popup.
946 },
947 ],
948 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
949 },
950 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
951 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
952 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
953 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
954 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
955 },
956 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
957 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
958 # - "opaque" - The event blocks time on the calendar. This is the default value.
959 # - "transparent" - The event does not block time on the calendar.
960 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
961 },
962 ],
963 "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
964 "summary": "A String", # Title of the calendar. Read-only.
965 "etag": "A String", # ETag of the collection.
966 "timeZone": "A String", # The time zone of the calendar. Read-only.
967 "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.
968 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
969 # - "none" - The user has no access.
970 # - "freeBusyReader" - The user has read access to free/busy information.
971 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
972 # - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
973 # - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
974 }</pre>
975</div>
976
977<div class="method">
978 <code class="details" id="instances_next">instances_next(previous_request, previous_response)</code>
979 <pre>Retrieves the next page of results.
980
981Args:
982 previous_request: The request for the previous page. (required)
983 previous_response: The response from the request for the previous page. (required)
984
985Returns:
986 A request object that you can call 'execute()' on to request the next
987 page. Returns None if there are no more items in the collection.
988 </pre>
989</div>
990
991<div class="method">
992 <code class="details" id="list">list(calendarId, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</code>
993 <pre>Returns events on the specified calendar.
994
995Args:
996 calendarId: string, Calendar identifier. (required)
997 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
998 Allowed values
999 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter "singleEvents" is True)
1000 updated - Order by last modification time (ascending).
1001 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
1002 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
1003 privateExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
1004 pageToken: string, Token specifying which result page to return. Optional.
1005 updatedMin: string, Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
1006 singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
1007 alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
1008 showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if 'showDeleted' and 'singleEvents' are both False. If 'showDeleted' and 'singleEvents' are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
1009 sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
1010 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
1011 syncToken: string, Token obtained from the 'nextSyncToken' field returned on the last result page of the previous method's call. It makes the result of this call contain only entries that have changed since the last call. Optional. The default is to return all entries.
1012 iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.
1013 maxResults: integer, Maximum number of events returned on one result page. Optional.
1014 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
1015 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
1016 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
1017
1018Returns:
1019 An object of the form:
1020
1021 {
1022 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
1023 "kind": "calendar#events", # Type of the collection ("calendar#events").
1024 "defaultReminders": [ # The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have 'reminders.useDefault' set to 'true').
1025 {
1026 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1027 "method": "A String", # The method used by this reminder. Possible values are:
1028 # - "email" - Reminders are sent via email.
1029 # - "sms" - Reminders are sent via SMS.
1030 # - "popup" - Reminders are sent via a UI popup.
1031 },
1032 ],
1033 "description": "A String", # Description of the calendar. Read-only.
1034 "items": [ # List of events on the calendar.
1035 {
1036 "creator": { # The creator of the event. Read-only.
1037 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1038 "displayName": "A String", # The creator's name, if available.
1039 "email": "A String", # The creator's email address, if available.
1040 "id": "A String", # The creator's Profile ID, if available.
1041 },
1042 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
1043 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1044 "displayName": "A String", # The organizer's name, if available.
1045 "email": "A String", # The organizer's email address, if available.
1046 "id": "A String", # The organizer's Profile ID, if available.
1047 },
1048 "summary": "A String", # Title of the event.
1049 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1050 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1051 # - the length of the ID must be between 5 and 1024 characters
1052 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1053 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1054 "attendees": [ # The attendees of the event.
1055 {
1056 "comment": "A String", # The attendee's response comment. Optional.
1057 "displayName": "A String", # The attendee's name, if available. Optional.
1058 "responseStatus": "A String", # The attendee's response status. Possible values are:
1059 # - "needsAction" - The attendee has not responded to the invitation.
1060 # - "declined" - The attendee has declined the invitation.
1061 # - "tentative" - The attendee has tentatively accepted the invitation.
1062 # - "accepted" - The attendee has accepted the invitation.
1063 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1064 "id": "A String", # The attendee's Profile ID, if available.
1065 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1066 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1067 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1068 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1069 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1070 },
1071 ],
1072 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1073 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1074 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1075 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1076 },
1077 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1078 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
1079 "A String",
1080 ],
1081 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1082 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1083 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1084 },
1085 "etag": "A String", # ETag of the resource.
1086 "location": "A String", # Geographic location of the event as free-form text. Optional.
1087 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1088 "gadget": { # A gadget that extends this event.
1089 "preferences": { # Preferences.
1090 "a_key": "A String", # The preference name and corresponding value.
1091 },
1092 "title": "A String", # The gadget's title.
1093 "height": 42, # The gadget's height in pixels. Optional.
1094 "width": 42, # The gadget's width in pixels. Optional.
1095 "link": "A String", # The gadget's URL.
1096 "type": "A String", # The gadget's type.
1097 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1098 # - "icon" - The gadget displays next to the event's title in the calendar view.
1099 # - "chip" - The gadget displays when the event is clicked.
1100 "iconLink": "A String", # The gadget's icon URL.
1101 },
1102 "status": "A String", # Status of the event. Optional. Possible values are:
1103 # - "confirmed" - The event is confirmed. This is the default status.
1104 # - "tentative" - The event is tentatively confirmed.
1105 # - "cancelled" - The event is cancelled.
1106 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1107 "description": "A String", # Description of the event. Optional.
1108 "iCalUID": "A String", # Event ID in the iCalendar format.
1109 "extendedProperties": { # Extended properties of the event.
1110 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1111 "a_key": "A String", # The name of the shared property and the corresponding value.
1112 },
1113 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1114 "a_key": "A String", # The name of the private property and the corresponding value.
1115 },
1116 },
1117 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1118 "sequence": 42, # Sequence number as per iCalendar.
1119 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1120 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1121 # - "public" - The event is public and event details are visible to all readers of the calendar.
1122 # - "private" - The event is private and only event attendees may view event details.
1123 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1124 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1125 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1126 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1127 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1128 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1129 },
1130 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
1131 "kind": "calendar#event", # Type of the resource ("calendar#event").
1132 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1133 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1134 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
1135 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1136 "reminders": { # Information about the event's reminders for the authenticated user.
1137 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
1138 {
1139 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1140 "method": "A String", # The method used by this reminder. Possible values are:
1141 # - "email" - Reminders are sent via email.
1142 # - "sms" - Reminders are sent via SMS.
1143 # - "popup" - Reminders are sent via a UI popup.
1144 },
1145 ],
1146 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1147 },
1148 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1149 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
1150 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1151 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1152 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1153 },
1154 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1155 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1156 # - "opaque" - The event blocks time on the calendar. This is the default value.
1157 # - "transparent" - The event does not block time on the calendar.
1158 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1159 },
1160 ],
1161 "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
1162 "summary": "A String", # Title of the calendar. Read-only.
1163 "etag": "A String", # ETag of the collection.
1164 "timeZone": "A String", # The time zone of the calendar. Read-only.
1165 "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.
1166 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
1167 # - "none" - The user has no access.
1168 # - "freeBusyReader" - The user has read access to free/busy information.
1169 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
1170 # - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
1171 # - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
1172 }</pre>
1173</div>
1174
1175<div class="method">
1176 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1177 <pre>Retrieves the next page of results.
1178
1179Args:
1180 previous_request: The request for the previous page. (required)
1181 previous_response: The response from the request for the previous page. (required)
1182
1183Returns:
1184 A request object that you can call 'execute()' on to request the next
1185 page. Returns None if there are no more items in the collection.
1186 </pre>
1187</div>
1188
1189<div class="method">
1190 <code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None)</code>
1191 <pre>Moves an event to another calendar, i.e. changes an event's organizer.
1192
1193Args:
1194 calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)
1195 eventId: string, Event identifier. (required)
1196 destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)
1197 sendNotifications: boolean, Whether to send notifications about the change of the event's organizer. Optional. The default is False.
1198
1199Returns:
1200 An object of the form:
1201
1202 {
1203 "creator": { # The creator of the event. Read-only.
1204 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1205 "displayName": "A String", # The creator's name, if available.
1206 "email": "A String", # The creator's email address, if available.
1207 "id": "A String", # The creator's Profile ID, if available.
1208 },
1209 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
1210 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1211 "displayName": "A String", # The organizer's name, if available.
1212 "email": "A String", # The organizer's email address, if available.
1213 "id": "A String", # The organizer's Profile ID, if available.
1214 },
1215 "summary": "A String", # Title of the event.
1216 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1217 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1218 # - the length of the ID must be between 5 and 1024 characters
1219 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1220 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1221 "attendees": [ # The attendees of the event.
1222 {
1223 "comment": "A String", # The attendee's response comment. Optional.
1224 "displayName": "A String", # The attendee's name, if available. Optional.
1225 "responseStatus": "A String", # The attendee's response status. Possible values are:
1226 # - "needsAction" - The attendee has not responded to the invitation.
1227 # - "declined" - The attendee has declined the invitation.
1228 # - "tentative" - The attendee has tentatively accepted the invitation.
1229 # - "accepted" - The attendee has accepted the invitation.
1230 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1231 "id": "A String", # The attendee's Profile ID, if available.
1232 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1233 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1234 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1235 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1236 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1237 },
1238 ],
1239 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1240 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1241 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1242 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1243 },
1244 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1245 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
1246 "A String",
1247 ],
1248 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1249 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1250 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1251 },
1252 "etag": "A String", # ETag of the resource.
1253 "location": "A String", # Geographic location of the event as free-form text. Optional.
1254 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1255 "gadget": { # A gadget that extends this event.
1256 "preferences": { # Preferences.
1257 "a_key": "A String", # The preference name and corresponding value.
1258 },
1259 "title": "A String", # The gadget's title.
1260 "height": 42, # The gadget's height in pixels. Optional.
1261 "width": 42, # The gadget's width in pixels. Optional.
1262 "link": "A String", # The gadget's URL.
1263 "type": "A String", # The gadget's type.
1264 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1265 # - "icon" - The gadget displays next to the event's title in the calendar view.
1266 # - "chip" - The gadget displays when the event is clicked.
1267 "iconLink": "A String", # The gadget's icon URL.
1268 },
1269 "status": "A String", # Status of the event. Optional. Possible values are:
1270 # - "confirmed" - The event is confirmed. This is the default status.
1271 # - "tentative" - The event is tentatively confirmed.
1272 # - "cancelled" - The event is cancelled.
1273 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1274 "description": "A String", # Description of the event. Optional.
1275 "iCalUID": "A String", # Event ID in the iCalendar format.
1276 "extendedProperties": { # Extended properties of the event.
1277 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1278 "a_key": "A String", # The name of the shared property and the corresponding value.
1279 },
1280 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1281 "a_key": "A String", # The name of the private property and the corresponding value.
1282 },
1283 },
1284 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1285 "sequence": 42, # Sequence number as per iCalendar.
1286 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1287 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1288 # - "public" - The event is public and event details are visible to all readers of the calendar.
1289 # - "private" - The event is private and only event attendees may view event details.
1290 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1291 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1292 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1293 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1294 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1295 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1296 },
1297 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
1298 "kind": "calendar#event", # Type of the resource ("calendar#event").
1299 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1300 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1301 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
1302 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1303 "reminders": { # Information about the event's reminders for the authenticated user.
1304 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
1305 {
1306 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1307 "method": "A String", # The method used by this reminder. Possible values are:
1308 # - "email" - Reminders are sent via email.
1309 # - "sms" - Reminders are sent via SMS.
1310 # - "popup" - Reminders are sent via a UI popup.
1311 },
1312 ],
1313 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1314 },
1315 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1316 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
1317 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1318 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1319 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1320 },
1321 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1322 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1323 # - "opaque" - The event blocks time on the calendar. This is the default value.
1324 # - "transparent" - The event does not block time on the calendar.
1325 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1326 }</pre>
1327</div>
1328
1329<div class="method">
1330 <code class="details" id="patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</code>
1331 <pre>Updates an event. This method supports patch semantics.
1332
1333Args:
1334 calendarId: string, Calendar identifier. (required)
1335 eventId: string, Event identifier. (required)
1336 body: object, The request body. (required)
1337 The object takes the form of:
1338
1339{
1340 "creator": { # The creator of the event. Read-only.
1341 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1342 "displayName": "A String", # The creator's name, if available.
1343 "email": "A String", # The creator's email address, if available.
1344 "id": "A String", # The creator's Profile ID, if available.
1345 },
1346 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
1347 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1348 "displayName": "A String", # The organizer's name, if available.
1349 "email": "A String", # The organizer's email address, if available.
1350 "id": "A String", # The organizer's Profile ID, if available.
1351 },
1352 "summary": "A String", # Title of the event.
1353 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1354 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1355 # - the length of the ID must be between 5 and 1024 characters
1356 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1357 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1358 "attendees": [ # The attendees of the event.
1359 {
1360 "comment": "A String", # The attendee's response comment. Optional.
1361 "displayName": "A String", # The attendee's name, if available. Optional.
1362 "responseStatus": "A String", # The attendee's response status. Possible values are:
1363 # - "needsAction" - The attendee has not responded to the invitation.
1364 # - "declined" - The attendee has declined the invitation.
1365 # - "tentative" - The attendee has tentatively accepted the invitation.
1366 # - "accepted" - The attendee has accepted the invitation.
1367 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1368 "id": "A String", # The attendee's Profile ID, if available.
1369 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1370 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1371 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1372 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1373 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1374 },
1375 ],
1376 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1377 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1378 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1379 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1380 },
1381 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1382 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
1383 "A String",
1384 ],
1385 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1386 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1387 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1388 },
1389 "etag": "A String", # ETag of the resource.
1390 "location": "A String", # Geographic location of the event as free-form text. Optional.
1391 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1392 "gadget": { # A gadget that extends this event.
1393 "preferences": { # Preferences.
1394 "a_key": "A String", # The preference name and corresponding value.
1395 },
1396 "title": "A String", # The gadget's title.
1397 "height": 42, # The gadget's height in pixels. Optional.
1398 "width": 42, # The gadget's width in pixels. Optional.
1399 "link": "A String", # The gadget's URL.
1400 "type": "A String", # The gadget's type.
1401 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1402 # - "icon" - The gadget displays next to the event's title in the calendar view.
1403 # - "chip" - The gadget displays when the event is clicked.
1404 "iconLink": "A String", # The gadget's icon URL.
1405 },
1406 "status": "A String", # Status of the event. Optional. Possible values are:
1407 # - "confirmed" - The event is confirmed. This is the default status.
1408 # - "tentative" - The event is tentatively confirmed.
1409 # - "cancelled" - The event is cancelled.
1410 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1411 "description": "A String", # Description of the event. Optional.
1412 "iCalUID": "A String", # Event ID in the iCalendar format.
1413 "extendedProperties": { # Extended properties of the event.
1414 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1415 "a_key": "A String", # The name of the shared property and the corresponding value.
1416 },
1417 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1418 "a_key": "A String", # The name of the private property and the corresponding value.
1419 },
1420 },
1421 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1422 "sequence": 42, # Sequence number as per iCalendar.
1423 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1424 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1425 # - "public" - The event is public and event details are visible to all readers of the calendar.
1426 # - "private" - The event is private and only event attendees may view event details.
1427 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1428 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1429 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1430 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1431 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1432 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1433 },
1434 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
1435 "kind": "calendar#event", # Type of the resource ("calendar#event").
1436 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1437 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1438 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
1439 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1440 "reminders": { # Information about the event's reminders for the authenticated user.
1441 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
1442 {
1443 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1444 "method": "A String", # The method used by this reminder. Possible values are:
1445 # - "email" - Reminders are sent via email.
1446 # - "sms" - Reminders are sent via SMS.
1447 # - "popup" - Reminders are sent via a UI popup.
1448 },
1449 ],
1450 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1451 },
1452 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1453 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
1454 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1455 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1456 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1457 },
1458 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1459 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1460 # - "opaque" - The event blocks time on the calendar. This is the default value.
1461 # - "transparent" - The event does not block time on the calendar.
1462 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1463 }
1464
1465 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
1466 alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
1467 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
1468
1469Returns:
1470 An object of the form:
1471
1472 {
1473 "creator": { # The creator of the event. Read-only.
1474 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1475 "displayName": "A String", # The creator's name, if available.
1476 "email": "A String", # The creator's email address, if available.
1477 "id": "A String", # The creator's Profile ID, if available.
1478 },
1479 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
1480 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1481 "displayName": "A String", # The organizer's name, if available.
1482 "email": "A String", # The organizer's email address, if available.
1483 "id": "A String", # The organizer's Profile ID, if available.
1484 },
1485 "summary": "A String", # Title of the event.
1486 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1487 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1488 # - the length of the ID must be between 5 and 1024 characters
1489 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1490 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1491 "attendees": [ # The attendees of the event.
1492 {
1493 "comment": "A String", # The attendee's response comment. Optional.
1494 "displayName": "A String", # The attendee's name, if available. Optional.
1495 "responseStatus": "A String", # The attendee's response status. Possible values are:
1496 # - "needsAction" - The attendee has not responded to the invitation.
1497 # - "declined" - The attendee has declined the invitation.
1498 # - "tentative" - The attendee has tentatively accepted the invitation.
1499 # - "accepted" - The attendee has accepted the invitation.
1500 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1501 "id": "A String", # The attendee's Profile ID, if available.
1502 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1503 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1504 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1505 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1506 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1507 },
1508 ],
1509 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1510 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1511 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1512 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1513 },
1514 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1515 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
1516 "A String",
1517 ],
1518 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1519 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1520 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1521 },
1522 "etag": "A String", # ETag of the resource.
1523 "location": "A String", # Geographic location of the event as free-form text. Optional.
1524 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1525 "gadget": { # A gadget that extends this event.
1526 "preferences": { # Preferences.
1527 "a_key": "A String", # The preference name and corresponding value.
1528 },
1529 "title": "A String", # The gadget's title.
1530 "height": 42, # The gadget's height in pixels. Optional.
1531 "width": 42, # The gadget's width in pixels. Optional.
1532 "link": "A String", # The gadget's URL.
1533 "type": "A String", # The gadget's type.
1534 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1535 # - "icon" - The gadget displays next to the event's title in the calendar view.
1536 # - "chip" - The gadget displays when the event is clicked.
1537 "iconLink": "A String", # The gadget's icon URL.
1538 },
1539 "status": "A String", # Status of the event. Optional. Possible values are:
1540 # - "confirmed" - The event is confirmed. This is the default status.
1541 # - "tentative" - The event is tentatively confirmed.
1542 # - "cancelled" - The event is cancelled.
1543 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1544 "description": "A String", # Description of the event. Optional.
1545 "iCalUID": "A String", # Event ID in the iCalendar format.
1546 "extendedProperties": { # Extended properties of the event.
1547 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1548 "a_key": "A String", # The name of the shared property and the corresponding value.
1549 },
1550 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1551 "a_key": "A String", # The name of the private property and the corresponding value.
1552 },
1553 },
1554 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1555 "sequence": 42, # Sequence number as per iCalendar.
1556 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1557 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1558 # - "public" - The event is public and event details are visible to all readers of the calendar.
1559 # - "private" - The event is private and only event attendees may view event details.
1560 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1561 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1562 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1563 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1564 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1565 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1566 },
1567 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
1568 "kind": "calendar#event", # Type of the resource ("calendar#event").
1569 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1570 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1571 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
1572 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1573 "reminders": { # Information about the event's reminders for the authenticated user.
1574 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
1575 {
1576 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1577 "method": "A String", # The method used by this reminder. Possible values are:
1578 # - "email" - Reminders are sent via email.
1579 # - "sms" - Reminders are sent via SMS.
1580 # - "popup" - Reminders are sent via a UI popup.
1581 },
1582 ],
1583 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1584 },
1585 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1586 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
1587 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1588 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1589 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1590 },
1591 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1592 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1593 # - "opaque" - The event blocks time on the calendar. This is the default value.
1594 # - "transparent" - The event does not block time on the calendar.
1595 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1596 }</pre>
1597</div>
1598
1599<div class="method">
1600 <code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None)</code>
1601 <pre>Creates an event based on a simple text string.
1602
1603Args:
1604 calendarId: string, Calendar identifier. (required)
1605 text: string, The text describing the event to be created. (required)
1606 sendNotifications: boolean, Whether to send notifications about the creation of the event. Optional. The default is False.
1607
1608Returns:
1609 An object of the form:
1610
1611 {
1612 "creator": { # The creator of the event. Read-only.
1613 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1614 "displayName": "A String", # The creator's name, if available.
1615 "email": "A String", # The creator's email address, if available.
1616 "id": "A String", # The creator's Profile ID, if available.
1617 },
1618 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
1619 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1620 "displayName": "A String", # The organizer's name, if available.
1621 "email": "A String", # The organizer's email address, if available.
1622 "id": "A String", # The organizer's Profile ID, if available.
1623 },
1624 "summary": "A String", # Title of the event.
1625 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1626 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1627 # - the length of the ID must be between 5 and 1024 characters
1628 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1629 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1630 "attendees": [ # The attendees of the event.
1631 {
1632 "comment": "A String", # The attendee's response comment. Optional.
1633 "displayName": "A String", # The attendee's name, if available. Optional.
1634 "responseStatus": "A String", # The attendee's response status. Possible values are:
1635 # - "needsAction" - The attendee has not responded to the invitation.
1636 # - "declined" - The attendee has declined the invitation.
1637 # - "tentative" - The attendee has tentatively accepted the invitation.
1638 # - "accepted" - The attendee has accepted the invitation.
1639 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1640 "id": "A String", # The attendee's Profile ID, if available.
1641 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1642 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1643 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1644 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1645 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1646 },
1647 ],
1648 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1649 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1650 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1651 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1652 },
1653 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1654 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
1655 "A String",
1656 ],
1657 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1658 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1659 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1660 },
1661 "etag": "A String", # ETag of the resource.
1662 "location": "A String", # Geographic location of the event as free-form text. Optional.
1663 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1664 "gadget": { # A gadget that extends this event.
1665 "preferences": { # Preferences.
1666 "a_key": "A String", # The preference name and corresponding value.
1667 },
1668 "title": "A String", # The gadget's title.
1669 "height": 42, # The gadget's height in pixels. Optional.
1670 "width": 42, # The gadget's width in pixels. Optional.
1671 "link": "A String", # The gadget's URL.
1672 "type": "A String", # The gadget's type.
1673 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1674 # - "icon" - The gadget displays next to the event's title in the calendar view.
1675 # - "chip" - The gadget displays when the event is clicked.
1676 "iconLink": "A String", # The gadget's icon URL.
1677 },
1678 "status": "A String", # Status of the event. Optional. Possible values are:
1679 # - "confirmed" - The event is confirmed. This is the default status.
1680 # - "tentative" - The event is tentatively confirmed.
1681 # - "cancelled" - The event is cancelled.
1682 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1683 "description": "A String", # Description of the event. Optional.
1684 "iCalUID": "A String", # Event ID in the iCalendar format.
1685 "extendedProperties": { # Extended properties of the event.
1686 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1687 "a_key": "A String", # The name of the shared property and the corresponding value.
1688 },
1689 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1690 "a_key": "A String", # The name of the private property and the corresponding value.
1691 },
1692 },
1693 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1694 "sequence": 42, # Sequence number as per iCalendar.
1695 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1696 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1697 # - "public" - The event is public and event details are visible to all readers of the calendar.
1698 # - "private" - The event is private and only event attendees may view event details.
1699 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1700 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1701 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1702 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1703 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1704 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1705 },
1706 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
1707 "kind": "calendar#event", # Type of the resource ("calendar#event").
1708 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1709 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1710 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
1711 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1712 "reminders": { # Information about the event's reminders for the authenticated user.
1713 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
1714 {
1715 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1716 "method": "A String", # The method used by this reminder. Possible values are:
1717 # - "email" - Reminders are sent via email.
1718 # - "sms" - Reminders are sent via SMS.
1719 # - "popup" - Reminders are sent via a UI popup.
1720 },
1721 ],
1722 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1723 },
1724 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1725 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
1726 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1727 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1728 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1729 },
1730 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1731 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1732 # - "opaque" - The event blocks time on the calendar. This is the default value.
1733 # - "transparent" - The event does not block time on the calendar.
1734 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1735 }</pre>
1736</div>
1737
1738<div class="method">
1739 <code class="details" id="update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</code>
1740 <pre>Updates an event.
1741
1742Args:
1743 calendarId: string, Calendar identifier. (required)
1744 eventId: string, Event identifier. (required)
1745 body: object, The request body. (required)
1746 The object takes the form of:
1747
1748{
1749 "creator": { # The creator of the event. Read-only.
1750 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1751 "displayName": "A String", # The creator's name, if available.
1752 "email": "A String", # The creator's email address, if available.
1753 "id": "A String", # The creator's Profile ID, if available.
1754 },
1755 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
1756 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1757 "displayName": "A String", # The organizer's name, if available.
1758 "email": "A String", # The organizer's email address, if available.
1759 "id": "A String", # The organizer's Profile ID, if available.
1760 },
1761 "summary": "A String", # Title of the event.
1762 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1763 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1764 # - the length of the ID must be between 5 and 1024 characters
1765 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1766 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1767 "attendees": [ # The attendees of the event.
1768 {
1769 "comment": "A String", # The attendee's response comment. Optional.
1770 "displayName": "A String", # The attendee's name, if available. Optional.
1771 "responseStatus": "A String", # The attendee's response status. Possible values are:
1772 # - "needsAction" - The attendee has not responded to the invitation.
1773 # - "declined" - The attendee has declined the invitation.
1774 # - "tentative" - The attendee has tentatively accepted the invitation.
1775 # - "accepted" - The attendee has accepted the invitation.
1776 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1777 "id": "A String", # The attendee's Profile ID, if available.
1778 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1779 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1780 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1781 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1782 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1783 },
1784 ],
1785 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1786 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1787 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1788 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1789 },
1790 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1791 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
1792 "A String",
1793 ],
1794 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1795 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1796 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1797 },
1798 "etag": "A String", # ETag of the resource.
1799 "location": "A String", # Geographic location of the event as free-form text. Optional.
1800 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1801 "gadget": { # A gadget that extends this event.
1802 "preferences": { # Preferences.
1803 "a_key": "A String", # The preference name and corresponding value.
1804 },
1805 "title": "A String", # The gadget's title.
1806 "height": 42, # The gadget's height in pixels. Optional.
1807 "width": 42, # The gadget's width in pixels. Optional.
1808 "link": "A String", # The gadget's URL.
1809 "type": "A String", # The gadget's type.
1810 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1811 # - "icon" - The gadget displays next to the event's title in the calendar view.
1812 # - "chip" - The gadget displays when the event is clicked.
1813 "iconLink": "A String", # The gadget's icon URL.
1814 },
1815 "status": "A String", # Status of the event. Optional. Possible values are:
1816 # - "confirmed" - The event is confirmed. This is the default status.
1817 # - "tentative" - The event is tentatively confirmed.
1818 # - "cancelled" - The event is cancelled.
1819 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1820 "description": "A String", # Description of the event. Optional.
1821 "iCalUID": "A String", # Event ID in the iCalendar format.
1822 "extendedProperties": { # Extended properties of the event.
1823 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1824 "a_key": "A String", # The name of the shared property and the corresponding value.
1825 },
1826 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1827 "a_key": "A String", # The name of the private property and the corresponding value.
1828 },
1829 },
1830 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1831 "sequence": 42, # Sequence number as per iCalendar.
1832 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1833 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1834 # - "public" - The event is public and event details are visible to all readers of the calendar.
1835 # - "private" - The event is private and only event attendees may view event details.
1836 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1837 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1838 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1839 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1840 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1841 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1842 },
1843 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
1844 "kind": "calendar#event", # Type of the resource ("calendar#event").
1845 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1846 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1847 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
1848 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1849 "reminders": { # Information about the event's reminders for the authenticated user.
1850 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
1851 {
1852 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1853 "method": "A String", # The method used by this reminder. Possible values are:
1854 # - "email" - Reminders are sent via email.
1855 # - "sms" - Reminders are sent via SMS.
1856 # - "popup" - Reminders are sent via a UI popup.
1857 },
1858 ],
1859 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1860 },
1861 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1862 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
1863 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1864 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1865 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1866 },
1867 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1868 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1869 # - "opaque" - The event blocks time on the calendar. This is the default value.
1870 # - "transparent" - The event does not block time on the calendar.
1871 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1872 }
1873
1874 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
1875 alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
1876 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
1877
1878Returns:
1879 An object of the form:
1880
1881 {
1882 "creator": { # The creator of the event. Read-only.
1883 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1884 "displayName": "A String", # The creator's name, if available.
1885 "email": "A String", # The creator's email address, if available.
1886 "id": "A String", # The creator's Profile ID, if available.
1887 },
1888 "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
1889 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1890 "displayName": "A String", # The organizer's name, if available.
1891 "email": "A String", # The organizer's email address, if available.
1892 "id": "A String", # The organizer's Profile ID, if available.
1893 },
1894 "summary": "A String", # Title of the event.
1895 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1896 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1897 # - the length of the ID must be between 5 and 1024 characters
1898 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1899 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1900 "attendees": [ # The attendees of the event.
1901 {
1902 "comment": "A String", # The attendee's response comment. Optional.
1903 "displayName": "A String", # The attendee's name, if available. Optional.
1904 "responseStatus": "A String", # The attendee's response status. Possible values are:
1905 # - "needsAction" - The attendee has not responded to the invitation.
1906 # - "declined" - The attendee has declined the invitation.
1907 # - "tentative" - The attendee has tentatively accepted the invitation.
1908 # - "accepted" - The attendee has accepted the invitation.
1909 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1910 "id": "A String", # The attendee's Profile ID, if available.
1911 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1912 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1913 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1914 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1915 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1916 },
1917 ],
1918 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1919 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1920 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1921 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1922 },
1923 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1924 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
1925 "A String",
1926 ],
1927 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1928 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1929 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1930 },
1931 "etag": "A String", # ETag of the resource.
1932 "location": "A String", # Geographic location of the event as free-form text. Optional.
1933 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1934 "gadget": { # A gadget that extends this event.
1935 "preferences": { # Preferences.
1936 "a_key": "A String", # The preference name and corresponding value.
1937 },
1938 "title": "A String", # The gadget's title.
1939 "height": 42, # The gadget's height in pixels. Optional.
1940 "width": 42, # The gadget's width in pixels. Optional.
1941 "link": "A String", # The gadget's URL.
1942 "type": "A String", # The gadget's type.
1943 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1944 # - "icon" - The gadget displays next to the event's title in the calendar view.
1945 # - "chip" - The gadget displays when the event is clicked.
1946 "iconLink": "A String", # The gadget's icon URL.
1947 },
1948 "status": "A String", # Status of the event. Optional. Possible values are:
1949 # - "confirmed" - The event is confirmed. This is the default status.
1950 # - "tentative" - The event is tentatively confirmed.
1951 # - "cancelled" - The event is cancelled.
1952 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1953 "description": "A String", # Description of the event. Optional.
1954 "iCalUID": "A String", # Event ID in the iCalendar format.
1955 "extendedProperties": { # Extended properties of the event.
1956 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1957 "a_key": "A String", # The name of the shared property and the corresponding value.
1958 },
1959 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1960 "a_key": "A String", # The name of the private property and the corresponding value.
1961 },
1962 },
1963 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1964 "sequence": 42, # Sequence number as per iCalendar.
1965 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1966 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1967 # - "public" - The event is public and event details are visible to all readers of the calendar.
1968 # - "private" - The event is private and only event attendees may view event details.
1969 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1970 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1971 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1972 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1973 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1974 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1975 },
1976 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
1977 "kind": "calendar#event", # Type of the resource ("calendar#event").
1978 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1979 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1980 "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
1981 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1982 "reminders": { # Information about the event's reminders for the authenticated user.
1983 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
1984 {
1985 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1986 "method": "A String", # The method used by this reminder. Possible values are:
1987 # - "email" - Reminders are sent via email.
1988 # - "sms" - Reminders are sent via SMS.
1989 # - "popup" - Reminders are sent via a UI popup.
1990 },
1991 ],
1992 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1993 },
1994 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1995 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
1996 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1997 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1998 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1999 },
2000 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
2001 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
2002 # - "opaque" - The event blocks time on the calendar. This is the default value.
2003 # - "transparent" - The event does not block time on the calendar.
2004 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
2005 }</pre>
2006</div>
2007
2008<div class="method">
2009 <code class="details" id="watch">watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</code>
2010 <pre>Watch for changes to Events resources.
2011
2012Args:
2013 calendarId: string, Calendar identifier. (required)
2014 body: object, The request body. (required)
2015 The object takes the form of:
2016
2017{
2018 "resourceUri": "A String", # A version-specific identifier for the watched resource.
2019 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
2020 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
2021 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
2022 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
2023 "params": { # Additional parameters controlling delivery channel behavior. Optional.
2024 "a_key": "A String", # Declares a new parameter by name.
2025 },
2026 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
2027 "address": "A String", # The address where notifications are delivered for this channel.
2028 "type": "A String", # The type of delivery mechanism used for this channel.
2029 "id": "A String", # A UUID or similar unique string that identifies this channel.
2030 }
2031
2032 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
2033 Allowed values
2034 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter "singleEvents" is True)
2035 updated - Order by last modification time (ascending).
2036 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
2037 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
2038 privateExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
2039 pageToken: string, Token specifying which result page to return. Optional.
2040 updatedMin: string, Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
2041 singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
2042 alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
2043 showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if 'showDeleted' and 'singleEvents' are both False. If 'showDeleted' and 'singleEvents' are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
2044 sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
2045 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
2046 syncToken: string, Token obtained from the 'nextSyncToken' field returned on the last result page of the previous method's call. It makes the result of this call contain only entries that have changed since the last call. Optional. The default is to return all entries.
2047 iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.
2048 maxResults: integer, Maximum number of events returned on one result page. Optional.
2049 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
2050 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
2051 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
2052
2053Returns:
2054 An object of the form:
2055
2056 {
2057 "resourceUri": "A String", # A version-specific identifier for the watched resource.
2058 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
2059 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
2060 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
2061 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
2062 "params": { # Additional parameters controlling delivery channel behavior. Optional.
2063 "a_key": "A String", # Declares a new parameter by name.
2064 },
2065 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
2066 "address": "A String", # The address where notifications are delivered for this channel.
2067 "type": "A String", # The type of delivery mechanism used for this channel.
2068 "id": "A String", # A UUID or similar unique string that identifies this channel.
2069 }</pre>
2070</div>
2071
2072</body></html>