Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 41be8e897ece164d89f457c7ebbbafefd4cc357e / . / docs / dyn / calendar_v3.events.html
blob: 14939a3fef2fcb32966e8caf5ffb08576ed85fc2 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.events.html">events</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(calendarId, eventId, sendNotifications=None)</a></code></p>
79<p class="firstline">Deletes an event.</p>
80<p class="toc_element">
81 <code><a href="#get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</a></code></p>
82<p class="firstline">Returns an event.</p>
83<p class="toc_element">
84 <code><a href="#import_">import_(calendarId, body)</a></code></p>
85<p class="firstline">Imports an event.</p>
86<p class="toc_element">
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]87 <code><a href="#insert">insert(calendarId, body, sendNotifications=None, maxAttendees=None)</a></code></p>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]88<p class="firstline">Creates an event.</p>
89<p class="toc_element">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]90 <code><a href="#instances">instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</a></code></p>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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">
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]105 <code><a href="#patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</a></code></p>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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">
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]111 <code><a href="#update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</a></code></p>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 -0400[diff] [blame]154 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]155 "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 -0400[diff] [blame]187 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]188 },
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 -0400[diff] [blame]208 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]209 },
210 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]211 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]212 },
213 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]214 "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 -0400[diff] [blame]215 "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 -0400[diff] [blame]227 "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 -0400[diff] [blame]228 "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 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]245 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]251 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 -0400[diff] [blame]283 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]284 "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 -0400[diff] [blame]316 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]317 },
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 -0400[diff] [blame]337 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]338 },
339 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]340 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]341 },
342 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]343 "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 -0400[diff] [blame]344 "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 -0400[diff] [blame]356 "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 -0400[diff] [blame]357 "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 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]374 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]380 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 -0400[diff] [blame]406 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]407 "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 -0400[diff] [blame]439 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]440 },
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 -0400[diff] [blame]460 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]461 },
462 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]463 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]464 },
465 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]466 "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 -0400[diff] [blame]467 "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 -0400[diff] [blame]479 "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 -0400[diff] [blame]480 "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 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]497 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]503 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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">
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]512 <code class="details" id="insert">insert(calendarId, body, sendNotifications=None, maxAttendees=None)</code>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 -0400[diff] [blame]535 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]536 "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 -0400[diff] [blame]568 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]569 },
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 -0400[diff] [blame]589 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]590 },
591 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]592 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]593 },
594 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]595 "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 -0400[diff] [blame]596 "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 -0400[diff] [blame]608 "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 -0400[diff] [blame]609 "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 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]626 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]632 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]640 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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]641
642Returns:
643 An object of the form:
644
645 {
646 "creator": { # The creator of the event. Read-only.
647 "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.
648 "displayName": "A String", # The creator's name, if available.
649 "email": "A String", # The creator's email address, if available.
650 "id": "A String", # The creator's Profile ID, if available.
651 },
652 "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.
653 "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.
654 "displayName": "A String", # The organizer's name, if available.
655 "email": "A String", # The organizer's email address, if available.
656 "id": "A String", # The organizer's Profile ID, if available.
657 },
658 "summary": "A String", # Title of the event.
659 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]660 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]661 "attendees": [ # The attendees of the event.
662 {
663 "comment": "A String", # The attendee's response comment. Optional.
664 "displayName": "A String", # The attendee's name, if available. Optional.
665 "responseStatus": "A String", # The attendee's response status. Possible values are:
666 # - "needsAction" - The attendee has not responded to the invitation.
667 # - "declined" - The attendee has declined the invitation.
668 # - "tentative" - The attendee has tentatively accepted the invitation.
669 # - "accepted" - The attendee has accepted the invitation.
670 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
671 "id": "A String", # The attendee's Profile ID, if available.
672 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
673 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
674 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
675 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
676 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
677 },
678 ],
679 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
680 "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.
681 "A String",
682 ],
683 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
684 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
685 "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.
686 "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'.
687 },
688 "etag": "A String", # ETag of the resource.
689 "location": "A String", # Geographic location of the event as free-form text. Optional.
690 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
691 "gadget": { # A gadget that extends this event.
692 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]693 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]694 },
695 "title": "A String", # The gadget's title.
696 "height": 42, # The gadget's height in pixels. Optional.
697 "width": 42, # The gadget's width in pixels. Optional.
698 "link": "A String", # The gadget's URL.
699 "type": "A String", # The gadget's type.
700 "display": "A String", # The gadget's display mode. Optional. Possible values are:
701 # - "icon" - The gadget displays next to the event's title in the calendar view.
702 # - "chip" - The gadget displays when the event is clicked.
703 "iconLink": "A String", # The gadget's icon URL.
704 },
705 "status": "A String", # Status of the event. Optional. Possible values are:
706 # - "confirmed" - The event is confirmed. This is the default status.
707 # - "tentative" - The event is tentatively confirmed.
708 # - "cancelled" - The event is cancelled.
709 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
710 "description": "A String", # Description of the event. Optional.
711 "iCalUID": "A String", # Event ID in the iCalendar format.
712 "extendedProperties": { # Extended properties of the event.
713 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]714 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]715 },
716 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]717 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]718 },
719 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]720 "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 -0400[diff] [blame]721 "sequence": 42, # Sequence number as per iCalendar.
722 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
723 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
724 # - "public" - The event is public and event details are visible to all readers of the calendar.
725 # - "private" - The event is private and only event attendees may view event details.
726 # - "confidential" - The event is private. This value is provided for compatibility reasons.
727 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
728 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
729 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
730 "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.
731 "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'.
732 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]733 "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 -0400[diff] [blame]734 "kind": "calendar#event", # Type of the resource ("calendar#event").
735 "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.
736 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
737 "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.
738 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
739 "reminders": { # Information about the event's reminders for the authenticated user.
740 "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.
741 {
742 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
743 "method": "A String", # The method used by this reminder. Possible values are:
744 # - "email" - Reminders are sent via email.
745 # - "sms" - Reminders are sent via SMS.
746 # - "popup" - Reminders are sent via a UI popup.
747 },
748 ],
749 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
750 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]751 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]752 "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.
753 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
754 "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.
755 "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'.
756 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]757 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]758 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
759 # - "opaque" - The event blocks time on the calendar. This is the default value.
760 # - "transparent" - The event does not block time on the calendar.
761 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
762 }</pre>
763</div>
764
765<div class="method">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]766 <code class="details" id="instances">instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</code>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]767 <pre>Returns instances of the specified recurring event.
768
769Args:
770 calendarId: string, Calendar identifier. (required)
771 eventId: string, Recurring event identifier. (required)
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]772 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]773 showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events will still be included if 'singleEvents' is False. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]774 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 Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]775 pageToken: string, Token specifying which result page to return. Optional.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]776 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.
777 maxResults: integer, Maximum number of events returned on one result page. Optional.
778 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]779 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
780 originalStart: string, The original start time of the instance in the result. Optional.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]781
782Returns:
783 An object of the form:
784
785 {
786 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
787 "kind": "calendar#events", # Type of the collection ("calendar#events").
788 "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').
789 {
790 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
791 "method": "A String", # The method used by this reminder. Possible values are:
792 # - "email" - Reminders are sent via email.
793 # - "sms" - Reminders are sent via SMS.
794 # - "popup" - Reminders are sent via a UI popup.
795 },
796 ],
797 "description": "A String", # Description of the calendar. Read-only.
798 "items": [ # List of events on the calendar.
799 {
800 "creator": { # The creator of the event. Read-only.
801 "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.
802 "displayName": "A String", # The creator's name, if available.
803 "email": "A String", # The creator's email address, if available.
804 "id": "A String", # The creator's Profile ID, if available.
805 },
806 "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.
807 "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.
808 "displayName": "A String", # The organizer's name, if available.
809 "email": "A String", # The organizer's email address, if available.
810 "id": "A String", # The organizer's Profile ID, if available.
811 },
812 "summary": "A String", # Title of the event.
813 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]814 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]815 "attendees": [ # The attendees of the event.
816 {
817 "comment": "A String", # The attendee's response comment. Optional.
818 "displayName": "A String", # The attendee's name, if available. Optional.
819 "responseStatus": "A String", # The attendee's response status. Possible values are:
820 # - "needsAction" - The attendee has not responded to the invitation.
821 # - "declined" - The attendee has declined the invitation.
822 # - "tentative" - The attendee has tentatively accepted the invitation.
823 # - "accepted" - The attendee has accepted the invitation.
824 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
825 "id": "A String", # The attendee's Profile ID, if available.
826 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
827 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
828 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
829 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
830 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
831 },
832 ],
833 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
834 "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.
835 "A String",
836 ],
837 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
838 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
839 "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.
840 "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'.
841 },
842 "etag": "A String", # ETag of the resource.
843 "location": "A String", # Geographic location of the event as free-form text. Optional.
844 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
845 "gadget": { # A gadget that extends this event.
846 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]847 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]848 },
849 "title": "A String", # The gadget's title.
850 "height": 42, # The gadget's height in pixels. Optional.
851 "width": 42, # The gadget's width in pixels. Optional.
852 "link": "A String", # The gadget's URL.
853 "type": "A String", # The gadget's type.
854 "display": "A String", # The gadget's display mode. Optional. Possible values are:
855 # - "icon" - The gadget displays next to the event's title in the calendar view.
856 # - "chip" - The gadget displays when the event is clicked.
857 "iconLink": "A String", # The gadget's icon URL.
858 },
859 "status": "A String", # Status of the event. Optional. Possible values are:
860 # - "confirmed" - The event is confirmed. This is the default status.
861 # - "tentative" - The event is tentatively confirmed.
862 # - "cancelled" - The event is cancelled.
863 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
864 "description": "A String", # Description of the event. Optional.
865 "iCalUID": "A String", # Event ID in the iCalendar format.
866 "extendedProperties": { # Extended properties of the event.
867 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]868 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]869 },
870 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]871 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]872 },
873 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]874 "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 -0400[diff] [blame]875 "sequence": 42, # Sequence number as per iCalendar.
876 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
877 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
878 # - "public" - The event is public and event details are visible to all readers of the calendar.
879 # - "private" - The event is private and only event attendees may view event details.
880 # - "confidential" - The event is private. This value is provided for compatibility reasons.
881 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
882 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
883 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
884 "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.
885 "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'.
886 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]887 "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 -0400[diff] [blame]888 "kind": "calendar#event", # Type of the resource ("calendar#event").
889 "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.
890 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
891 "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.
892 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
893 "reminders": { # Information about the event's reminders for the authenticated user.
894 "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.
895 {
896 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
897 "method": "A String", # The method used by this reminder. Possible values are:
898 # - "email" - Reminders are sent via email.
899 # - "sms" - Reminders are sent via SMS.
900 # - "popup" - Reminders are sent via a UI popup.
901 },
902 ],
903 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
904 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]905 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]906 "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.
907 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
908 "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.
909 "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'.
910 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]911 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]912 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
913 # - "opaque" - The event blocks time on the calendar. This is the default value.
914 # - "transparent" - The event does not block time on the calendar.
915 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
916 },
917 ],
918 "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
919 "summary": "A String", # Title of the calendar. Read-only.
920 "etag": "A String", # ETag of the collection.
921 "timeZone": "A String", # The time zone of the calendar. Read-only.
922 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
923 # - "none" - The user has no access.
924 # - "freeBusyReader" - The user has read access to free/busy information.
925 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
926 # - "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.
927 # - "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.
928 }</pre>
929</div>
930
931<div class="method">
932 <code class="details" id="instances_next">instances_next(previous_request, previous_response)</code>
933 <pre>Retrieves the next page of results.
934
935Args:
936 previous_request: The request for the previous page. (required)
937 previous_response: The response from the request for the previous page. (required)
938
939Returns:
940 A request object that you can call 'execute()' on to request the next
941 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]942 </pre>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]943</div>
944
945<div class="method">
946 <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>
947 <pre>Returns events on the specified calendar.
948
949Args:
950 calendarId: string, Calendar identifier. (required)
951 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
952 Allowed values
953 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter "singleEvents" is True)
954 updated - Order by last modification time (ascending).
955 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
956 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
957 pageToken: string, Token specifying which result page to return. Optional.
958 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.
959 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.
960 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 Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]961 showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if 'showDeleted' and 'singleEvents' are both False. If 'showDeleted' and 'singleEvents' are both True only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]962 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.
963 iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.
964 maxResults: integer, Maximum number of events returned on one result page. Optional.
965 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
966 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
967 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
968
969Returns:
970 An object of the form:
971
972 {
973 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
974 "kind": "calendar#events", # Type of the collection ("calendar#events").
975 "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').
976 {
977 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
978 "method": "A String", # The method used by this reminder. Possible values are:
979 # - "email" - Reminders are sent via email.
980 # - "sms" - Reminders are sent via SMS.
981 # - "popup" - Reminders are sent via a UI popup.
982 },
983 ],
984 "description": "A String", # Description of the calendar. Read-only.
985 "items": [ # List of events on the calendar.
986 {
987 "creator": { # The creator of the event. Read-only.
988 "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.
989 "displayName": "A String", # The creator's name, if available.
990 "email": "A String", # The creator's email address, if available.
991 "id": "A String", # The creator's Profile ID, if available.
992 },
993 "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.
994 "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.
995 "displayName": "A String", # The organizer's name, if available.
996 "email": "A String", # The organizer's email address, if available.
997 "id": "A String", # The organizer's Profile ID, if available.
998 },
999 "summary": "A String", # Title of the event.
1000 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]1001 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1002 "attendees": [ # The attendees of the event.
1003 {
1004 "comment": "A String", # The attendee's response comment. Optional.
1005 "displayName": "A String", # The attendee's name, if available. Optional.
1006 "responseStatus": "A String", # The attendee's response status. Possible values are:
1007 # - "needsAction" - The attendee has not responded to the invitation.
1008 # - "declined" - The attendee has declined the invitation.
1009 # - "tentative" - The attendee has tentatively accepted the invitation.
1010 # - "accepted" - The attendee has accepted the invitation.
1011 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1012 "id": "A String", # The attendee's Profile ID, if available.
1013 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1014 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1015 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1016 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1017 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1018 },
1019 ],
1020 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1021 "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.
1022 "A String",
1023 ],
1024 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1025 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1026 "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.
1027 "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'.
1028 },
1029 "etag": "A String", # ETag of the resource.
1030 "location": "A String", # Geographic location of the event as free-form text. Optional.
1031 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1032 "gadget": { # A gadget that extends this event.
1033 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1034 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1035 },
1036 "title": "A String", # The gadget's title.
1037 "height": 42, # The gadget's height in pixels. Optional.
1038 "width": 42, # The gadget's width in pixels. Optional.
1039 "link": "A String", # The gadget's URL.
1040 "type": "A String", # The gadget's type.
1041 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1042 # - "icon" - The gadget displays next to the event's title in the calendar view.
1043 # - "chip" - The gadget displays when the event is clicked.
1044 "iconLink": "A String", # The gadget's icon URL.
1045 },
1046 "status": "A String", # Status of the event. Optional. Possible values are:
1047 # - "confirmed" - The event is confirmed. This is the default status.
1048 # - "tentative" - The event is tentatively confirmed.
1049 # - "cancelled" - The event is cancelled.
1050 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1051 "description": "A String", # Description of the event. Optional.
1052 "iCalUID": "A String", # Event ID in the iCalendar format.
1053 "extendedProperties": { # Extended properties of the event.
1054 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1055 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1056 },
1057 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1058 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1059 },
1060 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1061 "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 -0400[diff] [blame]1062 "sequence": 42, # Sequence number as per iCalendar.
1063 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1064 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1065 # - "public" - The event is public and event details are visible to all readers of the calendar.
1066 # - "private" - The event is private and only event attendees may view event details.
1067 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1068 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1069 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1070 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1071 "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.
1072 "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'.
1073 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1074 "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 -0400[diff] [blame]1075 "kind": "calendar#event", # Type of the resource ("calendar#event").
1076 "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.
1077 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1078 "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.
1079 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1080 "reminders": { # Information about the event's reminders for the authenticated user.
1081 "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.
1082 {
1083 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1084 "method": "A String", # The method used by this reminder. Possible values are:
1085 # - "email" - Reminders are sent via email.
1086 # - "sms" - Reminders are sent via SMS.
1087 # - "popup" - Reminders are sent via a UI popup.
1088 },
1089 ],
1090 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1091 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1092 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1093 "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.
1094 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1095 "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.
1096 "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'.
1097 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1098 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1099 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1100 # - "opaque" - The event blocks time on the calendar. This is the default value.
1101 # - "transparent" - The event does not block time on the calendar.
1102 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1103 },
1104 ],
1105 "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
1106 "summary": "A String", # Title of the calendar. Read-only.
1107 "etag": "A String", # ETag of the collection.
1108 "timeZone": "A String", # The time zone of the calendar. Read-only.
1109 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
1110 # - "none" - The user has no access.
1111 # - "freeBusyReader" - The user has read access to free/busy information.
1112 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
1113 # - "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.
1114 # - "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.
1115 }</pre>
1116</div>
1117
1118<div class="method">
1119 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1120 <pre>Retrieves the next page of results.
1121
1122Args:
1123 previous_request: The request for the previous page. (required)
1124 previous_response: The response from the request for the previous page. (required)
1125
1126Returns:
1127 A request object that you can call 'execute()' on to request the next
1128 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]1129 </pre>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1130</div>
1131
1132<div class="method">
1133 <code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None)</code>
1134 <pre>Moves an event to another calendar, i.e. changes an event's organizer.
1135
1136Args:
1137 calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)
1138 eventId: string, Event identifier. (required)
1139 destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)
1140 sendNotifications: boolean, Whether to send notifications about the change of the event's organizer. Optional. The default is False.
1141
1142Returns:
1143 An object of the form:
1144
1145 {
1146 "creator": { # The creator of the event. Read-only.
1147 "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.
1148 "displayName": "A String", # The creator's name, if available.
1149 "email": "A String", # The creator's email address, if available.
1150 "id": "A String", # The creator's Profile ID, if available.
1151 },
1152 "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.
1153 "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.
1154 "displayName": "A String", # The organizer's name, if available.
1155 "email": "A String", # The organizer's email address, if available.
1156 "id": "A String", # The organizer's Profile ID, if available.
1157 },
1158 "summary": "A String", # Title of the event.
1159 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]1160 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1161 "attendees": [ # The attendees of the event.
1162 {
1163 "comment": "A String", # The attendee's response comment. Optional.
1164 "displayName": "A String", # The attendee's name, if available. Optional.
1165 "responseStatus": "A String", # The attendee's response status. Possible values are:
1166 # - "needsAction" - The attendee has not responded to the invitation.
1167 # - "declined" - The attendee has declined the invitation.
1168 # - "tentative" - The attendee has tentatively accepted the invitation.
1169 # - "accepted" - The attendee has accepted the invitation.
1170 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1171 "id": "A String", # The attendee's Profile ID, if available.
1172 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1173 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1174 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1175 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1176 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1177 },
1178 ],
1179 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1180 "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.
1181 "A String",
1182 ],
1183 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1184 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1185 "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.
1186 "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'.
1187 },
1188 "etag": "A String", # ETag of the resource.
1189 "location": "A String", # Geographic location of the event as free-form text. Optional.
1190 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1191 "gadget": { # A gadget that extends this event.
1192 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1193 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1194 },
1195 "title": "A String", # The gadget's title.
1196 "height": 42, # The gadget's height in pixels. Optional.
1197 "width": 42, # The gadget's width in pixels. Optional.
1198 "link": "A String", # The gadget's URL.
1199 "type": "A String", # The gadget's type.
1200 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1201 # - "icon" - The gadget displays next to the event's title in the calendar view.
1202 # - "chip" - The gadget displays when the event is clicked.
1203 "iconLink": "A String", # The gadget's icon URL.
1204 },
1205 "status": "A String", # Status of the event. Optional. Possible values are:
1206 # - "confirmed" - The event is confirmed. This is the default status.
1207 # - "tentative" - The event is tentatively confirmed.
1208 # - "cancelled" - The event is cancelled.
1209 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1210 "description": "A String", # Description of the event. Optional.
1211 "iCalUID": "A String", # Event ID in the iCalendar format.
1212 "extendedProperties": { # Extended properties of the event.
1213 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1214 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1215 },
1216 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1217 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1218 },
1219 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1220 "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 -0400[diff] [blame]1221 "sequence": 42, # Sequence number as per iCalendar.
1222 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1223 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1224 # - "public" - The event is public and event details are visible to all readers of the calendar.
1225 # - "private" - The event is private and only event attendees may view event details.
1226 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1227 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1228 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1229 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1230 "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.
1231 "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'.
1232 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1233 "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 -0400[diff] [blame]1234 "kind": "calendar#event", # Type of the resource ("calendar#event").
1235 "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.
1236 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1237 "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.
1238 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1239 "reminders": { # Information about the event's reminders for the authenticated user.
1240 "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.
1241 {
1242 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1243 "method": "A String", # The method used by this reminder. Possible values are:
1244 # - "email" - Reminders are sent via email.
1245 # - "sms" - Reminders are sent via SMS.
1246 # - "popup" - Reminders are sent via a UI popup.
1247 },
1248 ],
1249 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1250 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1251 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1252 "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.
1253 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1254 "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.
1255 "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'.
1256 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1257 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1258 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1259 # - "opaque" - The event blocks time on the calendar. This is the default value.
1260 # - "transparent" - The event does not block time on the calendar.
1261 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1262 }</pre>
1263</div>
1264
1265<div class="method">
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1266 <code class="details" id="patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</code>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1267 <pre>Updates an event. This method supports patch semantics.
1268
1269Args:
1270 calendarId: string, Calendar identifier. (required)
1271 eventId: string, Event identifier. (required)
1272 body: object, The request body. (required)
1273 The object takes the form of:
1274
1275{
1276 "creator": { # The creator of the event. Read-only.
1277 "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.
1278 "displayName": "A String", # The creator's name, if available.
1279 "email": "A String", # The creator's email address, if available.
1280 "id": "A String", # The creator's Profile ID, if available.
1281 },
1282 "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.
1283 "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.
1284 "displayName": "A String", # The organizer's name, if available.
1285 "email": "A String", # The organizer's email address, if available.
1286 "id": "A String", # The organizer's Profile ID, if available.
1287 },
1288 "summary": "A String", # Title of the event.
1289 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]1290 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1291 "attendees": [ # The attendees of the event.
1292 {
1293 "comment": "A String", # The attendee's response comment. Optional.
1294 "displayName": "A String", # The attendee's name, if available. Optional.
1295 "responseStatus": "A String", # The attendee's response status. Possible values are:
1296 # - "needsAction" - The attendee has not responded to the invitation.
1297 # - "declined" - The attendee has declined the invitation.
1298 # - "tentative" - The attendee has tentatively accepted the invitation.
1299 # - "accepted" - The attendee has accepted the invitation.
1300 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1301 "id": "A String", # The attendee's Profile ID, if available.
1302 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1303 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1304 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1305 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1306 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1307 },
1308 ],
1309 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1310 "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.
1311 "A String",
1312 ],
1313 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1314 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1315 "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.
1316 "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'.
1317 },
1318 "etag": "A String", # ETag of the resource.
1319 "location": "A String", # Geographic location of the event as free-form text. Optional.
1320 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1321 "gadget": { # A gadget that extends this event.
1322 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1323 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1324 },
1325 "title": "A String", # The gadget's title.
1326 "height": 42, # The gadget's height in pixels. Optional.
1327 "width": 42, # The gadget's width in pixels. Optional.
1328 "link": "A String", # The gadget's URL.
1329 "type": "A String", # The gadget's type.
1330 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1331 # - "icon" - The gadget displays next to the event's title in the calendar view.
1332 # - "chip" - The gadget displays when the event is clicked.
1333 "iconLink": "A String", # The gadget's icon URL.
1334 },
1335 "status": "A String", # Status of the event. Optional. Possible values are:
1336 # - "confirmed" - The event is confirmed. This is the default status.
1337 # - "tentative" - The event is tentatively confirmed.
1338 # - "cancelled" - The event is cancelled.
1339 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1340 "description": "A String", # Description of the event. Optional.
1341 "iCalUID": "A String", # Event ID in the iCalendar format.
1342 "extendedProperties": { # Extended properties of the event.
1343 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1344 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1345 },
1346 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1347 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1348 },
1349 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1350 "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 -0400[diff] [blame]1351 "sequence": 42, # Sequence number as per iCalendar.
1352 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1353 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1354 # - "public" - The event is public and event details are visible to all readers of the calendar.
1355 # - "private" - The event is private and only event attendees may view event details.
1356 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1357 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1358 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1359 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1360 "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.
1361 "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'.
1362 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1363 "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 -0400[diff] [blame]1364 "kind": "calendar#event", # Type of the resource ("calendar#event").
1365 "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.
1366 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1367 "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.
1368 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1369 "reminders": { # Information about the event's reminders for the authenticated user.
1370 "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.
1371 {
1372 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1373 "method": "A String", # The method used by this reminder. Possible values are:
1374 # - "email" - Reminders are sent via email.
1375 # - "sms" - Reminders are sent via SMS.
1376 # - "popup" - Reminders are sent via a UI popup.
1377 },
1378 ],
1379 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1380 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1381 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1382 "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.
1383 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1384 "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.
1385 "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'.
1386 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1387 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1388 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1389 # - "opaque" - The event blocks time on the calendar. This is the default value.
1390 # - "transparent" - The event does not block time on the calendar.
1391 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1392 }
1393
1394 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
1395 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 Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1396 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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1397
1398Returns:
1399 An object of the form:
1400
1401 {
1402 "creator": { # The creator of the event. Read-only.
1403 "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.
1404 "displayName": "A String", # The creator's name, if available.
1405 "email": "A String", # The creator's email address, if available.
1406 "id": "A String", # The creator's Profile ID, if available.
1407 },
1408 "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.
1409 "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.
1410 "displayName": "A String", # The organizer's name, if available.
1411 "email": "A String", # The organizer's email address, if available.
1412 "id": "A String", # The organizer's Profile ID, if available.
1413 },
1414 "summary": "A String", # Title of the event.
1415 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]1416 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1417 "attendees": [ # The attendees of the event.
1418 {
1419 "comment": "A String", # The attendee's response comment. Optional.
1420 "displayName": "A String", # The attendee's name, if available. Optional.
1421 "responseStatus": "A String", # The attendee's response status. Possible values are:
1422 # - "needsAction" - The attendee has not responded to the invitation.
1423 # - "declined" - The attendee has declined the invitation.
1424 # - "tentative" - The attendee has tentatively accepted the invitation.
1425 # - "accepted" - The attendee has accepted the invitation.
1426 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1427 "id": "A String", # The attendee's Profile ID, if available.
1428 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1429 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1430 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1431 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1432 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1433 },
1434 ],
1435 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1436 "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.
1437 "A String",
1438 ],
1439 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1440 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1441 "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.
1442 "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'.
1443 },
1444 "etag": "A String", # ETag of the resource.
1445 "location": "A String", # Geographic location of the event as free-form text. Optional.
1446 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1447 "gadget": { # A gadget that extends this event.
1448 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1449 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1450 },
1451 "title": "A String", # The gadget's title.
1452 "height": 42, # The gadget's height in pixels. Optional.
1453 "width": 42, # The gadget's width in pixels. Optional.
1454 "link": "A String", # The gadget's URL.
1455 "type": "A String", # The gadget's type.
1456 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1457 # - "icon" - The gadget displays next to the event's title in the calendar view.
1458 # - "chip" - The gadget displays when the event is clicked.
1459 "iconLink": "A String", # The gadget's icon URL.
1460 },
1461 "status": "A String", # Status of the event. Optional. Possible values are:
1462 # - "confirmed" - The event is confirmed. This is the default status.
1463 # - "tentative" - The event is tentatively confirmed.
1464 # - "cancelled" - The event is cancelled.
1465 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1466 "description": "A String", # Description of the event. Optional.
1467 "iCalUID": "A String", # Event ID in the iCalendar format.
1468 "extendedProperties": { # Extended properties of the event.
1469 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1470 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1471 },
1472 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1473 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1474 },
1475 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1476 "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 -0400[diff] [blame]1477 "sequence": 42, # Sequence number as per iCalendar.
1478 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1479 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1480 # - "public" - The event is public and event details are visible to all readers of the calendar.
1481 # - "private" - The event is private and only event attendees may view event details.
1482 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1483 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1484 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1485 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1486 "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.
1487 "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'.
1488 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1489 "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 -0400[diff] [blame]1490 "kind": "calendar#event", # Type of the resource ("calendar#event").
1491 "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.
1492 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1493 "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.
1494 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1495 "reminders": { # Information about the event's reminders for the authenticated user.
1496 "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.
1497 {
1498 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1499 "method": "A String", # The method used by this reminder. Possible values are:
1500 # - "email" - Reminders are sent via email.
1501 # - "sms" - Reminders are sent via SMS.
1502 # - "popup" - Reminders are sent via a UI popup.
1503 },
1504 ],
1505 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1506 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1507 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1508 "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.
1509 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1510 "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.
1511 "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'.
1512 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1513 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1514 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1515 # - "opaque" - The event blocks time on the calendar. This is the default value.
1516 # - "transparent" - The event does not block time on the calendar.
1517 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1518 }</pre>
1519</div>
1520
1521<div class="method">
1522 <code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None)</code>
1523 <pre>Creates an event based on a simple text string.
1524
1525Args:
1526 calendarId: string, Calendar identifier. (required)
1527 text: string, The text describing the event to be created. (required)
1528 sendNotifications: boolean, Whether to send notifications about the creation of the event. Optional. The default is False.
1529
1530Returns:
1531 An object of the form:
1532
1533 {
1534 "creator": { # The creator of the event. Read-only.
1535 "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.
1536 "displayName": "A String", # The creator's name, if available.
1537 "email": "A String", # The creator's email address, if available.
1538 "id": "A String", # The creator's Profile ID, if available.
1539 },
1540 "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.
1541 "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.
1542 "displayName": "A String", # The organizer's name, if available.
1543 "email": "A String", # The organizer's email address, if available.
1544 "id": "A String", # The organizer's Profile ID, if available.
1545 },
1546 "summary": "A String", # Title of the event.
1547 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]1548 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1549 "attendees": [ # The attendees of the event.
1550 {
1551 "comment": "A String", # The attendee's response comment. Optional.
1552 "displayName": "A String", # The attendee's name, if available. Optional.
1553 "responseStatus": "A String", # The attendee's response status. Possible values are:
1554 # - "needsAction" - The attendee has not responded to the invitation.
1555 # - "declined" - The attendee has declined the invitation.
1556 # - "tentative" - The attendee has tentatively accepted the invitation.
1557 # - "accepted" - The attendee has accepted the invitation.
1558 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1559 "id": "A String", # The attendee's Profile ID, if available.
1560 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1561 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1562 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1563 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1564 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1565 },
1566 ],
1567 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1568 "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.
1569 "A String",
1570 ],
1571 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1572 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1573 "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.
1574 "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'.
1575 },
1576 "etag": "A String", # ETag of the resource.
1577 "location": "A String", # Geographic location of the event as free-form text. Optional.
1578 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1579 "gadget": { # A gadget that extends this event.
1580 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1581 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1582 },
1583 "title": "A String", # The gadget's title.
1584 "height": 42, # The gadget's height in pixels. Optional.
1585 "width": 42, # The gadget's width in pixels. Optional.
1586 "link": "A String", # The gadget's URL.
1587 "type": "A String", # The gadget's type.
1588 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1589 # - "icon" - The gadget displays next to the event's title in the calendar view.
1590 # - "chip" - The gadget displays when the event is clicked.
1591 "iconLink": "A String", # The gadget's icon URL.
1592 },
1593 "status": "A String", # Status of the event. Optional. Possible values are:
1594 # - "confirmed" - The event is confirmed. This is the default status.
1595 # - "tentative" - The event is tentatively confirmed.
1596 # - "cancelled" - The event is cancelled.
1597 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1598 "description": "A String", # Description of the event. Optional.
1599 "iCalUID": "A String", # Event ID in the iCalendar format.
1600 "extendedProperties": { # Extended properties of the event.
1601 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1602 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1603 },
1604 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1605 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1606 },
1607 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1608 "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 -0400[diff] [blame]1609 "sequence": 42, # Sequence number as per iCalendar.
1610 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1611 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1612 # - "public" - The event is public and event details are visible to all readers of the calendar.
1613 # - "private" - The event is private and only event attendees may view event details.
1614 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1615 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1616 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1617 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1618 "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.
1619 "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'.
1620 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1621 "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 -0400[diff] [blame]1622 "kind": "calendar#event", # Type of the resource ("calendar#event").
1623 "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.
1624 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1625 "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.
1626 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1627 "reminders": { # Information about the event's reminders for the authenticated user.
1628 "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.
1629 {
1630 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1631 "method": "A String", # The method used by this reminder. Possible values are:
1632 # - "email" - Reminders are sent via email.
1633 # - "sms" - Reminders are sent via SMS.
1634 # - "popup" - Reminders are sent via a UI popup.
1635 },
1636 ],
1637 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1638 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1639 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1640 "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.
1641 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1642 "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.
1643 "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'.
1644 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1645 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1646 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1647 # - "opaque" - The event blocks time on the calendar. This is the default value.
1648 # - "transparent" - The event does not block time on the calendar.
1649 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1650 }</pre>
1651</div>
1652
1653<div class="method">
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1654 <code class="details" id="update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</code>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1655 <pre>Updates an event.
1656
1657Args:
1658 calendarId: string, Calendar identifier. (required)
1659 eventId: string, Event identifier. (required)
1660 body: object, The request body. (required)
1661 The object takes the form of:
1662
1663{
1664 "creator": { # The creator of the event. Read-only.
1665 "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.
1666 "displayName": "A String", # The creator's name, if available.
1667 "email": "A String", # The creator's email address, if available.
1668 "id": "A String", # The creator's Profile ID, if available.
1669 },
1670 "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.
1671 "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.
1672 "displayName": "A String", # The organizer's name, if available.
1673 "email": "A String", # The organizer's email address, if available.
1674 "id": "A String", # The organizer's Profile ID, if available.
1675 },
1676 "summary": "A String", # Title of the event.
1677 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]1678 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1679 "attendees": [ # The attendees of the event.
1680 {
1681 "comment": "A String", # The attendee's response comment. Optional.
1682 "displayName": "A String", # The attendee's name, if available. Optional.
1683 "responseStatus": "A String", # The attendee's response status. Possible values are:
1684 # - "needsAction" - The attendee has not responded to the invitation.
1685 # - "declined" - The attendee has declined the invitation.
1686 # - "tentative" - The attendee has tentatively accepted the invitation.
1687 # - "accepted" - The attendee has accepted the invitation.
1688 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1689 "id": "A String", # The attendee's Profile ID, if available.
1690 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1691 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1692 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1693 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1694 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1695 },
1696 ],
1697 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1698 "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.
1699 "A String",
1700 ],
1701 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1702 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1703 "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
1704 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
1705 },
1706 "etag": "A String", # ETag of the resource.
1707 "location": "A String", # Geographic location of the event as free-form text. Optional.
1708 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1709 "gadget": { # A gadget that extends this event.
1710 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1711 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1712 },
1713 "title": "A String", # The gadget's title.
1714 "height": 42, # The gadget's height in pixels. Optional.
1715 "width": 42, # The gadget's width in pixels. Optional.
1716 "link": "A String", # The gadget's URL.
1717 "type": "A String", # The gadget's type.
1718 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1719 # - "icon" - The gadget displays next to the event's title in the calendar view.
1720 # - "chip" - The gadget displays when the event is clicked.
1721 "iconLink": "A String", # The gadget's icon URL.
1722 },
1723 "status": "A String", # Status of the event. Optional. Possible values are:
1724 # - "confirmed" - The event is confirmed. This is the default status.
1725 # - "tentative" - The event is tentatively confirmed.
1726 # - "cancelled" - The event is cancelled.
1727 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1728 "description": "A String", # Description of the event. Optional.
1729 "iCalUID": "A String", # Event ID in the iCalendar format.
1730 "extendedProperties": { # Extended properties of the event.
1731 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1732 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1733 },
1734 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1735 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1736 },
1737 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1738 "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 -0400[diff] [blame]1739 "sequence": 42, # Sequence number as per iCalendar.
1740 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1741 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1742 # - "public" - The event is public and event details are visible to all readers of the calendar.
1743 # - "private" - The event is private and only event attendees may view event details.
1744 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1745 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1746 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1747 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1748 "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.
1749 "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'.
1750 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1751 "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 -0400[diff] [blame]1752 "kind": "calendar#event", # Type of the resource ("calendar#event").
1753 "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.
1754 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1755 "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.
1756 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1757 "reminders": { # Information about the event's reminders for the authenticated user.
1758 "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.
1759 {
1760 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1761 "method": "A String", # The method used by this reminder. Possible values are:
1762 # - "email" - Reminders are sent via email.
1763 # - "sms" - Reminders are sent via SMS.
1764 # - "popup" - Reminders are sent via a UI popup.
1765 },
1766 ],
1767 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1768 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1769 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1770 "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.
1771 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1772 "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.
1773 "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'.
1774 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1775 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1776 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1777 # - "opaque" - The event blocks time on the calendar. This is the default value.
1778 # - "transparent" - The event does not block time on the calendar.
1779 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1780 }
1781
1782 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
1783 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 Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1784 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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1785
1786Returns:
1787 An object of the form:
1788
1789 {
1790 "creator": { # The creator of the event. Read-only.
1791 "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.
1792 "displayName": "A String", # The creator's name, if available.
1793 "email": "A String", # The creator's email address, if available.
1794 "id": "A String", # The creator's Profile ID, if available.
1795 },
1796 "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.
1797 "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.
1798 "displayName": "A String", # The organizer's name, if available.
1799 "email": "A String", # The organizer's email address, if available.
1800 "id": "A String", # The organizer's Profile ID, if available.
1801 },
1802 "summary": "A String", # Title of the event.
1803 "id": "A String", # Identifier of the event.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]1804 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1805 "attendees": [ # The attendees of the event.
1806 {
1807 "comment": "A String", # The attendee's response comment. Optional.
1808 "displayName": "A String", # The attendee's name, if available. Optional.
1809 "responseStatus": "A String", # The attendee's response status. Possible values are:
1810 # - "needsAction" - The attendee has not responded to the invitation.
1811 # - "declined" - The attendee has declined the invitation.
1812 # - "tentative" - The attendee has tentatively accepted the invitation.
1813 # - "accepted" - The attendee has accepted the invitation.
1814 "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
1815 "id": "A String", # The attendee's Profile ID, if available.
1816 "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
1817 "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
1818 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
1819 "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
1820 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1821 },
1822 ],
1823 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1824 "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.
1825 "A String",
1826 ],
1827 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1828 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1829 "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.
1830 "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'.
1831 },
1832 "etag": "A String", # ETag of the resource.
1833 "location": "A String", # Geographic location of the event as free-form text. Optional.
1834 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1835 "gadget": { # A gadget that extends this event.
1836 "preferences": { # Preferences.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1837 "a_key": "A String", # The preference name and corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1838 },
1839 "title": "A String", # The gadget's title.
1840 "height": 42, # The gadget's height in pixels. Optional.
1841 "width": 42, # The gadget's width in pixels. Optional.
1842 "link": "A String", # The gadget's URL.
1843 "type": "A String", # The gadget's type.
1844 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1845 # - "icon" - The gadget displays next to the event's title in the calendar view.
1846 # - "chip" - The gadget displays when the event is clicked.
1847 "iconLink": "A String", # The gadget's icon URL.
1848 },
1849 "status": "A String", # Status of the event. Optional. Possible values are:
1850 # - "confirmed" - The event is confirmed. This is the default status.
1851 # - "tentative" - The event is tentatively confirmed.
1852 # - "cancelled" - The event is cancelled.
1853 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1854 "description": "A String", # Description of the event. Optional.
1855 "iCalUID": "A String", # Event ID in the iCalendar format.
1856 "extendedProperties": { # Extended properties of the event.
1857 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1858 "a_key": "A String", # The name of the shared property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1859 },
1860 "private": { # Properties that are private to the copy of the event that appears on this calendar.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]1861 "a_key": "A String", # The name of the private property and the corresponding value.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1862 },
1863 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1864 "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 -0400[diff] [blame]1865 "sequence": 42, # Sequence number as per iCalendar.
1866 "visibility": "A String", # Visibility of the event. Optional. Possible values are:
1867 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1868 # - "public" - The event is public and event details are visible to all readers of the calendar.
1869 # - "private" - The event is private and only event attendees may view event details.
1870 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1871 "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1872 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1873 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1874 "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.
1875 "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'.
1876 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]1877 "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 -0400[diff] [blame]1878 "kind": "calendar#event", # Type of the resource ("calendar#event").
1879 "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.
1880 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
1881 "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.
1882 "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
1883 "reminders": { # Information about the event's reminders for the authenticated user.
1884 "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.
1885 {
1886 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1887 "method": "A String", # The method used by this reminder. Possible values are:
1888 # - "email" - Reminders are sent via email.
1889 # - "sms" - Reminders are sent via SMS.
1890 # - "popup" - Reminders are sent via a UI popup.
1891 },
1892 ],
1893 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1894 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1895 "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1896 "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.
1897 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
1898 "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.
1899 "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'.
1900 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]1901 "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1902 "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
1903 # - "opaque" - The event blocks time on the calendar. This is the default value.
1904 # - "transparent" - The event does not block time on the calendar.
1905 "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
1906 }</pre>
1907</div>
1908
1909</body></html>