blob: 135e3dfde99ea5a2ec72e45ab9286e71de7ee47b [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -04001<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.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(calendarId, body, sendNotifications=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, pageToken=None, alwaysIncludeEmail=None, maxResults=None, showDeleted=None, timeZone=None, originalStart=None, maxAttendees=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, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=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)</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)</a></code></p>
112<p class="firstline">Updates an event.</p>
113<h3>Method Details</h3>
114<div class="method">
115 <code class="details" id="delete">delete(calendarId, eventId, sendNotifications=None)</code>
116 <pre>Deletes an event.
117
118Args:
119 calendarId: string, Calendar identifier. (required)
120 eventId: string, Event identifier. (required)
121 sendNotifications: boolean, Whether to send notifications about the deletion of the event. Optional. The default is False.
122</pre>
123</div>
124
125<div class="method">
126 <code class="details" id="get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</code>
127 <pre>Returns an event.
128
129Args:
130 calendarId: string, Calendar identifier. (required)
131 eventId: string, Event identifier. (required)
132 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.
133 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
134 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.
135
136Returns:
137 An object of the form:
138
139 {
140 "creator": { # The creator of the event. Read-only.
141 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
142 "displayName": "A String", # The creator's name, if available.
143 "email": "A String", # The creator's email address, if available.
144 "id": "A String", # The creator's Profile ID, if available.
145 },
146 "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.
147 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
148 "displayName": "A String", # The organizer's name, if available.
149 "email": "A String", # The organizer's email address, if available.
150 "id": "A String", # The organizer's Profile ID, if available.
151 },
152 "summary": "A String", # Title of the event.
153 "id": "A String", # Identifier of the event.
154 "attendees": [ # The attendees of the event.
155 {
156 "comment": "A String", # The attendee's response comment. Optional.
157 "displayName": "A String", # The attendee's name, if available. Optional.
158 "responseStatus": "A String", # The attendee's response status. Possible values are:
159 # - "needsAction" - The attendee has not responded to the invitation.
160 # - "declined" - The attendee has declined the invitation.
161 # - "tentative" - The attendee has tentatively accepted the invitation.
162 # - "accepted" - The attendee has accepted the invitation.
163 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
164 "id": "A String", # The attendee's Profile ID, if available.
165 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
166 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
167 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
168 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
169 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
170 },
171 ],
172 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
173 "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.
174 "A String",
175 ],
176 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
177 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
178 "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.
179 "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'.
180 },
181 "etag": "A String", # ETag of the resource.
182 "location": "A String", # Geographic location of the event as free-form text. Optional.
183 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
184 "gadget": { # A gadget that extends this event.
185 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400186 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400187 },
188 "title": "A String", # The gadget's title.
189 "height": 42, # The gadget's height in pixels. Optional.
190 "width": 42, # The gadget's width in pixels. Optional.
191 "link": "A String", # The gadget's URL.
192 "type": "A String", # The gadget's type.
193 "display": "A String", # The gadget's display mode. Optional. Possible values are:
194 # - "icon" - The gadget displays next to the event's title in the calendar view.
195 # - "chip" - The gadget displays when the event is clicked.
196 "iconLink": "A String", # The gadget's icon URL.
197 },
198 "status": "A String", # Status of the event. Optional. Possible values are:
199 # - "confirmed" - The event is confirmed. This is the default status.
200 # - "tentative" - The event is tentatively confirmed.
201 # - "cancelled" - The event is cancelled.
202 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
203 "description": "A String", # Description of the event. Optional.
204 "iCalUID": "A String", # Event ID in the iCalendar format.
205 "extendedProperties": { # Extended properties of the event.
206 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400207 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400208 },
209 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400210 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400211 },
212 },
213 "endTimeUnspecified": True or False,
214 "sequence": 42, # Sequence number as per iCalendar.
215 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
216 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
217 # - "public" - The event is public and event details are visible to all readers of the calendar.
218 # - "private" - The event is private and only event attendees may view event details.
219 # - "confidential" - The event is private. This value is provided for compatibility reasons.
220 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
221 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
222 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
223 "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.
224 "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'.
225 },
226 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
227 "kind": "calendar#event", # Type of the resource ("calendar#event").
228 "locked": True or 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.
229 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
230 "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.
231 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
232 "reminders": { # Information about the event's reminders for the authenticated user.
233 "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.
234 {
235 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
236 "method": "A String", # The method used by this reminder. Possible values are:
237 # - "email" - Reminders are sent via email.
238 # - "sms" - Reminders are sent via SMS.
239 # - "popup" - Reminders are sent via a UI popup.
240 },
241 ],
242 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
243 },
244 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
245 "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.
246 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
247 "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.
248 "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'.
249 },
250 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
251 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
252 # - "opaque" - The event blocks time on the calendar. This is the default value.
253 # - "transparent" - The event does not block time on the calendar.
254 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="import_">import_(calendarId, body)</code>
260 <pre>Imports an event.
261
262Args:
263 calendarId: string, Calendar identifier. (required)
264 body: object, The request body. (required)
265 The object takes the form of:
266
267{
268 "creator": { # The creator of the event. Read-only.
269 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
270 "displayName": "A String", # The creator's name, if available.
271 "email": "A String", # The creator's email address, if available.
272 "id": "A String", # The creator's Profile ID, if available.
273 },
274 "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.
275 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
276 "displayName": "A String", # The organizer's name, if available.
277 "email": "A String", # The organizer's email address, if available.
278 "id": "A String", # The organizer's Profile ID, if available.
279 },
280 "summary": "A String", # Title of the event.
281 "id": "A String", # Identifier of the event.
282 "attendees": [ # The attendees of the event.
283 {
284 "comment": "A String", # The attendee's response comment. Optional.
285 "displayName": "A String", # The attendee's name, if available. Optional.
286 "responseStatus": "A String", # The attendee's response status. Possible values are:
287 # - "needsAction" - The attendee has not responded to the invitation.
288 # - "declined" - The attendee has declined the invitation.
289 # - "tentative" - The attendee has tentatively accepted the invitation.
290 # - "accepted" - The attendee has accepted the invitation.
291 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
292 "id": "A String", # The attendee's Profile ID, if available.
293 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
294 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
295 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
296 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
297 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
298 },
299 ],
300 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
301 "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.
302 "A String",
303 ],
304 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
305 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
306 "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.
307 "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'.
308 },
309 "etag": "A String", # ETag of the resource.
310 "location": "A String", # Geographic location of the event as free-form text. Optional.
311 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
312 "gadget": { # A gadget that extends this event.
313 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400314 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400315 },
316 "title": "A String", # The gadget's title.
317 "height": 42, # The gadget's height in pixels. Optional.
318 "width": 42, # The gadget's width in pixels. Optional.
319 "link": "A String", # The gadget's URL.
320 "type": "A String", # The gadget's type.
321 "display": "A String", # The gadget's display mode. Optional. Possible values are:
322 # - "icon" - The gadget displays next to the event's title in the calendar view.
323 # - "chip" - The gadget displays when the event is clicked.
324 "iconLink": "A String", # The gadget's icon URL.
325 },
326 "status": "A String", # Status of the event. Optional. Possible values are:
327 # - "confirmed" - The event is confirmed. This is the default status.
328 # - "tentative" - The event is tentatively confirmed.
329 # - "cancelled" - The event is cancelled.
330 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
331 "description": "A String", # Description of the event. Optional.
332 "iCalUID": "A String", # Event ID in the iCalendar format.
333 "extendedProperties": { # Extended properties of the event.
334 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400335 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400336 },
337 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400338 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400339 },
340 },
341 "endTimeUnspecified": True or False,
342 "sequence": 42, # Sequence number as per iCalendar.
343 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
344 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
345 # - "public" - The event is public and event details are visible to all readers of the calendar.
346 # - "private" - The event is private and only event attendees may view event details.
347 # - "confidential" - The event is private. This value is provided for compatibility reasons.
348 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
349 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
350 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
351 "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.
352 "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'.
353 },
354 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
355 "kind": "calendar#event", # Type of the resource ("calendar#event").
356 "locked": True or 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.
357 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
358 "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.
359 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
360 "reminders": { # Information about the event's reminders for the authenticated user.
361 "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.
362 {
363 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
364 "method": "A String", # The method used by this reminder. Possible values are:
365 # - "email" - Reminders are sent via email.
366 # - "sms" - Reminders are sent via SMS.
367 # - "popup" - Reminders are sent via a UI popup.
368 },
369 ],
370 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
371 },
372 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
373 "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.
374 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
375 "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.
376 "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'.
377 },
378 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
379 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
380 # - "opaque" - The event blocks time on the calendar. This is the default value.
381 # - "transparent" - The event does not block time on the calendar.
382 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
383 }
384
385
386Returns:
387 An object of the form:
388
389 {
390 "creator": { # The creator of the event. Read-only.
391 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
392 "displayName": "A String", # The creator's name, if available.
393 "email": "A String", # The creator's email address, if available.
394 "id": "A String", # The creator's Profile ID, if available.
395 },
396 "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.
397 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
398 "displayName": "A String", # The organizer's name, if available.
399 "email": "A String", # The organizer's email address, if available.
400 "id": "A String", # The organizer's Profile ID, if available.
401 },
402 "summary": "A String", # Title of the event.
403 "id": "A String", # Identifier of the event.
404 "attendees": [ # The attendees of the event.
405 {
406 "comment": "A String", # The attendee's response comment. Optional.
407 "displayName": "A String", # The attendee's name, if available. Optional.
408 "responseStatus": "A String", # The attendee's response status. Possible values are:
409 # - "needsAction" - The attendee has not responded to the invitation.
410 # - "declined" - The attendee has declined the invitation.
411 # - "tentative" - The attendee has tentatively accepted the invitation.
412 # - "accepted" - The attendee has accepted the invitation.
413 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
414 "id": "A String", # The attendee's Profile ID, if available.
415 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
416 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
417 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
418 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
419 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
420 },
421 ],
422 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
423 "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.
424 "A String",
425 ],
426 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
427 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
428 "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.
429 "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'.
430 },
431 "etag": "A String", # ETag of the resource.
432 "location": "A String", # Geographic location of the event as free-form text. Optional.
433 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
434 "gadget": { # A gadget that extends this event.
435 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400436 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400437 },
438 "title": "A String", # The gadget's title.
439 "height": 42, # The gadget's height in pixels. Optional.
440 "width": 42, # The gadget's width in pixels. Optional.
441 "link": "A String", # The gadget's URL.
442 "type": "A String", # The gadget's type.
443 "display": "A String", # The gadget's display mode. Optional. Possible values are:
444 # - "icon" - The gadget displays next to the event's title in the calendar view.
445 # - "chip" - The gadget displays when the event is clicked.
446 "iconLink": "A String", # The gadget's icon URL.
447 },
448 "status": "A String", # Status of the event. Optional. Possible values are:
449 # - "confirmed" - The event is confirmed. This is the default status.
450 # - "tentative" - The event is tentatively confirmed.
451 # - "cancelled" - The event is cancelled.
452 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
453 "description": "A String", # Description of the event. Optional.
454 "iCalUID": "A String", # Event ID in the iCalendar format.
455 "extendedProperties": { # Extended properties of the event.
456 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400457 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400458 },
459 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400460 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400461 },
462 },
463 "endTimeUnspecified": True or False,
464 "sequence": 42, # Sequence number as per iCalendar.
465 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
466 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
467 # - "public" - The event is public and event details are visible to all readers of the calendar.
468 # - "private" - The event is private and only event attendees may view event details.
469 # - "confidential" - The event is private. This value is provided for compatibility reasons.
470 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
471 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
472 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
473 "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.
474 "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'.
475 },
476 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
477 "kind": "calendar#event", # Type of the resource ("calendar#event").
478 "locked": True or 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.
479 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
480 "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.
481 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
482 "reminders": { # Information about the event's reminders for the authenticated user.
483 "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.
484 {
485 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
486 "method": "A String", # The method used by this reminder. Possible values are:
487 # - "email" - Reminders are sent via email.
488 # - "sms" - Reminders are sent via SMS.
489 # - "popup" - Reminders are sent via a UI popup.
490 },
491 ],
492 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
493 },
494 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
495 "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.
496 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
497 "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.
498 "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'.
499 },
500 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
501 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
502 # - "opaque" - The event blocks time on the calendar. This is the default value.
503 # - "transparent" - The event does not block time on the calendar.
504 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
505 }</pre>
506</div>
507
508<div class="method">
509 <code class="details" id="insert">insert(calendarId, body, sendNotifications=None)</code>
510 <pre>Creates an event.
511
512Args:
513 calendarId: string, Calendar identifier. (required)
514 body: object, The request body. (required)
515 The object takes the form of:
516
517{
518 "creator": { # The creator of the event. Read-only.
519 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
520 "displayName": "A String", # The creator's name, if available.
521 "email": "A String", # The creator's email address, if available.
522 "id": "A String", # The creator's Profile ID, if available.
523 },
524 "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.
525 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
526 "displayName": "A String", # The organizer's name, if available.
527 "email": "A String", # The organizer's email address, if available.
528 "id": "A String", # The organizer's Profile ID, if available.
529 },
530 "summary": "A String", # Title of the event.
531 "id": "A String", # Identifier of the event.
532 "attendees": [ # The attendees of the event.
533 {
534 "comment": "A String", # The attendee's response comment. Optional.
535 "displayName": "A String", # The attendee's name, if available. Optional.
536 "responseStatus": "A String", # The attendee's response status. Possible values are:
537 # - "needsAction" - The attendee has not responded to the invitation.
538 # - "declined" - The attendee has declined the invitation.
539 # - "tentative" - The attendee has tentatively accepted the invitation.
540 # - "accepted" - The attendee has accepted the invitation.
541 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
542 "id": "A String", # The attendee's Profile ID, if available.
543 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
544 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
545 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
546 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
547 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
548 },
549 ],
550 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
551 "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.
552 "A String",
553 ],
554 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
555 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
556 "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.
557 "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'.
558 },
559 "etag": "A String", # ETag of the resource.
560 "location": "A String", # Geographic location of the event as free-form text. Optional.
561 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
562 "gadget": { # A gadget that extends this event.
563 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400564 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400565 },
566 "title": "A String", # The gadget's title.
567 "height": 42, # The gadget's height in pixels. Optional.
568 "width": 42, # The gadget's width in pixels. Optional.
569 "link": "A String", # The gadget's URL.
570 "type": "A String", # The gadget's type.
571 "display": "A String", # The gadget's display mode. Optional. Possible values are:
572 # - "icon" - The gadget displays next to the event's title in the calendar view.
573 # - "chip" - The gadget displays when the event is clicked.
574 "iconLink": "A String", # The gadget's icon URL.
575 },
576 "status": "A String", # Status of the event. Optional. Possible values are:
577 # - "confirmed" - The event is confirmed. This is the default status.
578 # - "tentative" - The event is tentatively confirmed.
579 # - "cancelled" - The event is cancelled.
580 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
581 "description": "A String", # Description of the event. Optional.
582 "iCalUID": "A String", # Event ID in the iCalendar format.
583 "extendedProperties": { # Extended properties of the event.
584 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400585 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400586 },
587 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400588 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400589 },
590 },
591 "endTimeUnspecified": True or False,
592 "sequence": 42, # Sequence number as per iCalendar.
593 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
594 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
595 # - "public" - The event is public and event details are visible to all readers of the calendar.
596 # - "private" - The event is private and only event attendees may view event details.
597 # - "confidential" - The event is private. This value is provided for compatibility reasons.
598 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
599 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
600 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
601 "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.
602 "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'.
603 },
604 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
605 "kind": "calendar#event", # Type of the resource ("calendar#event").
606 "locked": True or 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.
607 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
608 "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.
609 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
610 "reminders": { # Information about the event's reminders for the authenticated user.
611 "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.
612 {
613 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
614 "method": "A String", # The method used by this reminder. Possible values are:
615 # - "email" - Reminders are sent via email.
616 # - "sms" - Reminders are sent via SMS.
617 # - "popup" - Reminders are sent via a UI popup.
618 },
619 ],
620 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
621 },
622 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
623 "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.
624 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
625 "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.
626 "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'.
627 },
628 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
629 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
630 # - "opaque" - The event blocks time on the calendar. This is the default value.
631 # - "transparent" - The event does not block time on the calendar.
632 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
633 }
634
635 sendNotifications: boolean, Whether to send notifications about the creation of the new event. Optional. The default is False.
636
637Returns:
638 An object of the form:
639
640 {
641 "creator": { # The creator of the event. Read-only.
642 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
643 "displayName": "A String", # The creator's name, if available.
644 "email": "A String", # The creator's email address, if available.
645 "id": "A String", # The creator's Profile ID, if available.
646 },
647 "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.
648 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
649 "displayName": "A String", # The organizer's name, if available.
650 "email": "A String", # The organizer's email address, if available.
651 "id": "A String", # The organizer's Profile ID, if available.
652 },
653 "summary": "A String", # Title of the event.
654 "id": "A String", # Identifier of the event.
655 "attendees": [ # The attendees of the event.
656 {
657 "comment": "A String", # The attendee's response comment. Optional.
658 "displayName": "A String", # The attendee's name, if available. Optional.
659 "responseStatus": "A String", # The attendee's response status. Possible values are:
660 # - "needsAction" - The attendee has not responded to the invitation.
661 # - "declined" - The attendee has declined the invitation.
662 # - "tentative" - The attendee has tentatively accepted the invitation.
663 # - "accepted" - The attendee has accepted the invitation.
664 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
665 "id": "A String", # The attendee's Profile ID, if available.
666 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
667 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
668 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
669 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
670 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
671 },
672 ],
673 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
674 "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.
675 "A String",
676 ],
677 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
678 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
679 "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.
680 "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'.
681 },
682 "etag": "A String", # ETag of the resource.
683 "location": "A String", # Geographic location of the event as free-form text. Optional.
684 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
685 "gadget": { # A gadget that extends this event.
686 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400687 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400688 },
689 "title": "A String", # The gadget's title.
690 "height": 42, # The gadget's height in pixels. Optional.
691 "width": 42, # The gadget's width in pixels. Optional.
692 "link": "A String", # The gadget's URL.
693 "type": "A String", # The gadget's type.
694 "display": "A String", # The gadget's display mode. Optional. Possible values are:
695 # - "icon" - The gadget displays next to the event's title in the calendar view.
696 # - "chip" - The gadget displays when the event is clicked.
697 "iconLink": "A String", # The gadget's icon URL.
698 },
699 "status": "A String", # Status of the event. Optional. Possible values are:
700 # - "confirmed" - The event is confirmed. This is the default status.
701 # - "tentative" - The event is tentatively confirmed.
702 # - "cancelled" - The event is cancelled.
703 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
704 "description": "A String", # Description of the event. Optional.
705 "iCalUID": "A String", # Event ID in the iCalendar format.
706 "extendedProperties": { # Extended properties of the event.
707 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400708 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400709 },
710 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400711 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400712 },
713 },
714 "endTimeUnspecified": True or False,
715 "sequence": 42, # Sequence number as per iCalendar.
716 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
717 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
718 # - "public" - The event is public and event details are visible to all readers of the calendar.
719 # - "private" - The event is private and only event attendees may view event details.
720 # - "confidential" - The event is private. This value is provided for compatibility reasons.
721 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
722 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
723 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
724 "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.
725 "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'.
726 },
727 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
728 "kind": "calendar#event", # Type of the resource ("calendar#event").
729 "locked": True or 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.
730 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
731 "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.
732 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
733 "reminders": { # Information about the event's reminders for the authenticated user.
734 "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.
735 {
736 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
737 "method": "A String", # The method used by this reminder. Possible values are:
738 # - "email" - Reminders are sent via email.
739 # - "sms" - Reminders are sent via SMS.
740 # - "popup" - Reminders are sent via a UI popup.
741 },
742 ],
743 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
744 },
745 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
746 "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.
747 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
748 "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.
749 "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'.
750 },
751 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
752 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
753 # - "opaque" - The event blocks time on the calendar. This is the default value.
754 # - "transparent" - The event does not block time on the calendar.
755 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
756 }</pre>
757</div>
758
759<div class="method">
760 <code class="details" id="instances">instances(calendarId, eventId, pageToken=None, alwaysIncludeEmail=None, maxResults=None, showDeleted=None, timeZone=None, originalStart=None, maxAttendees=None)</code>
761 <pre>Returns instances of the specified recurring event.
762
763Args:
764 calendarId: string, Calendar identifier. (required)
765 eventId: string, Recurring event identifier. (required)
766 pageToken: string, Token specifying which result page to return. Optional.
767 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.
768 maxResults: integer, Maximum number of events returned on one result page. Optional.
769 showDeleted: boolean, Whether to include deleted events (with 'eventStatus' equals 'cancelled') in the result. Optional. The default is False.
770 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
771 originalStart: string, The original start time of the instance in the result. Optional.
772 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.
773
774Returns:
775 An object of the form:
776
777 {
778 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
779 "kind": "calendar#events", # Type of the collection ("calendar#events").
780 "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').
781 {
782 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
783 "method": "A String", # The method used by this reminder. Possible values are:
784 # - "email" - Reminders are sent via email.
785 # - "sms" - Reminders are sent via SMS.
786 # - "popup" - Reminders are sent via a UI popup.
787 },
788 ],
789 "description": "A String", # Description of the calendar. Read-only.
790 "items": [ # List of events on the calendar.
791 {
792 "creator": { # The creator of the event. Read-only.
793 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
794 "displayName": "A String", # The creator's name, if available.
795 "email": "A String", # The creator's email address, if available.
796 "id": "A String", # The creator's Profile ID, if available.
797 },
798 "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.
799 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
800 "displayName": "A String", # The organizer's name, if available.
801 "email": "A String", # The organizer's email address, if available.
802 "id": "A String", # The organizer's Profile ID, if available.
803 },
804 "summary": "A String", # Title of the event.
805 "id": "A String", # Identifier of the event.
806 "attendees": [ # The attendees of the event.
807 {
808 "comment": "A String", # The attendee's response comment. Optional.
809 "displayName": "A String", # The attendee's name, if available. Optional.
810 "responseStatus": "A String", # The attendee's response status. Possible values are:
811 # - "needsAction" - The attendee has not responded to the invitation.
812 # - "declined" - The attendee has declined the invitation.
813 # - "tentative" - The attendee has tentatively accepted the invitation.
814 # - "accepted" - The attendee has accepted the invitation.
815 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
816 "id": "A String", # The attendee's Profile ID, if available.
817 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
818 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
819 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
820 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
821 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
822 },
823 ],
824 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
825 "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.
826 "A String",
827 ],
828 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
829 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
830 "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.
831 "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'.
832 },
833 "etag": "A String", # ETag of the resource.
834 "location": "A String", # Geographic location of the event as free-form text. Optional.
835 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
836 "gadget": { # A gadget that extends this event.
837 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400838 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400839 },
840 "title": "A String", # The gadget's title.
841 "height": 42, # The gadget's height in pixels. Optional.
842 "width": 42, # The gadget's width in pixels. Optional.
843 "link": "A String", # The gadget's URL.
844 "type": "A String", # The gadget's type.
845 "display": "A String", # The gadget's display mode. Optional. Possible values are:
846 # - "icon" - The gadget displays next to the event's title in the calendar view.
847 # - "chip" - The gadget displays when the event is clicked.
848 "iconLink": "A String", # The gadget's icon URL.
849 },
850 "status": "A String", # Status of the event. Optional. Possible values are:
851 # - "confirmed" - The event is confirmed. This is the default status.
852 # - "tentative" - The event is tentatively confirmed.
853 # - "cancelled" - The event is cancelled.
854 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
855 "description": "A String", # Description of the event. Optional.
856 "iCalUID": "A String", # Event ID in the iCalendar format.
857 "extendedProperties": { # Extended properties of the event.
858 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400859 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400860 },
861 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400862 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400863 },
864 },
865 "endTimeUnspecified": True or False,
866 "sequence": 42, # Sequence number as per iCalendar.
867 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
868 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
869 # - "public" - The event is public and event details are visible to all readers of the calendar.
870 # - "private" - The event is private and only event attendees may view event details.
871 # - "confidential" - The event is private. This value is provided for compatibility reasons.
872 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
873 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
874 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
875 "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.
876 "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'.
877 },
878 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
879 "kind": "calendar#event", # Type of the resource ("calendar#event").
880 "locked": True or 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.
881 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
882 "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.
883 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
884 "reminders": { # Information about the event's reminders for the authenticated user.
885 "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.
886 {
887 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
888 "method": "A String", # The method used by this reminder. Possible values are:
889 # - "email" - Reminders are sent via email.
890 # - "sms" - Reminders are sent via SMS.
891 # - "popup" - Reminders are sent via a UI popup.
892 },
893 ],
894 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
895 },
896 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
897 "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.
898 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
899 "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.
900 "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'.
901 },
902 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
903 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
904 # - "opaque" - The event blocks time on the calendar. This is the default value.
905 # - "transparent" - The event does not block time on the calendar.
906 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
907 },
908 ],
909 "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
910 "summary": "A String", # Title of the calendar. Read-only.
911 "etag": "A String", # ETag of the collection.
912 "timeZone": "A String", # The time zone of the calendar. Read-only.
913 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
914 # - "none" - The user has no access.
915 # - "freeBusyReader" - The user has read access to free/busy information.
916 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
917 # - "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.
918 # - "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.
919 }</pre>
920</div>
921
922<div class="method">
923 <code class="details" id="instances_next">instances_next(previous_request, previous_response)</code>
924 <pre>Retrieves the next page of results.
925
926Args:
927 previous_request: The request for the previous page. (required)
928 previous_response: The response from the request for the previous page. (required)
929
930Returns:
931 A request object that you can call 'execute()' on to request the next
932 page. Returns None if there are no more items in the collection.
933 </pre>
934</div>
935
936<div class="method">
937 <code class="details" id="list">list(calendarId, orderBy=None, showHiddenInvitations=None, timeMin=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</code>
938 <pre>Returns events on the specified calendar.
939
940Args:
941 calendarId: string, Calendar identifier. (required)
942 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
943 Allowed values
944 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter "singleEvents" is True)
945 updated - Order by last modification time (ascending).
946 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
947 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
948 pageToken: string, Token specifying which result page to return. Optional.
949 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.
950 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.
951 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.
952 showDeleted: boolean, Whether to include deleted events (with 'eventStatus' equals 'cancelled') in the result. Optional. The default is False.
953 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.
954 iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.
955 maxResults: integer, Maximum number of events returned on one result page. Optional.
956 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
957 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
958 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
959
960Returns:
961 An object of the form:
962
963 {
964 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
965 "kind": "calendar#events", # Type of the collection ("calendar#events").
966 "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').
967 {
968 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
969 "method": "A String", # The method used by this reminder. Possible values are:
970 # - "email" - Reminders are sent via email.
971 # - "sms" - Reminders are sent via SMS.
972 # - "popup" - Reminders are sent via a UI popup.
973 },
974 ],
975 "description": "A String", # Description of the calendar. Read-only.
976 "items": [ # List of events on the calendar.
977 {
978 "creator": { # The creator of the event. Read-only.
979 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
980 "displayName": "A String", # The creator's name, if available.
981 "email": "A String", # The creator's email address, if available.
982 "id": "A String", # The creator's Profile ID, if available.
983 },
984 "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.
985 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
986 "displayName": "A String", # The organizer's name, if available.
987 "email": "A String", # The organizer's email address, if available.
988 "id": "A String", # The organizer's Profile ID, if available.
989 },
990 "summary": "A String", # Title of the event.
991 "id": "A String", # Identifier of the event.
992 "attendees": [ # The attendees of the event.
993 {
994 "comment": "A String", # The attendee's response comment. Optional.
995 "displayName": "A String", # The attendee's name, if available. Optional.
996 "responseStatus": "A String", # The attendee's response status. Possible values are:
997 # - "needsAction" - The attendee has not responded to the invitation.
998 # - "declined" - The attendee has declined the invitation.
999 # - "tentative" - The attendee has tentatively accepted the invitation.
1000 # - "accepted" - The attendee has accepted the invitation.
1001 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1002 "id": "A String", # The attendee's Profile ID, if available.
1003 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1004 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1005 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1006 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1007 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1008 },
1009 ],
1010 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1011 "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.
1012 "A String",
1013 ],
1014 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1015 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1016 "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.
1017 "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'.
1018 },
1019 "etag": "A String", # ETag of the resource.
1020 "location": "A String", # Geographic location of the event as free-form text. Optional.
1021 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1022 "gadget": { # A gadget that extends this event.
1023 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001024 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001025 },
1026 "title": "A String", # The gadget's title.
1027 "height": 42, # The gadget's height in pixels. Optional.
1028 "width": 42, # The gadget's width in pixels. Optional.
1029 "link": "A String", # The gadget's URL.
1030 "type": "A String", # The gadget's type.
1031 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1032 # - "icon" - The gadget displays next to the event's title in the calendar view.
1033 # - "chip" - The gadget displays when the event is clicked.
1034 "iconLink": "A String", # The gadget's icon URL.
1035 },
1036 "status": "A String", # Status of the event. Optional. Possible values are:
1037 # - "confirmed" - The event is confirmed. This is the default status.
1038 # - "tentative" - The event is tentatively confirmed.
1039 # - "cancelled" - The event is cancelled.
1040 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1041 "description": "A String", # Description of the event. Optional.
1042 "iCalUID": "A String", # Event ID in the iCalendar format.
1043 "extendedProperties": { # Extended properties of the event.
1044 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001045 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001046 },
1047 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001048 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001049 },
1050 },
1051 "endTimeUnspecified": True or False,
1052 "sequence": 42, # Sequence number as per iCalendar.
1053 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1054 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1055 # - "public" - The event is public and event details are visible to all readers of the calendar.
1056 # - "private" - The event is private and only event attendees may view event details.
1057 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1058 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1059 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1060 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1061 "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.
1062 "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'.
1063 },
1064 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
1065 "kind": "calendar#event", # Type of the resource ("calendar#event").
1066 "locked": True or 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.
1067 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1068 "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.
1069 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1070 "reminders": { # Information about the event's reminders for the authenticated user.
1071 "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.
1072 {
1073 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1074 "method": "A String", # The method used by this reminder. Possible values are:
1075 # - "email" - Reminders are sent via email.
1076 # - "sms" - Reminders are sent via SMS.
1077 # - "popup" - Reminders are sent via a UI popup.
1078 },
1079 ],
1080 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1081 },
1082 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1083 "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.
1084 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1085 "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.
1086 "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'.
1087 },
1088 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1089 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1090 # - "opaque" - The event blocks time on the calendar. This is the default value.
1091 # - "transparent" - The event does not block time on the calendar.
1092 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1093 },
1094 ],
1095 "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
1096 "summary": "A String", # Title of the calendar. Read-only.
1097 "etag": "A String", # ETag of the collection.
1098 "timeZone": "A String", # The time zone of the calendar. Read-only.
1099 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
1100 # - "none" - The user has no access.
1101 # - "freeBusyReader" - The user has read access to free/busy information.
1102 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
1103 # - "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.
1104 # - "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.
1105 }</pre>
1106</div>
1107
1108<div class="method">
1109 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1110 <pre>Retrieves the next page of results.
1111
1112Args:
1113 previous_request: The request for the previous page. (required)
1114 previous_response: The response from the request for the previous page. (required)
1115
1116Returns:
1117 A request object that you can call 'execute()' on to request the next
1118 page. Returns None if there are no more items in the collection.
1119 </pre>
1120</div>
1121
1122<div class="method">
1123 <code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None)</code>
1124 <pre>Moves an event to another calendar, i.e. changes an event's organizer.
1125
1126Args:
1127 calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)
1128 eventId: string, Event identifier. (required)
1129 destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)
1130 sendNotifications: boolean, Whether to send notifications about the change of the event's organizer. Optional. The default is False.
1131
1132Returns:
1133 An object of the form:
1134
1135 {
1136 "creator": { # The creator of the event. Read-only.
1137 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1138 "displayName": "A String", # The creator's name, if available.
1139 "email": "A String", # The creator's email address, if available.
1140 "id": "A String", # The creator's Profile ID, if available.
1141 },
1142 "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.
1143 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1144 "displayName": "A String", # The organizer's name, if available.
1145 "email": "A String", # The organizer's email address, if available.
1146 "id": "A String", # The organizer's Profile ID, if available.
1147 },
1148 "summary": "A String", # Title of the event.
1149 "id": "A String", # Identifier of the event.
1150 "attendees": [ # The attendees of the event.
1151 {
1152 "comment": "A String", # The attendee's response comment. Optional.
1153 "displayName": "A String", # The attendee's name, if available. Optional.
1154 "responseStatus": "A String", # The attendee's response status. Possible values are:
1155 # - "needsAction" - The attendee has not responded to the invitation.
1156 # - "declined" - The attendee has declined the invitation.
1157 # - "tentative" - The attendee has tentatively accepted the invitation.
1158 # - "accepted" - The attendee has accepted the invitation.
1159 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1160 "id": "A String", # The attendee's Profile ID, if available.
1161 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1162 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1163 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1164 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1165 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1166 },
1167 ],
1168 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1169 "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.
1170 "A String",
1171 ],
1172 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1173 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1174 "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.
1175 "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'.
1176 },
1177 "etag": "A String", # ETag of the resource.
1178 "location": "A String", # Geographic location of the event as free-form text. Optional.
1179 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1180 "gadget": { # A gadget that extends this event.
1181 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001182 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001183 },
1184 "title": "A String", # The gadget's title.
1185 "height": 42, # The gadget's height in pixels. Optional.
1186 "width": 42, # The gadget's width in pixels. Optional.
1187 "link": "A String", # The gadget's URL.
1188 "type": "A String", # The gadget's type.
1189 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1190 # - "icon" - The gadget displays next to the event's title in the calendar view.
1191 # - "chip" - The gadget displays when the event is clicked.
1192 "iconLink": "A String", # The gadget's icon URL.
1193 },
1194 "status": "A String", # Status of the event. Optional. Possible values are:
1195 # - "confirmed" - The event is confirmed. This is the default status.
1196 # - "tentative" - The event is tentatively confirmed.
1197 # - "cancelled" - The event is cancelled.
1198 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1199 "description": "A String", # Description of the event. Optional.
1200 "iCalUID": "A String", # Event ID in the iCalendar format.
1201 "extendedProperties": { # Extended properties of the event.
1202 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001203 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001204 },
1205 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001206 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001207 },
1208 },
1209 "endTimeUnspecified": True or False,
1210 "sequence": 42, # Sequence number as per iCalendar.
1211 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1212 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1213 # - "public" - The event is public and event details are visible to all readers of the calendar.
1214 # - "private" - The event is private and only event attendees may view event details.
1215 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1216 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1217 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1218 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1219 "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.
1220 "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'.
1221 },
1222 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
1223 "kind": "calendar#event", # Type of the resource ("calendar#event").
1224 "locked": True or 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.
1225 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1226 "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.
1227 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1228 "reminders": { # Information about the event's reminders for the authenticated user.
1229 "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.
1230 {
1231 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1232 "method": "A String", # The method used by this reminder. Possible values are:
1233 # - "email" - Reminders are sent via email.
1234 # - "sms" - Reminders are sent via SMS.
1235 # - "popup" - Reminders are sent via a UI popup.
1236 },
1237 ],
1238 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1239 },
1240 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1241 "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.
1242 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1243 "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.
1244 "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'.
1245 },
1246 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1247 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1248 # - "opaque" - The event blocks time on the calendar. This is the default value.
1249 # - "transparent" - The event does not block time on the calendar.
1250 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1251 }</pre>
1252</div>
1253
1254<div class="method">
1255 <code class="details" id="patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None)</code>
1256 <pre>Updates an event. This method supports patch semantics.
1257
1258Args:
1259 calendarId: string, Calendar identifier. (required)
1260 eventId: string, Event identifier. (required)
1261 body: object, The request body. (required)
1262 The object takes the form of:
1263
1264{
1265 "creator": { # The creator of the event. Read-only.
1266 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1267 "displayName": "A String", # The creator's name, if available.
1268 "email": "A String", # The creator's email address, if available.
1269 "id": "A String", # The creator's Profile ID, if available.
1270 },
1271 "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.
1272 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1273 "displayName": "A String", # The organizer's name, if available.
1274 "email": "A String", # The organizer's email address, if available.
1275 "id": "A String", # The organizer's Profile ID, if available.
1276 },
1277 "summary": "A String", # Title of the event.
1278 "id": "A String", # Identifier of the event.
1279 "attendees": [ # The attendees of the event.
1280 {
1281 "comment": "A String", # The attendee's response comment. Optional.
1282 "displayName": "A String", # The attendee's name, if available. Optional.
1283 "responseStatus": "A String", # The attendee's response status. Possible values are:
1284 # - "needsAction" - The attendee has not responded to the invitation.
1285 # - "declined" - The attendee has declined the invitation.
1286 # - "tentative" - The attendee has tentatively accepted the invitation.
1287 # - "accepted" - The attendee has accepted the invitation.
1288 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1289 "id": "A String", # The attendee's Profile ID, if available.
1290 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1291 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1292 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1293 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1294 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1295 },
1296 ],
1297 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1298 "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.
1299 "A String",
1300 ],
1301 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1302 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1303 "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.
1304 "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'.
1305 },
1306 "etag": "A String", # ETag of the resource.
1307 "location": "A String", # Geographic location of the event as free-form text. Optional.
1308 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1309 "gadget": { # A gadget that extends this event.
1310 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001311 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001312 },
1313 "title": "A String", # The gadget's title.
1314 "height": 42, # The gadget's height in pixels. Optional.
1315 "width": 42, # The gadget's width in pixels. Optional.
1316 "link": "A String", # The gadget's URL.
1317 "type": "A String", # The gadget's type.
1318 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1319 # - "icon" - The gadget displays next to the event's title in the calendar view.
1320 # - "chip" - The gadget displays when the event is clicked.
1321 "iconLink": "A String", # The gadget's icon URL.
1322 },
1323 "status": "A String", # Status of the event. Optional. Possible values are:
1324 # - "confirmed" - The event is confirmed. This is the default status.
1325 # - "tentative" - The event is tentatively confirmed.
1326 # - "cancelled" - The event is cancelled.
1327 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1328 "description": "A String", # Description of the event. Optional.
1329 "iCalUID": "A String", # Event ID in the iCalendar format.
1330 "extendedProperties": { # Extended properties of the event.
1331 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001332 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001333 },
1334 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001335 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001336 },
1337 },
1338 "endTimeUnspecified": True or False,
1339 "sequence": 42, # Sequence number as per iCalendar.
1340 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1341 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1342 # - "public" - The event is public and event details are visible to all readers of the calendar.
1343 # - "private" - The event is private and only event attendees may view event details.
1344 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1345 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1346 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1347 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1348 "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.
1349 "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'.
1350 },
1351 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
1352 "kind": "calendar#event", # Type of the resource ("calendar#event").
1353 "locked": True or 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.
1354 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1355 "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.
1356 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1357 "reminders": { # Information about the event's reminders for the authenticated user.
1358 "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.
1359 {
1360 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1361 "method": "A String", # The method used by this reminder. Possible values are:
1362 # - "email" - Reminders are sent via email.
1363 # - "sms" - Reminders are sent via SMS.
1364 # - "popup" - Reminders are sent via a UI popup.
1365 },
1366 ],
1367 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1368 },
1369 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1370 "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.
1371 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1372 "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.
1373 "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'.
1374 },
1375 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1376 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1377 # - "opaque" - The event blocks time on the calendar. This is the default value.
1378 # - "transparent" - The event does not block time on the calendar.
1379 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1380 }
1381
1382 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
1383 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.
1384
1385Returns:
1386 An object of the form:
1387
1388 {
1389 "creator": { # The creator of the event. Read-only.
1390 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1391 "displayName": "A String", # The creator's name, if available.
1392 "email": "A String", # The creator's email address, if available.
1393 "id": "A String", # The creator's Profile ID, if available.
1394 },
1395 "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.
1396 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1397 "displayName": "A String", # The organizer's name, if available.
1398 "email": "A String", # The organizer's email address, if available.
1399 "id": "A String", # The organizer's Profile ID, if available.
1400 },
1401 "summary": "A String", # Title of the event.
1402 "id": "A String", # Identifier of the event.
1403 "attendees": [ # The attendees of the event.
1404 {
1405 "comment": "A String", # The attendee's response comment. Optional.
1406 "displayName": "A String", # The attendee's name, if available. Optional.
1407 "responseStatus": "A String", # The attendee's response status. Possible values are:
1408 # - "needsAction" - The attendee has not responded to the invitation.
1409 # - "declined" - The attendee has declined the invitation.
1410 # - "tentative" - The attendee has tentatively accepted the invitation.
1411 # - "accepted" - The attendee has accepted the invitation.
1412 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1413 "id": "A String", # The attendee's Profile ID, if available.
1414 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1415 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1416 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1417 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1418 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1419 },
1420 ],
1421 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1422 "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.
1423 "A String",
1424 ],
1425 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1426 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1427 "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.
1428 "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'.
1429 },
1430 "etag": "A String", # ETag of the resource.
1431 "location": "A String", # Geographic location of the event as free-form text. Optional.
1432 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1433 "gadget": { # A gadget that extends this event.
1434 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001435 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001436 },
1437 "title": "A String", # The gadget's title.
1438 "height": 42, # The gadget's height in pixels. Optional.
1439 "width": 42, # The gadget's width in pixels. Optional.
1440 "link": "A String", # The gadget's URL.
1441 "type": "A String", # The gadget's type.
1442 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1443 # - "icon" - The gadget displays next to the event's title in the calendar view.
1444 # - "chip" - The gadget displays when the event is clicked.
1445 "iconLink": "A String", # The gadget's icon URL.
1446 },
1447 "status": "A String", # Status of the event. Optional. Possible values are:
1448 # - "confirmed" - The event is confirmed. This is the default status.
1449 # - "tentative" - The event is tentatively confirmed.
1450 # - "cancelled" - The event is cancelled.
1451 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1452 "description": "A String", # Description of the event. Optional.
1453 "iCalUID": "A String", # Event ID in the iCalendar format.
1454 "extendedProperties": { # Extended properties of the event.
1455 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001456 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001457 },
1458 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001459 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001460 },
1461 },
1462 "endTimeUnspecified": True or False,
1463 "sequence": 42, # Sequence number as per iCalendar.
1464 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1465 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1466 # - "public" - The event is public and event details are visible to all readers of the calendar.
1467 # - "private" - The event is private and only event attendees may view event details.
1468 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1469 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1470 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1471 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1472 "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.
1473 "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'.
1474 },
1475 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
1476 "kind": "calendar#event", # Type of the resource ("calendar#event").
1477 "locked": True or 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.
1478 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1479 "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.
1480 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1481 "reminders": { # Information about the event's reminders for the authenticated user.
1482 "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.
1483 {
1484 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1485 "method": "A String", # The method used by this reminder. Possible values are:
1486 # - "email" - Reminders are sent via email.
1487 # - "sms" - Reminders are sent via SMS.
1488 # - "popup" - Reminders are sent via a UI popup.
1489 },
1490 ],
1491 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1492 },
1493 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1494 "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.
1495 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1496 "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.
1497 "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'.
1498 },
1499 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1500 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1501 # - "opaque" - The event blocks time on the calendar. This is the default value.
1502 # - "transparent" - The event does not block time on the calendar.
1503 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1504 }</pre>
1505</div>
1506
1507<div class="method">
1508 <code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None)</code>
1509 <pre>Creates an event based on a simple text string.
1510
1511Args:
1512 calendarId: string, Calendar identifier. (required)
1513 text: string, The text describing the event to be created. (required)
1514 sendNotifications: boolean, Whether to send notifications about the creation of the event. Optional. The default is False.
1515
1516Returns:
1517 An object of the form:
1518
1519 {
1520 "creator": { # The creator of the event. Read-only.
1521 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1522 "displayName": "A String", # The creator's name, if available.
1523 "email": "A String", # The creator's email address, if available.
1524 "id": "A String", # The creator's Profile ID, if available.
1525 },
1526 "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.
1527 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1528 "displayName": "A String", # The organizer's name, if available.
1529 "email": "A String", # The organizer's email address, if available.
1530 "id": "A String", # The organizer's Profile ID, if available.
1531 },
1532 "summary": "A String", # Title of the event.
1533 "id": "A String", # Identifier of the event.
1534 "attendees": [ # The attendees of the event.
1535 {
1536 "comment": "A String", # The attendee's response comment. Optional.
1537 "displayName": "A String", # The attendee's name, if available. Optional.
1538 "responseStatus": "A String", # The attendee's response status. Possible values are:
1539 # - "needsAction" - The attendee has not responded to the invitation.
1540 # - "declined" - The attendee has declined the invitation.
1541 # - "tentative" - The attendee has tentatively accepted the invitation.
1542 # - "accepted" - The attendee has accepted the invitation.
1543 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1544 "id": "A String", # The attendee's Profile ID, if available.
1545 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1546 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1547 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1548 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1549 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1550 },
1551 ],
1552 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1553 "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.
1554 "A String",
1555 ],
1556 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1557 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1558 "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.
1559 "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'.
1560 },
1561 "etag": "A String", # ETag of the resource.
1562 "location": "A String", # Geographic location of the event as free-form text. Optional.
1563 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1564 "gadget": { # A gadget that extends this event.
1565 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001566 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001567 },
1568 "title": "A String", # The gadget's title.
1569 "height": 42, # The gadget's height in pixels. Optional.
1570 "width": 42, # The gadget's width in pixels. Optional.
1571 "link": "A String", # The gadget's URL.
1572 "type": "A String", # The gadget's type.
1573 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1574 # - "icon" - The gadget displays next to the event's title in the calendar view.
1575 # - "chip" - The gadget displays when the event is clicked.
1576 "iconLink": "A String", # The gadget's icon URL.
1577 },
1578 "status": "A String", # Status of the event. Optional. Possible values are:
1579 # - "confirmed" - The event is confirmed. This is the default status.
1580 # - "tentative" - The event is tentatively confirmed.
1581 # - "cancelled" - The event is cancelled.
1582 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1583 "description": "A String", # Description of the event. Optional.
1584 "iCalUID": "A String", # Event ID in the iCalendar format.
1585 "extendedProperties": { # Extended properties of the event.
1586 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001587 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001588 },
1589 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001590 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001591 },
1592 },
1593 "endTimeUnspecified": True or False,
1594 "sequence": 42, # Sequence number as per iCalendar.
1595 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1596 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1597 # - "public" - The event is public and event details are visible to all readers of the calendar.
1598 # - "private" - The event is private and only event attendees may view event details.
1599 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1600 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1601 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1602 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1603 "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.
1604 "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'.
1605 },
1606 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
1607 "kind": "calendar#event", # Type of the resource ("calendar#event").
1608 "locked": True or 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.
1609 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1610 "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.
1611 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1612 "reminders": { # Information about the event's reminders for the authenticated user.
1613 "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.
1614 {
1615 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1616 "method": "A String", # The method used by this reminder. Possible values are:
1617 # - "email" - Reminders are sent via email.
1618 # - "sms" - Reminders are sent via SMS.
1619 # - "popup" - Reminders are sent via a UI popup.
1620 },
1621 ],
1622 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1623 },
1624 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1625 "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.
1626 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1627 "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.
1628 "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'.
1629 },
1630 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1631 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1632 # - "opaque" - The event blocks time on the calendar. This is the default value.
1633 # - "transparent" - The event does not block time on the calendar.
1634 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1635 }</pre>
1636</div>
1637
1638<div class="method">
1639 <code class="details" id="update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None)</code>
1640 <pre>Updates an event.
1641
1642Args:
1643 calendarId: string, Calendar identifier. (required)
1644 eventId: string, Event identifier. (required)
1645 body: object, The request body. (required)
1646 The object takes the form of:
1647
1648{
1649 "creator": { # The creator of the event. Read-only.
1650 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1651 "displayName": "A String", # The creator's name, if available.
1652 "email": "A String", # The creator's email address, if available.
1653 "id": "A String", # The creator's Profile ID, if available.
1654 },
1655 "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.
1656 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1657 "displayName": "A String", # The organizer's name, if available.
1658 "email": "A String", # The organizer's email address, if available.
1659 "id": "A String", # The organizer's Profile ID, if available.
1660 },
1661 "summary": "A String", # Title of the event.
1662 "id": "A String", # Identifier of the event.
1663 "attendees": [ # The attendees of the event.
1664 {
1665 "comment": "A String", # The attendee's response comment. Optional.
1666 "displayName": "A String", # The attendee's name, if available. Optional.
1667 "responseStatus": "A String", # The attendee's response status. Possible values are:
1668 # - "needsAction" - The attendee has not responded to the invitation.
1669 # - "declined" - The attendee has declined the invitation.
1670 # - "tentative" - The attendee has tentatively accepted the invitation.
1671 # - "accepted" - The attendee has accepted the invitation.
1672 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1673 "id": "A String", # The attendee's Profile ID, if available.
1674 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1675 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1676 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1677 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1678 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1679 },
1680 ],
1681 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1682 "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.
1683 "A String",
1684 ],
1685 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1686 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1687 "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.
1688 "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'.
1689 },
1690 "etag": "A String", # ETag of the resource.
1691 "location": "A String", # Geographic location of the event as free-form text. Optional.
1692 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1693 "gadget": { # A gadget that extends this event.
1694 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001695 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001696 },
1697 "title": "A String", # The gadget's title.
1698 "height": 42, # The gadget's height in pixels. Optional.
1699 "width": 42, # The gadget's width in pixels. Optional.
1700 "link": "A String", # The gadget's URL.
1701 "type": "A String", # The gadget's type.
1702 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1703 # - "icon" - The gadget displays next to the event's title in the calendar view.
1704 # - "chip" - The gadget displays when the event is clicked.
1705 "iconLink": "A String", # The gadget's icon URL.
1706 },
1707 "status": "A String", # Status of the event. Optional. Possible values are:
1708 # - "confirmed" - The event is confirmed. This is the default status.
1709 # - "tentative" - The event is tentatively confirmed.
1710 # - "cancelled" - The event is cancelled.
1711 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1712 "description": "A String", # Description of the event. Optional.
1713 "iCalUID": "A String", # Event ID in the iCalendar format.
1714 "extendedProperties": { # Extended properties of the event.
1715 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001716 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001717 },
1718 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001719 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001720 },
1721 },
1722 "endTimeUnspecified": True or False,
1723 "sequence": 42, # Sequence number as per iCalendar.
1724 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1725 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1726 # - "public" - The event is public and event details are visible to all readers of the calendar.
1727 # - "private" - The event is private and only event attendees may view event details.
1728 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1729 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1730 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1731 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1732 "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.
1733 "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'.
1734 },
1735 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
1736 "kind": "calendar#event", # Type of the resource ("calendar#event").
1737 "locked": True or 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.
1738 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1739 "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.
1740 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1741 "reminders": { # Information about the event's reminders for the authenticated user.
1742 "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.
1743 {
1744 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1745 "method": "A String", # The method used by this reminder. Possible values are:
1746 # - "email" - Reminders are sent via email.
1747 # - "sms" - Reminders are sent via SMS.
1748 # - "popup" - Reminders are sent via a UI popup.
1749 },
1750 ],
1751 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1752 },
1753 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1754 "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.
1755 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1756 "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.
1757 "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'.
1758 },
1759 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1760 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1761 # - "opaque" - The event blocks time on the calendar. This is the default value.
1762 # - "transparent" - The event does not block time on the calendar.
1763 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1764 }
1765
1766 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
1767 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.
1768
1769Returns:
1770 An object of the form:
1771
1772 {
1773 "creator": { # The creator of the event. Read-only.
1774 "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1775 "displayName": "A String", # The creator's name, if available.
1776 "email": "A String", # The creator's email address, if available.
1777 "id": "A String", # The creator's Profile ID, if available.
1778 },
1779 "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.
1780 "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1781 "displayName": "A String", # The organizer's name, if available.
1782 "email": "A String", # The organizer's email address, if available.
1783 "id": "A String", # The organizer's Profile ID, if available.
1784 },
1785 "summary": "A String", # Title of the event.
1786 "id": "A String", # Identifier of the event.
1787 "attendees": [ # The attendees of the event.
1788 {
1789 "comment": "A String", # The attendee's response comment. Optional.
1790 "displayName": "A String", # The attendee's name, if available. Optional.
1791 "responseStatus": "A String", # The attendee's response status. Possible values are:
1792 # - "needsAction" - The attendee has not responded to the invitation.
1793 # - "declined" - The attendee has declined the invitation.
1794 # - "tentative" - The attendee has tentatively accepted the invitation.
1795 # - "accepted" - The attendee has accepted the invitation.
1796 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1797 "id": "A String", # The attendee's Profile ID, if available.
1798 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1799 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1800 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1801 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1802 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1803 },
1804 ],
1805 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1806 "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.
1807 "A String",
1808 ],
1809 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1810 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1811 "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.
1812 "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'.
1813 },
1814 "etag": "A String", # ETag of the resource.
1815 "location": "A String", # Geographic location of the event as free-form text. Optional.
1816 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1817 "gadget": { # A gadget that extends this event.
1818 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001819 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001820 },
1821 "title": "A String", # The gadget's title.
1822 "height": 42, # The gadget's height in pixels. Optional.
1823 "width": 42, # The gadget's width in pixels. Optional.
1824 "link": "A String", # The gadget's URL.
1825 "type": "A String", # The gadget's type.
1826 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1827 # - "icon" - The gadget displays next to the event's title in the calendar view.
1828 # - "chip" - The gadget displays when the event is clicked.
1829 "iconLink": "A String", # The gadget's icon URL.
1830 },
1831 "status": "A String", # Status of the event. Optional. Possible values are:
1832 # - "confirmed" - The event is confirmed. This is the default status.
1833 # - "tentative" - The event is tentatively confirmed.
1834 # - "cancelled" - The event is cancelled.
1835 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1836 "description": "A String", # Description of the event. Optional.
1837 "iCalUID": "A String", # Event ID in the iCalendar format.
1838 "extendedProperties": { # Extended properties of the event.
1839 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001840 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001841 },
1842 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001843 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001844 },
1845 },
1846 "endTimeUnspecified": True or False,
1847 "sequence": 42, # Sequence number as per iCalendar.
1848 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1849 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1850 # - "public" - The event is public and event details are visible to all readers of the calendar.
1851 # - "private" - The event is private and only event attendees may view event details.
1852 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1853 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1854 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1855 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1856 "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.
1857 "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'.
1858 },
1859 "attendeesOmitted": True or False, # Whether attendees have been omitted from the event's representation. When retrieving an event, this is 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.
1860 "kind": "calendar#event", # Type of the resource ("calendar#event").
1861 "locked": True or 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.
1862 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1863 "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.
1864 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1865 "reminders": { # Information about the event's reminders for the authenticated user.
1866 "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.
1867 {
1868 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1869 "method": "A String", # The method used by this reminder. Possible values are:
1870 # - "email" - Reminders are sent via email.
1871 # - "sms" - Reminders are sent via SMS.
1872 # - "popup" - Reminders are sent via a UI popup.
1873 },
1874 ],
1875 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1876 },
1877 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1878 "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.
1879 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1880 "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.
1881 "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'.
1882 },
1883 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1884 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1885 # - "opaque" - The event blocks time on the calendar. This is the default value.
1886 # - "transparent" - The event does not block time on the calendar.
1887 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1888 }</pre>
1889</div>
1890
1891</body></html>