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