blob: a63dec795bce2443d2f2945c4efc49bb6cfe724c [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.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400154 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400155 "attendees": [ # The attendees of the event.
156 {
157 "comment": "A String", # The attendee's response comment. Optional.
158 "displayName": "A String", # The attendee's name, if available. Optional.
159 "responseStatus": "A String", # The attendee's response status. Possible values are:
160 # - "needsAction" - The attendee has not responded to the invitation.
161 # - "declined" - The attendee has declined the invitation.
162 # - "tentative" - The attendee has tentatively accepted the invitation.
163 # - "accepted" - The attendee has accepted the invitation.
164 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
165 "id": "A String", # The attendee's Profile ID, if available.
166 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
167 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
168 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
169 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
170 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
171 },
172 ],
173 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
174 "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.
175 "A String",
176 ],
177 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
178 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
179 "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.
180 "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'.
181 },
182 "etag": "A String", # ETag of the resource.
183 "location": "A String", # Geographic location of the event as free-form text. Optional.
184 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
185 "gadget": { # A gadget that extends this event.
186 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400187 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400188 },
189 "title": "A String", # The gadget's title.
190 "height": 42, # The gadget's height in pixels. Optional.
191 "width": 42, # The gadget's width in pixels. Optional.
192 "link": "A String", # The gadget's URL.
193 "type": "A String", # The gadget's type.
194 "display": "A String", # The gadget's display mode. Optional. Possible values are:
195 # - "icon" - The gadget displays next to the event's title in the calendar view.
196 # - "chip" - The gadget displays when the event is clicked.
197 "iconLink": "A String", # The gadget's icon URL.
198 },
199 "status": "A String", # Status of the event. Optional. Possible values are:
200 # - "confirmed" - The event is confirmed. This is the default status.
201 # - "tentative" - The event is tentatively confirmed.
202 # - "cancelled" - The event is cancelled.
203 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
204 "description": "A String", # Description of the event. Optional.
205 "iCalUID": "A String", # Event ID in the iCalendar format.
206 "extendedProperties": { # Extended properties of the event.
207 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400208 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400209 },
210 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400211 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400212 },
213 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400214 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400215 "sequence": 42, # Sequence number as per iCalendar.
216 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
217 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
218 # - "public" - The event is public and event details are visible to all readers of the calendar.
219 # - "private" - The event is private and only event attendees may view event details.
220 # - "confidential" - The event is private. This value is provided for compatibility reasons.
221 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
222 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
223 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
224 "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.
225 "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'.
226 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400227 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400228 "kind": "calendar#event", # Type of the resource ("calendar#event").
229 "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.
230 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
231 "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.
232 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
233 "reminders": { # Information about the event's reminders for the authenticated user.
234 "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.
235 {
236 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
237 "method": "A String", # The method used by this reminder. Possible values are:
238 # - "email" - Reminders are sent via email.
239 # - "sms" - Reminders are sent via SMS.
240 # - "popup" - Reminders are sent via a UI popup.
241 },
242 ],
243 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
244 },
245 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
246 "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.
247 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
248 "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.
249 "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'.
250 },
251 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
252 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
253 # - "opaque" - The event blocks time on the calendar. This is the default value.
254 # - "transparent" - The event does not block time on the calendar.
255 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
256 }</pre>
257</div>
258
259<div class="method">
260 <code class="details" id="import_">import_(calendarId, body)</code>
261 <pre>Imports an event.
262
263Args:
264 calendarId: string, Calendar identifier. (required)
265 body: object, The request body. (required)
266 The object takes the form of:
267
268{
269 "creator": { # The creator of the event. Read-only.
270 "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.
271 "displayName": "A String", # The creator's name, if available.
272 "email": "A String", # The creator's email address, if available.
273 "id": "A String", # The creator's Profile ID, if available.
274 },
275 "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.
276 "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.
277 "displayName": "A String", # The organizer's name, if available.
278 "email": "A String", # The organizer's email address, if available.
279 "id": "A String", # The organizer's Profile ID, if available.
280 },
281 "summary": "A String", # Title of the event.
282 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400283 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400284 "attendees": [ # The attendees of the event.
285 {
286 "comment": "A String", # The attendee's response comment. Optional.
287 "displayName": "A String", # The attendee's name, if available. Optional.
288 "responseStatus": "A String", # The attendee's response status. Possible values are:
289 # - "needsAction" - The attendee has not responded to the invitation.
290 # - "declined" - The attendee has declined the invitation.
291 # - "tentative" - The attendee has tentatively accepted the invitation.
292 # - "accepted" - The attendee has accepted the invitation.
293 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
294 "id": "A String", # The attendee's Profile ID, if available.
295 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
296 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
297 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
298 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
299 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
300 },
301 ],
302 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
303 "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.
304 "A String",
305 ],
306 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
307 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
308 "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.
309 "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'.
310 },
311 "etag": "A String", # ETag of the resource.
312 "location": "A String", # Geographic location of the event as free-form text. Optional.
313 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
314 "gadget": { # A gadget that extends this event.
315 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400316 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400317 },
318 "title": "A String", # The gadget's title.
319 "height": 42, # The gadget's height in pixels. Optional.
320 "width": 42, # The gadget's width in pixels. Optional.
321 "link": "A String", # The gadget's URL.
322 "type": "A String", # The gadget's type.
323 "display": "A String", # The gadget's display mode. Optional. Possible values are:
324 # - "icon" - The gadget displays next to the event's title in the calendar view.
325 # - "chip" - The gadget displays when the event is clicked.
326 "iconLink": "A String", # The gadget's icon URL.
327 },
328 "status": "A String", # Status of the event. Optional. Possible values are:
329 # - "confirmed" - The event is confirmed. This is the default status.
330 # - "tentative" - The event is tentatively confirmed.
331 # - "cancelled" - The event is cancelled.
332 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
333 "description": "A String", # Description of the event. Optional.
334 "iCalUID": "A String", # Event ID in the iCalendar format.
335 "extendedProperties": { # Extended properties of the event.
336 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400337 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400338 },
339 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400340 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400341 },
342 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400343 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400344 "sequence": 42, # Sequence number as per iCalendar.
345 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
346 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
347 # - "public" - The event is public and event details are visible to all readers of the calendar.
348 # - "private" - The event is private and only event attendees may view event details.
349 # - "confidential" - The event is private. This value is provided for compatibility reasons.
350 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
351 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
352 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
353 "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.
354 "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'.
355 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400356 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400357 "kind": "calendar#event", # Type of the resource ("calendar#event").
358 "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.
359 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
360 "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.
361 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
362 "reminders": { # Information about the event's reminders for the authenticated user.
363 "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.
364 {
365 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
366 "method": "A String", # The method used by this reminder. Possible values are:
367 # - "email" - Reminders are sent via email.
368 # - "sms" - Reminders are sent via SMS.
369 # - "popup" - Reminders are sent via a UI popup.
370 },
371 ],
372 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
373 },
374 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
375 "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.
376 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
377 "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.
378 "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'.
379 },
380 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
381 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
382 # - "opaque" - The event blocks time on the calendar. This is the default value.
383 # - "transparent" - The event does not block time on the calendar.
384 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
385 }
386
387
388Returns:
389 An object of the form:
390
391 {
392 "creator": { # The creator of the event. Read-only.
393 "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.
394 "displayName": "A String", # The creator's name, if available.
395 "email": "A String", # The creator's email address, if available.
396 "id": "A String", # The creator's Profile ID, if available.
397 },
398 "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.
399 "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.
400 "displayName": "A String", # The organizer's name, if available.
401 "email": "A String", # The organizer's email address, if available.
402 "id": "A String", # The organizer's Profile ID, if available.
403 },
404 "summary": "A String", # Title of the event.
405 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400406 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400407 "attendees": [ # The attendees of the event.
408 {
409 "comment": "A String", # The attendee's response comment. Optional.
410 "displayName": "A String", # The attendee's name, if available. Optional.
411 "responseStatus": "A String", # The attendee's response status. Possible values are:
412 # - "needsAction" - The attendee has not responded to the invitation.
413 # - "declined" - The attendee has declined the invitation.
414 # - "tentative" - The attendee has tentatively accepted the invitation.
415 # - "accepted" - The attendee has accepted the invitation.
416 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
417 "id": "A String", # The attendee's Profile ID, if available.
418 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
419 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
420 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
421 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
422 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
423 },
424 ],
425 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
426 "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.
427 "A String",
428 ],
429 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
430 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
431 "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.
432 "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'.
433 },
434 "etag": "A String", # ETag of the resource.
435 "location": "A String", # Geographic location of the event as free-form text. Optional.
436 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
437 "gadget": { # A gadget that extends this event.
438 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400439 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400440 },
441 "title": "A String", # The gadget's title.
442 "height": 42, # The gadget's height in pixels. Optional.
443 "width": 42, # The gadget's width in pixels. Optional.
444 "link": "A String", # The gadget's URL.
445 "type": "A String", # The gadget's type.
446 "display": "A String", # The gadget's display mode. Optional. Possible values are:
447 # - "icon" - The gadget displays next to the event's title in the calendar view.
448 # - "chip" - The gadget displays when the event is clicked.
449 "iconLink": "A String", # The gadget's icon URL.
450 },
451 "status": "A String", # Status of the event. Optional. Possible values are:
452 # - "confirmed" - The event is confirmed. This is the default status.
453 # - "tentative" - The event is tentatively confirmed.
454 # - "cancelled" - The event is cancelled.
455 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
456 "description": "A String", # Description of the event. Optional.
457 "iCalUID": "A String", # Event ID in the iCalendar format.
458 "extendedProperties": { # Extended properties of the event.
459 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400460 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400461 },
462 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400463 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400464 },
465 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400466 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400467 "sequence": 42, # Sequence number as per iCalendar.
468 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
469 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
470 # - "public" - The event is public and event details are visible to all readers of the calendar.
471 # - "private" - The event is private and only event attendees may view event details.
472 # - "confidential" - The event is private. This value is provided for compatibility reasons.
473 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
474 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
475 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
476 "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.
477 "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'.
478 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400479 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400480 "kind": "calendar#event", # Type of the resource ("calendar#event").
481 "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.
482 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
483 "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.
484 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
485 "reminders": { # Information about the event's reminders for the authenticated user.
486 "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.
487 {
488 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
489 "method": "A String", # The method used by this reminder. Possible values are:
490 # - "email" - Reminders are sent via email.
491 # - "sms" - Reminders are sent via SMS.
492 # - "popup" - Reminders are sent via a UI popup.
493 },
494 ],
495 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
496 },
497 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
498 "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.
499 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
500 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
501 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
502 },
503 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
504 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
505 # - "opaque" - The event blocks time on the calendar. This is the default value.
506 # - "transparent" - The event does not block time on the calendar.
507 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
508 }</pre>
509</div>
510
511<div class="method">
512 <code class="details" id="insert">insert(calendarId, body, sendNotifications=None)</code>
513 <pre>Creates an event.
514
515Args:
516 calendarId: string, Calendar identifier. (required)
517 body: object, The request body. (required)
518 The object takes the form of:
519
520{
521 "creator": { # The creator of the event. Read-only.
522 "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.
523 "displayName": "A String", # The creator's name, if available.
524 "email": "A String", # The creator's email address, if available.
525 "id": "A String", # The creator's Profile ID, if available.
526 },
527 "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.
528 "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.
529 "displayName": "A String", # The organizer's name, if available.
530 "email": "A String", # The organizer's email address, if available.
531 "id": "A String", # The organizer's Profile ID, if available.
532 },
533 "summary": "A String", # Title of the event.
534 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400535 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400536 "attendees": [ # The attendees of the event.
537 {
538 "comment": "A String", # The attendee's response comment. Optional.
539 "displayName": "A String", # The attendee's name, if available. Optional.
540 "responseStatus": "A String", # The attendee's response status. Possible values are:
541 # - "needsAction" - The attendee has not responded to the invitation.
542 # - "declined" - The attendee has declined the invitation.
543 # - "tentative" - The attendee has tentatively accepted the invitation.
544 # - "accepted" - The attendee has accepted the invitation.
545 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
546 "id": "A String", # The attendee's Profile ID, if available.
547 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
548 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
549 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
550 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
551 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
552 },
553 ],
554 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
555 "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.
556 "A String",
557 ],
558 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
559 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
560 "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.
561 "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'.
562 },
563 "etag": "A String", # ETag of the resource.
564 "location": "A String", # Geographic location of the event as free-form text. Optional.
565 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
566 "gadget": { # A gadget that extends this event.
567 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400568 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400569 },
570 "title": "A String", # The gadget's title.
571 "height": 42, # The gadget's height in pixels. Optional.
572 "width": 42, # The gadget's width in pixels. Optional.
573 "link": "A String", # The gadget's URL.
574 "type": "A String", # The gadget's type.
575 "display": "A String", # The gadget's display mode. Optional. Possible values are:
576 # - "icon" - The gadget displays next to the event's title in the calendar view.
577 # - "chip" - The gadget displays when the event is clicked.
578 "iconLink": "A String", # The gadget's icon URL.
579 },
580 "status": "A String", # Status of the event. Optional. Possible values are:
581 # - "confirmed" - The event is confirmed. This is the default status.
582 # - "tentative" - The event is tentatively confirmed.
583 # - "cancelled" - The event is cancelled.
584 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
585 "description": "A String", # Description of the event. Optional.
586 "iCalUID": "A String", # Event ID in the iCalendar format.
587 "extendedProperties": { # Extended properties of the event.
588 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400589 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400590 },
591 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400592 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400593 },
594 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400595 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400596 "sequence": 42, # Sequence number as per iCalendar.
597 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
598 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
599 # - "public" - The event is public and event details are visible to all readers of the calendar.
600 # - "private" - The event is private and only event attendees may view event details.
601 # - "confidential" - The event is private. This value is provided for compatibility reasons.
602 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
603 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
604 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
605 "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.
606 "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'.
607 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400608 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400609 "kind": "calendar#event", # Type of the resource ("calendar#event").
610 "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.
611 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
612 "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.
613 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
614 "reminders": { # Information about the event's reminders for the authenticated user.
615 "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.
616 {
617 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
618 "method": "A String", # The method used by this reminder. Possible values are:
619 # - "email" - Reminders are sent via email.
620 # - "sms" - Reminders are sent via SMS.
621 # - "popup" - Reminders are sent via a UI popup.
622 },
623 ],
624 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
625 },
626 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
627 "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.
628 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
629 "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.
630 "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'.
631 },
632 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
633 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
634 # - "opaque" - The event blocks time on the calendar. This is the default value.
635 # - "transparent" - The event does not block time on the calendar.
636 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
637 }
638
639 sendNotifications: boolean, Whether to send notifications about the creation of the new event. Optional. The default is False.
640
641Returns:
642 An object of the form:
643
644 {
645 "creator": { # The creator of the event. Read-only.
646 "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.
647 "displayName": "A String", # The creator's name, if available.
648 "email": "A String", # The creator's email address, if available.
649 "id": "A String", # The creator's Profile ID, if available.
650 },
651 "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.
652 "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.
653 "displayName": "A String", # The organizer's name, if available.
654 "email": "A String", # The organizer's email address, if available.
655 "id": "A String", # The organizer's Profile ID, if available.
656 },
657 "summary": "A String", # Title of the event.
658 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400659 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400660 "attendees": [ # The attendees of the event.
661 {
662 "comment": "A String", # The attendee's response comment. Optional.
663 "displayName": "A String", # The attendee's name, if available. Optional.
664 "responseStatus": "A String", # The attendee's response status. Possible values are:
665 # - "needsAction" - The attendee has not responded to the invitation.
666 # - "declined" - The attendee has declined the invitation.
667 # - "tentative" - The attendee has tentatively accepted the invitation.
668 # - "accepted" - The attendee has accepted the invitation.
669 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
670 "id": "A String", # The attendee's Profile ID, if available.
671 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
672 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
673 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
674 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
675 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
676 },
677 ],
678 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
679 "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.
680 "A String",
681 ],
682 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
683 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
684 "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.
685 "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'.
686 },
687 "etag": "A String", # ETag of the resource.
688 "location": "A String", # Geographic location of the event as free-form text. Optional.
689 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
690 "gadget": { # A gadget that extends this event.
691 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400692 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400693 },
694 "title": "A String", # The gadget's title.
695 "height": 42, # The gadget's height in pixels. Optional.
696 "width": 42, # The gadget's width in pixels. Optional.
697 "link": "A String", # The gadget's URL.
698 "type": "A String", # The gadget's type.
699 "display": "A String", # The gadget's display mode. Optional. Possible values are:
700 # - "icon" - The gadget displays next to the event's title in the calendar view.
701 # - "chip" - The gadget displays when the event is clicked.
702 "iconLink": "A String", # The gadget's icon URL.
703 },
704 "status": "A String", # Status of the event. Optional. Possible values are:
705 # - "confirmed" - The event is confirmed. This is the default status.
706 # - "tentative" - The event is tentatively confirmed.
707 # - "cancelled" - The event is cancelled.
708 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
709 "description": "A String", # Description of the event. Optional.
710 "iCalUID": "A String", # Event ID in the iCalendar format.
711 "extendedProperties": { # Extended properties of the event.
712 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400713 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400714 },
715 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400716 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400717 },
718 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400719 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400720 "sequence": 42, # Sequence number as per iCalendar.
721 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
722 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
723 # - "public" - The event is public and event details are visible to all readers of the calendar.
724 # - "private" - The event is private and only event attendees may view event details.
725 # - "confidential" - The event is private. This value is provided for compatibility reasons.
726 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
727 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
728 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
729 "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.
730 "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'.
731 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400732 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400733 "kind": "calendar#event", # Type of the resource ("calendar#event").
734 "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.
735 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
736 "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.
737 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
738 "reminders": { # Information about the event's reminders for the authenticated user.
739 "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.
740 {
741 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
742 "method": "A String", # The method used by this reminder. Possible values are:
743 # - "email" - Reminders are sent via email.
744 # - "sms" - Reminders are sent via SMS.
745 # - "popup" - Reminders are sent via a UI popup.
746 },
747 ],
748 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
749 },
750 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
751 "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.
752 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
753 "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.
754 "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'.
755 },
756 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
757 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
758 # - "opaque" - The event blocks time on the calendar. This is the default value.
759 # - "transparent" - The event does not block time on the calendar.
760 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
761 }</pre>
762</div>
763
764<div class="method">
765 <code class="details" id="instances">instances(calendarId, eventId, pageToken=None, alwaysIncludeEmail=None, maxResults=None, showDeleted=None, timeZone=None, originalStart=None, maxAttendees=None)</code>
766 <pre>Returns instances of the specified recurring event.
767
768Args:
769 calendarId: string, Calendar identifier. (required)
770 eventId: string, Recurring event identifier. (required)
771 pageToken: string, Token specifying which result page to return. Optional.
772 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.
773 maxResults: integer, Maximum number of events returned on one result page. Optional.
774 showDeleted: boolean, Whether to include deleted events (with 'eventStatus' equals 'cancelled') in the result. Optional. The default is False.
775 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
776 originalStart: string, The original start time of the instance in the result. Optional.
777 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.
778
779Returns:
780 An object of the form:
781
782 {
783 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
784 "kind": "calendar#events", # Type of the collection ("calendar#events").
785 "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').
786 {
787 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
788 "method": "A String", # The method used by this reminder. Possible values are:
789 # - "email" - Reminders are sent via email.
790 # - "sms" - Reminders are sent via SMS.
791 # - "popup" - Reminders are sent via a UI popup.
792 },
793 ],
794 "description": "A String", # Description of the calendar. Read-only.
795 "items": [ # List of events on the calendar.
796 {
797 "creator": { # The creator of the event. Read-only.
798 "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.
799 "displayName": "A String", # The creator's name, if available.
800 "email": "A String", # The creator's email address, if available.
801 "id": "A String", # The creator's Profile ID, if available.
802 },
803 "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.
804 "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.
805 "displayName": "A String", # The organizer's name, if available.
806 "email": "A String", # The organizer's email address, if available.
807 "id": "A String", # The organizer's Profile ID, if available.
808 },
809 "summary": "A String", # Title of the event.
810 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400811 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400812 "attendees": [ # The attendees of the event.
813 {
814 "comment": "A String", # The attendee's response comment. Optional.
815 "displayName": "A String", # The attendee's name, if available. Optional.
816 "responseStatus": "A String", # The attendee's response status. Possible values are:
817 # - "needsAction" - The attendee has not responded to the invitation.
818 # - "declined" - The attendee has declined the invitation.
819 # - "tentative" - The attendee has tentatively accepted the invitation.
820 # - "accepted" - The attendee has accepted the invitation.
821 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
822 "id": "A String", # The attendee's Profile ID, if available.
823 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
824 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
825 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
826 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
827 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
828 },
829 ],
830 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
831 "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.
832 "A String",
833 ],
834 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
835 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
836 "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.
837 "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'.
838 },
839 "etag": "A String", # ETag of the resource.
840 "location": "A String", # Geographic location of the event as free-form text. Optional.
841 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
842 "gadget": { # A gadget that extends this event.
843 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400844 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400845 },
846 "title": "A String", # The gadget's title.
847 "height": 42, # The gadget's height in pixels. Optional.
848 "width": 42, # The gadget's width in pixels. Optional.
849 "link": "A String", # The gadget's URL.
850 "type": "A String", # The gadget's type.
851 "display": "A String", # The gadget's display mode. Optional. Possible values are:
852 # - "icon" - The gadget displays next to the event's title in the calendar view.
853 # - "chip" - The gadget displays when the event is clicked.
854 "iconLink": "A String", # The gadget's icon URL.
855 },
856 "status": "A String", # Status of the event. Optional. Possible values are:
857 # - "confirmed" - The event is confirmed. This is the default status.
858 # - "tentative" - The event is tentatively confirmed.
859 # - "cancelled" - The event is cancelled.
860 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
861 "description": "A String", # Description of the event. Optional.
862 "iCalUID": "A String", # Event ID in the iCalendar format.
863 "extendedProperties": { # Extended properties of the event.
864 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400865 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400866 },
867 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400868 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400869 },
870 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400871 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400872 "sequence": 42, # Sequence number as per iCalendar.
873 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
874 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
875 # - "public" - The event is public and event details are visible to all readers of the calendar.
876 # - "private" - The event is private and only event attendees may view event details.
877 # - "confidential" - The event is private. This value is provided for compatibility reasons.
878 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
879 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
880 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
881 "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.
882 "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'.
883 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400884 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400885 "kind": "calendar#event", # Type of the resource ("calendar#event").
886 "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.
887 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
888 "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.
889 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
890 "reminders": { # Information about the event's reminders for the authenticated user.
891 "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.
892 {
893 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
894 "method": "A String", # The method used by this reminder. Possible values are:
895 # - "email" - Reminders are sent via email.
896 # - "sms" - Reminders are sent via SMS.
897 # - "popup" - Reminders are sent via a UI popup.
898 },
899 ],
900 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
901 },
902 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
903 "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.
904 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
905 "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.
906 "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'.
907 },
908 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
909 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
910 # - "opaque" - The event blocks time on the calendar. This is the default value.
911 # - "transparent" - The event does not block time on the calendar.
912 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
913 },
914 ],
915 "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
916 "summary": "A String", # Title of the calendar. Read-only.
917 "etag": "A String", # ETag of the collection.
918 "timeZone": "A String", # The time zone of the calendar. Read-only.
919 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
920 # - "none" - The user has no access.
921 # - "freeBusyReader" - The user has read access to free/busy information.
922 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
923 # - "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.
924 # - "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.
925 }</pre>
926</div>
927
928<div class="method">
929 <code class="details" id="instances_next">instances_next(previous_request, previous_response)</code>
930 <pre>Retrieves the next page of results.
931
932Args:
933 previous_request: The request for the previous page. (required)
934 previous_response: The response from the request for the previous page. (required)
935
936Returns:
937 A request object that you can call 'execute()' on to request the next
938 page. Returns None if there are no more items in the collection.
939 </pre>
940</div>
941
942<div class="method">
943 <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>
944 <pre>Returns events on the specified calendar.
945
946Args:
947 calendarId: string, Calendar identifier. (required)
948 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
949 Allowed values
950 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter "singleEvents" is True)
951 updated - Order by last modification time (ascending).
952 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
953 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
954 pageToken: string, Token specifying which result page to return. Optional.
955 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.
956 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.
957 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.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400958 showDeleted: boolean, Whether to include deleted single events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events will still be included if 'singleEvents' is False. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400959 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.
960 iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.
961 maxResults: integer, Maximum number of events returned on one result page. Optional.
962 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
963 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
964 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
965
966Returns:
967 An object of the form:
968
969 {
970 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
971 "kind": "calendar#events", # Type of the collection ("calendar#events").
972 "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').
973 {
974 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
975 "method": "A String", # The method used by this reminder. Possible values are:
976 # - "email" - Reminders are sent via email.
977 # - "sms" - Reminders are sent via SMS.
978 # - "popup" - Reminders are sent via a UI popup.
979 },
980 ],
981 "description": "A String", # Description of the calendar. Read-only.
982 "items": [ # List of events on the calendar.
983 {
984 "creator": { # The creator of the event. Read-only.
985 "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.
986 "displayName": "A String", # The creator's name, if available.
987 "email": "A String", # The creator's email address, if available.
988 "id": "A String", # The creator's Profile ID, if available.
989 },
990 "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.
991 "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.
992 "displayName": "A String", # The organizer's name, if available.
993 "email": "A String", # The organizer's email address, if available.
994 "id": "A String", # The organizer's Profile ID, if available.
995 },
996 "summary": "A String", # Title of the event.
997 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400998 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400999 "attendees": [ # The attendees of the event.
1000 {
1001 "comment": "A String", # The attendee's response comment. Optional.
1002 "displayName": "A String", # The attendee's name, if available. Optional.
1003 "responseStatus": "A String", # The attendee's response status. Possible values are:
1004 # - "needsAction" - The attendee has not responded to the invitation.
1005 # - "declined" - The attendee has declined the invitation.
1006 # - "tentative" - The attendee has tentatively accepted the invitation.
1007 # - "accepted" - The attendee has accepted the invitation.
1008 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1009 "id": "A String", # The attendee's Profile ID, if available.
1010 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1011 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1012 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1013 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1014 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1015 },
1016 ],
1017 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1018 "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.
1019 "A String",
1020 ],
1021 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1022 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1023 "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.
1024 "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'.
1025 },
1026 "etag": "A String", # ETag of the resource.
1027 "location": "A String", # Geographic location of the event as free-form text. Optional.
1028 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1029 "gadget": { # A gadget that extends this event.
1030 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001031 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001032 },
1033 "title": "A String", # The gadget's title.
1034 "height": 42, # The gadget's height in pixels. Optional.
1035 "width": 42, # The gadget's width in pixels. Optional.
1036 "link": "A String", # The gadget's URL.
1037 "type": "A String", # The gadget's type.
1038 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1039 # - "icon" - The gadget displays next to the event's title in the calendar view.
1040 # - "chip" - The gadget displays when the event is clicked.
1041 "iconLink": "A String", # The gadget's icon URL.
1042 },
1043 "status": "A String", # Status of the event. Optional. Possible values are:
1044 # - "confirmed" - The event is confirmed. This is the default status.
1045 # - "tentative" - The event is tentatively confirmed.
1046 # - "cancelled" - The event is cancelled.
1047 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1048 "description": "A String", # Description of the event. Optional.
1049 "iCalUID": "A String", # Event ID in the iCalendar format.
1050 "extendedProperties": { # Extended properties of the event.
1051 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001052 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001053 },
1054 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001055 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001056 },
1057 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001058 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001059 "sequence": 42, # Sequence number as per iCalendar.
1060 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1061 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1062 # - "public" - The event is public and event details are visible to all readers of the calendar.
1063 # - "private" - The event is private and only event attendees may view event details.
1064 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1065 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1066 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1067 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1068 "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.
1069 "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'.
1070 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001071 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001072 "kind": "calendar#event", # Type of the resource ("calendar#event").
1073 "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.
1074 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1075 "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.
1076 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1077 "reminders": { # Information about the event's reminders for the authenticated user.
1078 "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.
1079 {
1080 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1081 "method": "A String", # The method used by this reminder. Possible values are:
1082 # - "email" - Reminders are sent via email.
1083 # - "sms" - Reminders are sent via SMS.
1084 # - "popup" - Reminders are sent via a UI popup.
1085 },
1086 ],
1087 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1088 },
1089 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1090 "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.
1091 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1092 "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.
1093 "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'.
1094 },
1095 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1096 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1097 # - "opaque" - The event blocks time on the calendar. This is the default value.
1098 # - "transparent" - The event does not block time on the calendar.
1099 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1100 },
1101 ],
1102 "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
1103 "summary": "A String", # Title of the calendar. Read-only.
1104 "etag": "A String", # ETag of the collection.
1105 "timeZone": "A String", # The time zone of the calendar. Read-only.
1106 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
1107 # - "none" - The user has no access.
1108 # - "freeBusyReader" - The user has read access to free/busy information.
1109 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
1110 # - "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.
1111 # - "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.
1112 }</pre>
1113</div>
1114
1115<div class="method">
1116 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1117 <pre>Retrieves the next page of results.
1118
1119Args:
1120 previous_request: The request for the previous page. (required)
1121 previous_response: The response from the request for the previous page. (required)
1122
1123Returns:
1124 A request object that you can call 'execute()' on to request the next
1125 page. Returns None if there are no more items in the collection.
1126 </pre>
1127</div>
1128
1129<div class="method">
1130 <code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None)</code>
1131 <pre>Moves an event to another calendar, i.e. changes an event's organizer.
1132
1133Args:
1134 calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)
1135 eventId: string, Event identifier. (required)
1136 destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)
1137 sendNotifications: boolean, Whether to send notifications about the change of the event's organizer. Optional. The default is False.
1138
1139Returns:
1140 An object of the form:
1141
1142 {
1143 "creator": { # The creator of the event. Read-only.
1144 "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.
1145 "displayName": "A String", # The creator's name, if available.
1146 "email": "A String", # The creator's email address, if available.
1147 "id": "A String", # The creator's Profile ID, if available.
1148 },
1149 "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.
1150 "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.
1151 "displayName": "A String", # The organizer's name, if available.
1152 "email": "A String", # The organizer's email address, if available.
1153 "id": "A String", # The organizer's Profile ID, if available.
1154 },
1155 "summary": "A String", # Title of the event.
1156 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -04001157 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -04001158 "attendees": [ # The attendees of the event.
1159 {
1160 "comment": "A String", # The attendee's response comment. Optional.
1161 "displayName": "A String", # The attendee's name, if available. Optional.
1162 "responseStatus": "A String", # The attendee's response status. Possible values are:
1163 # - "needsAction" - The attendee has not responded to the invitation.
1164 # - "declined" - The attendee has declined the invitation.
1165 # - "tentative" - The attendee has tentatively accepted the invitation.
1166 # - "accepted" - The attendee has accepted the invitation.
1167 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1168 "id": "A String", # The attendee's Profile ID, if available.
1169 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1170 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1171 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1172 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1173 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1174 },
1175 ],
1176 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1177 "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.
1178 "A String",
1179 ],
1180 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1181 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1182 "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.
1183 "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'.
1184 },
1185 "etag": "A String", # ETag of the resource.
1186 "location": "A String", # Geographic location of the event as free-form text. Optional.
1187 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1188 "gadget": { # A gadget that extends this event.
1189 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001190 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001191 },
1192 "title": "A String", # The gadget's title.
1193 "height": 42, # The gadget's height in pixels. Optional.
1194 "width": 42, # The gadget's width in pixels. Optional.
1195 "link": "A String", # The gadget's URL.
1196 "type": "A String", # The gadget's type.
1197 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1198 # - "icon" - The gadget displays next to the event's title in the calendar view.
1199 # - "chip" - The gadget displays when the event is clicked.
1200 "iconLink": "A String", # The gadget's icon URL.
1201 },
1202 "status": "A String", # Status of the event. Optional. Possible values are:
1203 # - "confirmed" - The event is confirmed. This is the default status.
1204 # - "tentative" - The event is tentatively confirmed.
1205 # - "cancelled" - The event is cancelled.
1206 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1207 "description": "A String", # Description of the event. Optional.
1208 "iCalUID": "A String", # Event ID in the iCalendar format.
1209 "extendedProperties": { # Extended properties of the event.
1210 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001211 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001212 },
1213 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001214 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001215 },
1216 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001217 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001218 "sequence": 42, # Sequence number as per iCalendar.
1219 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1220 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1221 # - "public" - The event is public and event details are visible to all readers of the calendar.
1222 # - "private" - The event is private and only event attendees may view event details.
1223 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1224 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1225 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1226 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1227 "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.
1228 "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'.
1229 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001230 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001231 "kind": "calendar#event", # Type of the resource ("calendar#event").
1232 "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.
1233 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1234 "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.
1235 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1236 "reminders": { # Information about the event's reminders for the authenticated user.
1237 "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.
1238 {
1239 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1240 "method": "A String", # The method used by this reminder. Possible values are:
1241 # - "email" - Reminders are sent via email.
1242 # - "sms" - Reminders are sent via SMS.
1243 # - "popup" - Reminders are sent via a UI popup.
1244 },
1245 ],
1246 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1247 },
1248 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1249 "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.
1250 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1251 "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.
1252 "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'.
1253 },
1254 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1255 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1256 # - "opaque" - The event blocks time on the calendar. This is the default value.
1257 # - "transparent" - The event does not block time on the calendar.
1258 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1259 }</pre>
1260</div>
1261
1262<div class="method">
1263 <code class="details" id="patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None)</code>
1264 <pre>Updates an event. This method supports patch semantics.
1265
1266Args:
1267 calendarId: string, Calendar identifier. (required)
1268 eventId: string, Event identifier. (required)
1269 body: object, The request body. (required)
1270 The object takes the form of:
1271
1272{
1273 "creator": { # The creator of the event. Read-only.
1274 "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.
1275 "displayName": "A String", # The creator's name, if available.
1276 "email": "A String", # The creator's email address, if available.
1277 "id": "A String", # The creator's Profile ID, if available.
1278 },
1279 "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.
1280 "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.
1281 "displayName": "A String", # The organizer's name, if available.
1282 "email": "A String", # The organizer's email address, if available.
1283 "id": "A String", # The organizer's Profile ID, if available.
1284 },
1285 "summary": "A String", # Title of the event.
1286 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -04001287 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -04001288 "attendees": [ # The attendees of the event.
1289 {
1290 "comment": "A String", # The attendee's response comment. Optional.
1291 "displayName": "A String", # The attendee's name, if available. Optional.
1292 "responseStatus": "A String", # The attendee's response status. Possible values are:
1293 # - "needsAction" - The attendee has not responded to the invitation.
1294 # - "declined" - The attendee has declined the invitation.
1295 # - "tentative" - The attendee has tentatively accepted the invitation.
1296 # - "accepted" - The attendee has accepted the invitation.
1297 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1298 "id": "A String", # The attendee's Profile ID, if available.
1299 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1300 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1301 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1302 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1303 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1304 },
1305 ],
1306 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1307 "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.
1308 "A String",
1309 ],
1310 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1311 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1312 "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.
1313 "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'.
1314 },
1315 "etag": "A String", # ETag of the resource.
1316 "location": "A String", # Geographic location of the event as free-form text. Optional.
1317 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1318 "gadget": { # A gadget that extends this event.
1319 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001320 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001321 },
1322 "title": "A String", # The gadget's title.
1323 "height": 42, # The gadget's height in pixels. Optional.
1324 "width": 42, # The gadget's width in pixels. Optional.
1325 "link": "A String", # The gadget's URL.
1326 "type": "A String", # The gadget's type.
1327 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1328 # - "icon" - The gadget displays next to the event's title in the calendar view.
1329 # - "chip" - The gadget displays when the event is clicked.
1330 "iconLink": "A String", # The gadget's icon URL.
1331 },
1332 "status": "A String", # Status of the event. Optional. Possible values are:
1333 # - "confirmed" - The event is confirmed. This is the default status.
1334 # - "tentative" - The event is tentatively confirmed.
1335 # - "cancelled" - The event is cancelled.
1336 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1337 "description": "A String", # Description of the event. Optional.
1338 "iCalUID": "A String", # Event ID in the iCalendar format.
1339 "extendedProperties": { # Extended properties of the event.
1340 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001341 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001342 },
1343 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001344 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001345 },
1346 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001347 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001348 "sequence": 42, # Sequence number as per iCalendar.
1349 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1350 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1351 # - "public" - The event is public and event details are visible to all readers of the calendar.
1352 # - "private" - The event is private and only event attendees may view event details.
1353 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1354 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1355 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1356 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1357 "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.
1358 "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'.
1359 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001360 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001361 "kind": "calendar#event", # Type of the resource ("calendar#event").
1362 "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.
1363 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1364 "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.
1365 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1366 "reminders": { # Information about the event's reminders for the authenticated user.
1367 "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.
1368 {
1369 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1370 "method": "A String", # The method used by this reminder. Possible values are:
1371 # - "email" - Reminders are sent via email.
1372 # - "sms" - Reminders are sent via SMS.
1373 # - "popup" - Reminders are sent via a UI popup.
1374 },
1375 ],
1376 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1377 },
1378 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1379 "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.
1380 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1381 "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.
1382 "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'.
1383 },
1384 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1385 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1386 # - "opaque" - The event blocks time on the calendar. This is the default value.
1387 # - "transparent" - The event does not block time on the calendar.
1388 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1389 }
1390
1391 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
1392 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.
1393
1394Returns:
1395 An object of the form:
1396
1397 {
1398 "creator": { # The creator of the event. Read-only.
1399 "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.
1400 "displayName": "A String", # The creator's name, if available.
1401 "email": "A String", # The creator's email address, if available.
1402 "id": "A String", # The creator's Profile ID, if available.
1403 },
1404 "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.
1405 "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.
1406 "displayName": "A String", # The organizer's name, if available.
1407 "email": "A String", # The organizer's email address, if available.
1408 "id": "A String", # The organizer's Profile ID, if available.
1409 },
1410 "summary": "A String", # Title of the event.
1411 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -04001412 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -04001413 "attendees": [ # The attendees of the event.
1414 {
1415 "comment": "A String", # The attendee's response comment. Optional.
1416 "displayName": "A String", # The attendee's name, if available. Optional.
1417 "responseStatus": "A String", # The attendee's response status. Possible values are:
1418 # - "needsAction" - The attendee has not responded to the invitation.
1419 # - "declined" - The attendee has declined the invitation.
1420 # - "tentative" - The attendee has tentatively accepted the invitation.
1421 # - "accepted" - The attendee has accepted the invitation.
1422 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1423 "id": "A String", # The attendee's Profile ID, if available.
1424 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1425 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1426 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1427 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1428 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1429 },
1430 ],
1431 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1432 "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.
1433 "A String",
1434 ],
1435 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1436 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1437 "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.
1438 "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'.
1439 },
1440 "etag": "A String", # ETag of the resource.
1441 "location": "A String", # Geographic location of the event as free-form text. Optional.
1442 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1443 "gadget": { # A gadget that extends this event.
1444 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001445 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001446 },
1447 "title": "A String", # The gadget's title.
1448 "height": 42, # The gadget's height in pixels. Optional.
1449 "width": 42, # The gadget's width in pixels. Optional.
1450 "link": "A String", # The gadget's URL.
1451 "type": "A String", # The gadget's type.
1452 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1453 # - "icon" - The gadget displays next to the event's title in the calendar view.
1454 # - "chip" - The gadget displays when the event is clicked.
1455 "iconLink": "A String", # The gadget's icon URL.
1456 },
1457 "status": "A String", # Status of the event. Optional. Possible values are:
1458 # - "confirmed" - The event is confirmed. This is the default status.
1459 # - "tentative" - The event is tentatively confirmed.
1460 # - "cancelled" - The event is cancelled.
1461 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1462 "description": "A String", # Description of the event. Optional.
1463 "iCalUID": "A String", # Event ID in the iCalendar format.
1464 "extendedProperties": { # Extended properties of the event.
1465 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001466 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001467 },
1468 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001469 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001470 },
1471 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001472 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001473 "sequence": 42, # Sequence number as per iCalendar.
1474 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1475 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1476 # - "public" - The event is public and event details are visible to all readers of the calendar.
1477 # - "private" - The event is private and only event attendees may view event details.
1478 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1479 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1480 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1481 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1482 "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.
1483 "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'.
1484 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001485 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001486 "kind": "calendar#event", # Type of the resource ("calendar#event").
1487 "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.
1488 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1489 "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.
1490 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1491 "reminders": { # Information about the event's reminders for the authenticated user.
1492 "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.
1493 {
1494 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1495 "method": "A String", # The method used by this reminder. Possible values are:
1496 # - "email" - Reminders are sent via email.
1497 # - "sms" - Reminders are sent via SMS.
1498 # - "popup" - Reminders are sent via a UI popup.
1499 },
1500 ],
1501 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1502 },
1503 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1504 "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.
1505 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1506 "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.
1507 "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'.
1508 },
1509 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1510 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1511 # - "opaque" - The event blocks time on the calendar. This is the default value.
1512 # - "transparent" - The event does not block time on the calendar.
1513 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1514 }</pre>
1515</div>
1516
1517<div class="method">
1518 <code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None)</code>
1519 <pre>Creates an event based on a simple text string.
1520
1521Args:
1522 calendarId: string, Calendar identifier. (required)
1523 text: string, The text describing the event to be created. (required)
1524 sendNotifications: boolean, Whether to send notifications about the creation of the event. Optional. The default is False.
1525
1526Returns:
1527 An object of the form:
1528
1529 {
1530 "creator": { # The creator of the event. Read-only.
1531 "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.
1532 "displayName": "A String", # The creator's name, if available.
1533 "email": "A String", # The creator's email address, if available.
1534 "id": "A String", # The creator's Profile ID, if available.
1535 },
1536 "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.
1537 "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.
1538 "displayName": "A String", # The organizer's name, if available.
1539 "email": "A String", # The organizer's email address, if available.
1540 "id": "A String", # The organizer's Profile ID, if available.
1541 },
1542 "summary": "A String", # Title of the event.
1543 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -04001544 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -04001545 "attendees": [ # The attendees of the event.
1546 {
1547 "comment": "A String", # The attendee's response comment. Optional.
1548 "displayName": "A String", # The attendee's name, if available. Optional.
1549 "responseStatus": "A String", # The attendee's response status. Possible values are:
1550 # - "needsAction" - The attendee has not responded to the invitation.
1551 # - "declined" - The attendee has declined the invitation.
1552 # - "tentative" - The attendee has tentatively accepted the invitation.
1553 # - "accepted" - The attendee has accepted the invitation.
1554 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1555 "id": "A String", # The attendee's Profile ID, if available.
1556 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1557 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1558 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1559 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1560 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1561 },
1562 ],
1563 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1564 "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.
1565 "A String",
1566 ],
1567 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1568 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1569 "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.
1570 "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'.
1571 },
1572 "etag": "A String", # ETag of the resource.
1573 "location": "A String", # Geographic location of the event as free-form text. Optional.
1574 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1575 "gadget": { # A gadget that extends this event.
1576 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001577 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001578 },
1579 "title": "A String", # The gadget's title.
1580 "height": 42, # The gadget's height in pixels. Optional.
1581 "width": 42, # The gadget's width in pixels. Optional.
1582 "link": "A String", # The gadget's URL.
1583 "type": "A String", # The gadget's type.
1584 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1585 # - "icon" - The gadget displays next to the event's title in the calendar view.
1586 # - "chip" - The gadget displays when the event is clicked.
1587 "iconLink": "A String", # The gadget's icon URL.
1588 },
1589 "status": "A String", # Status of the event. Optional. Possible values are:
1590 # - "confirmed" - The event is confirmed. This is the default status.
1591 # - "tentative" - The event is tentatively confirmed.
1592 # - "cancelled" - The event is cancelled.
1593 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1594 "description": "A String", # Description of the event. Optional.
1595 "iCalUID": "A String", # Event ID in the iCalendar format.
1596 "extendedProperties": { # Extended properties of the event.
1597 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001598 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001599 },
1600 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001601 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001602 },
1603 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001604 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001605 "sequence": 42, # Sequence number as per iCalendar.
1606 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1607 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1608 # - "public" - The event is public and event details are visible to all readers of the calendar.
1609 # - "private" - The event is private and only event attendees may view event details.
1610 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1611 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1612 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1613 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1614 "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.
1615 "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'.
1616 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001617 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001618 "kind": "calendar#event", # Type of the resource ("calendar#event").
1619 "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.
1620 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1621 "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.
1622 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1623 "reminders": { # Information about the event's reminders for the authenticated user.
1624 "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.
1625 {
1626 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1627 "method": "A String", # The method used by this reminder. Possible values are:
1628 # - "email" - Reminders are sent via email.
1629 # - "sms" - Reminders are sent via SMS.
1630 # - "popup" - Reminders are sent via a UI popup.
1631 },
1632 ],
1633 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1634 },
1635 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1636 "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.
1637 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1638 "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.
1639 "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'.
1640 },
1641 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1642 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1643 # - "opaque" - The event blocks time on the calendar. This is the default value.
1644 # - "transparent" - The event does not block time on the calendar.
1645 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1646 }</pre>
1647</div>
1648
1649<div class="method">
1650 <code class="details" id="update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None)</code>
1651 <pre>Updates an event.
1652
1653Args:
1654 calendarId: string, Calendar identifier. (required)
1655 eventId: string, Event identifier. (required)
1656 body: object, The request body. (required)
1657 The object takes the form of:
1658
1659{
1660 "creator": { # The creator of the event. Read-only.
1661 "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.
1662 "displayName": "A String", # The creator's name, if available.
1663 "email": "A String", # The creator's email address, if available.
1664 "id": "A String", # The creator's Profile ID, if available.
1665 },
1666 "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.
1667 "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.
1668 "displayName": "A String", # The organizer's name, if available.
1669 "email": "A String", # The organizer's email address, if available.
1670 "id": "A String", # The organizer's Profile ID, if available.
1671 },
1672 "summary": "A String", # Title of the event.
1673 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -04001674 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -04001675 "attendees": [ # The attendees of the event.
1676 {
1677 "comment": "A String", # The attendee's response comment. Optional.
1678 "displayName": "A String", # The attendee's name, if available. Optional.
1679 "responseStatus": "A String", # The attendee's response status. Possible values are:
1680 # - "needsAction" - The attendee has not responded to the invitation.
1681 # - "declined" - The attendee has declined the invitation.
1682 # - "tentative" - The attendee has tentatively accepted the invitation.
1683 # - "accepted" - The attendee has accepted the invitation.
1684 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1685 "id": "A String", # The attendee's Profile ID, if available.
1686 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1687 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1688 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1689 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1690 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1691 },
1692 ],
1693 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1694 "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.
1695 "A String",
1696 ],
1697 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1698 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1699 "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.
1700 "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'.
1701 },
1702 "etag": "A String", # ETag of the resource.
1703 "location": "A String", # Geographic location of the event as free-form text. Optional.
1704 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1705 "gadget": { # A gadget that extends this event.
1706 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001707 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001708 },
1709 "title": "A String", # The gadget's title.
1710 "height": 42, # The gadget's height in pixels. Optional.
1711 "width": 42, # The gadget's width in pixels. Optional.
1712 "link": "A String", # The gadget's URL.
1713 "type": "A String", # The gadget's type.
1714 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1715 # - "icon" - The gadget displays next to the event's title in the calendar view.
1716 # - "chip" - The gadget displays when the event is clicked.
1717 "iconLink": "A String", # The gadget's icon URL.
1718 },
1719 "status": "A String", # Status of the event. Optional. Possible values are:
1720 # - "confirmed" - The event is confirmed. This is the default status.
1721 # - "tentative" - The event is tentatively confirmed.
1722 # - "cancelled" - The event is cancelled.
1723 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1724 "description": "A String", # Description of the event. Optional.
1725 "iCalUID": "A String", # Event ID in the iCalendar format.
1726 "extendedProperties": { # Extended properties of the event.
1727 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001728 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001729 },
1730 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001731 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001732 },
1733 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001734 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001735 "sequence": 42, # Sequence number as per iCalendar.
1736 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1737 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1738 # - "public" - The event is public and event details are visible to all readers of the calendar.
1739 # - "private" - The event is private and only event attendees may view event details.
1740 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1741 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1742 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1743 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1744 "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.
1745 "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'.
1746 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001747 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001748 "kind": "calendar#event", # Type of the resource ("calendar#event").
1749 "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.
1750 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1751 "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.
1752 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1753 "reminders": { # Information about the event's reminders for the authenticated user.
1754 "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.
1755 {
1756 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1757 "method": "A String", # The method used by this reminder. Possible values are:
1758 # - "email" - Reminders are sent via email.
1759 # - "sms" - Reminders are sent via SMS.
1760 # - "popup" - Reminders are sent via a UI popup.
1761 },
1762 ],
1763 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1764 },
1765 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1766 "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.
1767 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1768 "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.
1769 "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'.
1770 },
1771 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1772 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1773 # - "opaque" - The event blocks time on the calendar. This is the default value.
1774 # - "transparent" - The event does not block time on the calendar.
1775 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1776 }
1777
1778 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
1779 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.
1780
1781Returns:
1782 An object of the form:
1783
1784 {
1785 "creator": { # The creator of the event. Read-only.
1786 "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.
1787 "displayName": "A String", # The creator's name, if available.
1788 "email": "A String", # The creator's email address, if available.
1789 "id": "A String", # The creator's Profile ID, if available.
1790 },
1791 "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.
1792 "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.
1793 "displayName": "A String", # The organizer's name, if available.
1794 "email": "A String", # The organizer's email address, if available.
1795 "id": "A String", # The organizer's Profile ID, if available.
1796 },
1797 "summary": "A String", # Title of the event.
1798 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -04001799 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -04001800 "attendees": [ # The attendees of the event.
1801 {
1802 "comment": "A String", # The attendee's response comment. Optional.
1803 "displayName": "A String", # The attendee's name, if available. Optional.
1804 "responseStatus": "A String", # The attendee's response status. Possible values are:
1805 # - "needsAction" - The attendee has not responded to the invitation.
1806 # - "declined" - The attendee has declined the invitation.
1807 # - "tentative" - The attendee has tentatively accepted the invitation.
1808 # - "accepted" - The attendee has accepted the invitation.
1809 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1810 "id": "A String", # The attendee's Profile ID, if available.
1811 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1812 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1813 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1814 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1815 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1816 },
1817 ],
1818 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1819 "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.
1820 "A String",
1821 ],
1822 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1823 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1824 "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.
1825 "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'.
1826 },
1827 "etag": "A String", # ETag of the resource.
1828 "location": "A String", # Geographic location of the event as free-form text. Optional.
1829 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1830 "gadget": { # A gadget that extends this event.
1831 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001832 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001833 },
1834 "title": "A String", # The gadget's title.
1835 "height": 42, # The gadget's height in pixels. Optional.
1836 "width": 42, # The gadget's width in pixels. Optional.
1837 "link": "A String", # The gadget's URL.
1838 "type": "A String", # The gadget's type.
1839 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1840 # - "icon" - The gadget displays next to the event's title in the calendar view.
1841 # - "chip" - The gadget displays when the event is clicked.
1842 "iconLink": "A String", # The gadget's icon URL.
1843 },
1844 "status": "A String", # Status of the event. Optional. Possible values are:
1845 # - "confirmed" - The event is confirmed. This is the default status.
1846 # - "tentative" - The event is tentatively confirmed.
1847 # - "cancelled" - The event is cancelled.
1848 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1849 "description": "A String", # Description of the event. Optional.
1850 "iCalUID": "A String", # Event ID in the iCalendar format.
1851 "extendedProperties": { # Extended properties of the event.
1852 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001853 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001854 },
1855 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -04001856 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -04001857 },
1858 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001859 "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001860 "sequence": 42, # Sequence number as per iCalendar.
1861 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1862 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1863 # - "public" - The event is public and event details are visible to all readers of the calendar.
1864 # - "private" - The event is private and only event attendees may view event details.
1865 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1866 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1867 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1868 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1869 "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.
1870 "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'.
1871 },
Joe Gregorioad8013f2012-08-03 08:44:02 -04001872 "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -04001873 "kind": "calendar#event", # Type of the resource ("calendar#event").
1874 "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.
1875 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1876 "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.
1877 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1878 "reminders": { # Information about the event's reminders for the authenticated user.
1879 "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.
1880 {
1881 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1882 "method": "A String", # The method used by this reminder. Possible values are:
1883 # - "email" - Reminders are sent via email.
1884 # - "sms" - Reminders are sent via SMS.
1885 # - "popup" - Reminders are sent via a UI popup.
1886 },
1887 ],
1888 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1889 },
1890 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is False.
1891 "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.
1892 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1893 "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.
1894 "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'.
1895 },
1896 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is False.
1897 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1898 # - "opaque" - The event blocks time on the calendar. This is the default value.
1899 # - "transparent" - The event does not block time on the calendar.
1900 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1901 }</pre>
1902</div>
1903
1904</body></html>