blob: 746c45cb8f9637bfb2cb9a48d682c21d1badf062 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.events.html">events</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(calendarId, eventId, sendNotifications=None)</a></code></p>
79<p class="firstline">Deletes an event.</p>
80<p class="toc_element">
81 <code><a href="#get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</a></code></p>
82<p class="firstline">Returns an event.</p>
83<p class="toc_element">
84 <code><a href="#import_">import_(calendarId, body)</a></code></p>
85<p class="firstline">Imports an event. This operation is used to add a private copy of an existing event to a calendar.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(calendarId, body, sendNotifications=None, maxAttendees=None)</a></code></p>
88<p class="firstline">Creates an event.</p>
89<p class="toc_element">
90 <code><a href="#instances">instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</a></code></p>
91<p class="firstline">Returns instances of the specified recurring event.</p>
92<p class="toc_element">
93 <code><a href="#instances_next">instances_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#list">list(calendarId, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</a></code></p>
97<p class="firstline">Returns events on the specified calendar.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#move">move(calendarId, eventId, destination, sendNotifications=None)</a></code></p>
103<p class="firstline">Moves an event to another calendar, i.e. changes an event's organizer.</p>
104<p class="toc_element">
105 <code><a href="#patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</a></code></p>
106<p class="firstline">Updates an event. This method supports patch semantics.</p>
107<p class="toc_element">
108 <code><a href="#quickAdd">quickAdd(calendarId, text, sendNotifications=None)</a></code></p>
109<p class="firstline">Creates an event based on a simple text string.</p>
110<p class="toc_element">
111 <code><a href="#update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</a></code></p>
112<p class="firstline">Updates an event.</p>
113<p class="toc_element">
114 <code><a href="#watch">watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</a></code></p>
115<p class="firstline">Watch for changes to Events resources.</p>
116<h3>Method Details</h3>
117<div class="method">
118 <code class="details" id="delete">delete(calendarId, eventId, sendNotifications=None)</code>
119 <pre>Deletes an event.
120
121Args:
122 calendarId: string, Calendar identifier. (required)
123 eventId: string, Event identifier. (required)
124 sendNotifications: boolean, Whether to send notifications about the deletion of the event. Optional. The default is False.
125</pre>
126</div>
127
128<div class="method">
129 <code class="details" id="get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</code>
130 <pre>Returns an event.
131
132Args:
133 calendarId: string, Calendar identifier. (required)
134 eventId: string, Event identifier. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700135 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.
John Asmuth614db982014-04-24 15:46:26 -0400136 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
137 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
138
139Returns:
140 An object of the form:
141
142 {
143 "creator": { # The creator of the event. Read-only.
144 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
145 "displayName": "A String", # The creator's name, if available.
146 "email": "A String", # The creator's email address, if available.
147 "id": "A String", # The creator's Profile ID, if available.
148 },
Craig Citro065b5302014-08-14 00:47:23 -0700149 "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.
John Asmuth614db982014-04-24 15:46:26 -0400150 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
151 "displayName": "A String", # The organizer's name, if available.
152 "email": "A String", # The organizer's email address, if available.
153 "id": "A String", # The organizer's Profile ID, if available.
154 },
155 "summary": "A String", # Title of the event.
156 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
157 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
158 # - the length of the ID must be between 5 and 1024 characters
159 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
160 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
161 "attendees": [ # The attendees of the event.
162 {
163 "comment": "A String", # The attendee's response comment. Optional.
164 "displayName": "A String", # The attendee's name, if available. Optional.
165 "responseStatus": "A String", # The attendee's response status. Possible values are:
166 # - "needsAction" - The attendee has not responded to the invitation.
167 # - "declined" - The attendee has declined the invitation.
168 # - "tentative" - The attendee has tentatively accepted the invitation.
169 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700170 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400171 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700172 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
173 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400174 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700175 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400176 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
177 },
178 ],
179 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
180 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800181 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700182 "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.
John Asmuth614db982014-04-24 15:46:26 -0400183 },
184 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
185 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
186 "A String",
187 ],
188 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
189 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
190 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
191 },
192 "etag": "A String", # ETag of the resource.
193 "location": "A String", # Geographic location of the event as free-form text. Optional.
194 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
195 "gadget": { # A gadget that extends this event.
196 "preferences": { # Preferences.
197 "a_key": "A String", # The preference name and corresponding value.
198 },
199 "title": "A String", # The gadget's title.
200 "height": 42, # The gadget's height in pixels. Optional.
201 "width": 42, # The gadget's width in pixels. Optional.
202 "link": "A String", # The gadget's URL.
203 "type": "A String", # The gadget's type.
204 "display": "A String", # The gadget's display mode. Optional. Possible values are:
205 # - "icon" - The gadget displays next to the event's title in the calendar view.
206 # - "chip" - The gadget displays when the event is clicked.
207 "iconLink": "A String", # The gadget's icon URL.
208 },
209 "status": "A String", # Status of the event. Optional. Possible values are:
210 # - "confirmed" - The event is confirmed. This is the default status.
211 # - "tentative" - The event is tentatively confirmed.
212 # - "cancelled" - The event is cancelled.
213 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
214 "description": "A String", # Description of the event. Optional.
215 "iCalUID": "A String", # Event ID in the iCalendar format.
216 "extendedProperties": { # Extended properties of the event.
217 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
218 "a_key": "A String", # The name of the shared property and the corresponding value.
219 },
220 "private": { # Properties that are private to the copy of the event that appears on this calendar.
221 "a_key": "A String", # The name of the private property and the corresponding value.
222 },
223 },
224 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
225 "sequence": 42, # Sequence number as per iCalendar.
226 "visibility": "default", # Visibility of the event. Optional. Possible values are:
227 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
228 # - "public" - The event is public and event details are visible to all readers of the calendar.
229 # - "private" - The event is private and only event attendees may view event details.
230 # - "confidential" - The event is private. This value is provided for compatibility reasons.
231 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
232 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
233 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800234 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700235 "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.
John Asmuth614db982014-04-24 15:46:26 -0400236 },
Craig Citro065b5302014-08-14 00:47:23 -0700237 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400238 "kind": "calendar#event", # Type of the resource ("calendar#event").
239 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
240 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700241 "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.
John Asmuth614db982014-04-24 15:46:26 -0400242 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
243 "reminders": { # Information about the event's reminders for the authenticated user.
244 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
245 {
246 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
247 "method": "A String", # The method used by this reminder. Possible values are:
248 # - "email" - Reminders are sent via email.
249 # - "sms" - Reminders are sent via SMS.
250 # - "popup" - Reminders are sent via a UI popup.
251 },
252 ],
253 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
254 },
255 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
256 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
257 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800258 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700259 "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.
John Asmuth614db982014-04-24 15:46:26 -0400260 },
261 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
262 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
263 # - "opaque" - The event blocks time on the calendar. This is the default value.
264 # - "transparent" - The event does not block time on the calendar.
265 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
266 }</pre>
267</div>
268
269<div class="method">
270 <code class="details" id="import_">import_(calendarId, body)</code>
271 <pre>Imports an event. This operation is used to add a private copy of an existing event to a calendar.
272
273Args:
274 calendarId: string, Calendar identifier. (required)
275 body: object, The request body. (required)
276 The object takes the form of:
277
278{
279 "creator": { # The creator of the event. Read-only.
280 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
281 "displayName": "A String", # The creator's name, if available.
282 "email": "A String", # The creator's email address, if available.
283 "id": "A String", # The creator's Profile ID, if available.
284 },
Craig Citro065b5302014-08-14 00:47:23 -0700285 "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.
John Asmuth614db982014-04-24 15:46:26 -0400286 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
287 "displayName": "A String", # The organizer's name, if available.
288 "email": "A String", # The organizer's email address, if available.
289 "id": "A String", # The organizer's Profile ID, if available.
290 },
291 "summary": "A String", # Title of the event.
292 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
293 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
294 # - the length of the ID must be between 5 and 1024 characters
295 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
296 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
297 "attendees": [ # The attendees of the event.
298 {
299 "comment": "A String", # The attendee's response comment. Optional.
300 "displayName": "A String", # The attendee's name, if available. Optional.
301 "responseStatus": "A String", # The attendee's response status. Possible values are:
302 # - "needsAction" - The attendee has not responded to the invitation.
303 # - "declined" - The attendee has declined the invitation.
304 # - "tentative" - The attendee has tentatively accepted the invitation.
305 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700306 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400307 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700308 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
309 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400310 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700311 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400312 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
313 },
314 ],
315 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
316 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800317 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700318 "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.
John Asmuth614db982014-04-24 15:46:26 -0400319 },
320 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
321 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
322 "A String",
323 ],
324 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
325 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
326 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
327 },
328 "etag": "A String", # ETag of the resource.
329 "location": "A String", # Geographic location of the event as free-form text. Optional.
330 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
331 "gadget": { # A gadget that extends this event.
332 "preferences": { # Preferences.
333 "a_key": "A String", # The preference name and corresponding value.
334 },
335 "title": "A String", # The gadget's title.
336 "height": 42, # The gadget's height in pixels. Optional.
337 "width": 42, # The gadget's width in pixels. Optional.
338 "link": "A String", # The gadget's URL.
339 "type": "A String", # The gadget's type.
340 "display": "A String", # The gadget's display mode. Optional. Possible values are:
341 # - "icon" - The gadget displays next to the event's title in the calendar view.
342 # - "chip" - The gadget displays when the event is clicked.
343 "iconLink": "A String", # The gadget's icon URL.
344 },
345 "status": "A String", # Status of the event. Optional. Possible values are:
346 # - "confirmed" - The event is confirmed. This is the default status.
347 # - "tentative" - The event is tentatively confirmed.
348 # - "cancelled" - The event is cancelled.
349 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
350 "description": "A String", # Description of the event. Optional.
351 "iCalUID": "A String", # Event ID in the iCalendar format.
352 "extendedProperties": { # Extended properties of the event.
353 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
354 "a_key": "A String", # The name of the shared property and the corresponding value.
355 },
356 "private": { # Properties that are private to the copy of the event that appears on this calendar.
357 "a_key": "A String", # The name of the private property and the corresponding value.
358 },
359 },
360 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
361 "sequence": 42, # Sequence number as per iCalendar.
362 "visibility": "default", # Visibility of the event. Optional. Possible values are:
363 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
364 # - "public" - The event is public and event details are visible to all readers of the calendar.
365 # - "private" - The event is private and only event attendees may view event details.
366 # - "confidential" - The event is private. This value is provided for compatibility reasons.
367 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
368 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
369 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800370 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700371 "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.
John Asmuth614db982014-04-24 15:46:26 -0400372 },
Craig Citro065b5302014-08-14 00:47:23 -0700373 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400374 "kind": "calendar#event", # Type of the resource ("calendar#event").
375 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
376 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700377 "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.
John Asmuth614db982014-04-24 15:46:26 -0400378 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
379 "reminders": { # Information about the event's reminders for the authenticated user.
380 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
381 {
382 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
383 "method": "A String", # The method used by this reminder. Possible values are:
384 # - "email" - Reminders are sent via email.
385 # - "sms" - Reminders are sent via SMS.
386 # - "popup" - Reminders are sent via a UI popup.
387 },
388 ],
389 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
390 },
391 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
392 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
393 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800394 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700395 "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.
John Asmuth614db982014-04-24 15:46:26 -0400396 },
397 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
398 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
399 # - "opaque" - The event blocks time on the calendar. This is the default value.
400 # - "transparent" - The event does not block time on the calendar.
401 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
402 }
403
404
405Returns:
406 An object of the form:
407
408 {
409 "creator": { # The creator of the event. Read-only.
410 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
411 "displayName": "A String", # The creator's name, if available.
412 "email": "A String", # The creator's email address, if available.
413 "id": "A String", # The creator's Profile ID, if available.
414 },
Craig Citro065b5302014-08-14 00:47:23 -0700415 "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.
John Asmuth614db982014-04-24 15:46:26 -0400416 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
417 "displayName": "A String", # The organizer's name, if available.
418 "email": "A String", # The organizer's email address, if available.
419 "id": "A String", # The organizer's Profile ID, if available.
420 },
421 "summary": "A String", # Title of the event.
422 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
423 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
424 # - the length of the ID must be between 5 and 1024 characters
425 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
426 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
427 "attendees": [ # The attendees of the event.
428 {
429 "comment": "A String", # The attendee's response comment. Optional.
430 "displayName": "A String", # The attendee's name, if available. Optional.
431 "responseStatus": "A String", # The attendee's response status. Possible values are:
432 # - "needsAction" - The attendee has not responded to the invitation.
433 # - "declined" - The attendee has declined the invitation.
434 # - "tentative" - The attendee has tentatively accepted the invitation.
435 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700436 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400437 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700438 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
439 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400440 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700441 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400442 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
443 },
444 ],
445 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
446 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800447 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700448 "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.
John Asmuth614db982014-04-24 15:46:26 -0400449 },
450 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
451 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
452 "A String",
453 ],
454 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
455 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
456 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
457 },
458 "etag": "A String", # ETag of the resource.
459 "location": "A String", # Geographic location of the event as free-form text. Optional.
460 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
461 "gadget": { # A gadget that extends this event.
462 "preferences": { # Preferences.
463 "a_key": "A String", # The preference name and corresponding value.
464 },
465 "title": "A String", # The gadget's title.
466 "height": 42, # The gadget's height in pixels. Optional.
467 "width": 42, # The gadget's width in pixels. Optional.
468 "link": "A String", # The gadget's URL.
469 "type": "A String", # The gadget's type.
470 "display": "A String", # The gadget's display mode. Optional. Possible values are:
471 # - "icon" - The gadget displays next to the event's title in the calendar view.
472 # - "chip" - The gadget displays when the event is clicked.
473 "iconLink": "A String", # The gadget's icon URL.
474 },
475 "status": "A String", # Status of the event. Optional. Possible values are:
476 # - "confirmed" - The event is confirmed. This is the default status.
477 # - "tentative" - The event is tentatively confirmed.
478 # - "cancelled" - The event is cancelled.
479 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
480 "description": "A String", # Description of the event. Optional.
481 "iCalUID": "A String", # Event ID in the iCalendar format.
482 "extendedProperties": { # Extended properties of the event.
483 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
484 "a_key": "A String", # The name of the shared property and the corresponding value.
485 },
486 "private": { # Properties that are private to the copy of the event that appears on this calendar.
487 "a_key": "A String", # The name of the private property and the corresponding value.
488 },
489 },
490 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
491 "sequence": 42, # Sequence number as per iCalendar.
492 "visibility": "default", # Visibility of the event. Optional. Possible values are:
493 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
494 # - "public" - The event is public and event details are visible to all readers of the calendar.
495 # - "private" - The event is private and only event attendees may view event details.
496 # - "confidential" - The event is private. This value is provided for compatibility reasons.
497 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
498 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
499 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800500 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700501 "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.
John Asmuth614db982014-04-24 15:46:26 -0400502 },
Craig Citro065b5302014-08-14 00:47:23 -0700503 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400504 "kind": "calendar#event", # Type of the resource ("calendar#event").
505 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
506 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700507 "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.
John Asmuth614db982014-04-24 15:46:26 -0400508 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
509 "reminders": { # Information about the event's reminders for the authenticated user.
510 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
511 {
512 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
513 "method": "A String", # The method used by this reminder. Possible values are:
514 # - "email" - Reminders are sent via email.
515 # - "sms" - Reminders are sent via SMS.
516 # - "popup" - Reminders are sent via a UI popup.
517 },
518 ],
519 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
520 },
521 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
522 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
523 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800524 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700525 "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.
John Asmuth614db982014-04-24 15:46:26 -0400526 },
527 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
528 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
529 # - "opaque" - The event blocks time on the calendar. This is the default value.
530 # - "transparent" - The event does not block time on the calendar.
531 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
532 }</pre>
533</div>
534
535<div class="method">
536 <code class="details" id="insert">insert(calendarId, body, sendNotifications=None, maxAttendees=None)</code>
537 <pre>Creates an event.
538
539Args:
540 calendarId: string, Calendar identifier. (required)
541 body: object, The request body. (required)
542 The object takes the form of:
543
544{
545 "creator": { # The creator of the event. Read-only.
546 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
547 "displayName": "A String", # The creator's name, if available.
548 "email": "A String", # The creator's email address, if available.
549 "id": "A String", # The creator's Profile ID, if available.
550 },
Craig Citro065b5302014-08-14 00:47:23 -0700551 "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.
John Asmuth614db982014-04-24 15:46:26 -0400552 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
553 "displayName": "A String", # The organizer's name, if available.
554 "email": "A String", # The organizer's email address, if available.
555 "id": "A String", # The organizer's Profile ID, if available.
556 },
557 "summary": "A String", # Title of the event.
558 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
559 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
560 # - the length of the ID must be between 5 and 1024 characters
561 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
562 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
563 "attendees": [ # The attendees of the event.
564 {
565 "comment": "A String", # The attendee's response comment. Optional.
566 "displayName": "A String", # The attendee's name, if available. Optional.
567 "responseStatus": "A String", # The attendee's response status. Possible values are:
568 # - "needsAction" - The attendee has not responded to the invitation.
569 # - "declined" - The attendee has declined the invitation.
570 # - "tentative" - The attendee has tentatively accepted the invitation.
571 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700572 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400573 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700574 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
575 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400576 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700577 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400578 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
579 },
580 ],
581 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
582 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800583 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700584 "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.
John Asmuth614db982014-04-24 15:46:26 -0400585 },
586 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
587 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
588 "A String",
589 ],
590 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
591 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
592 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
593 },
594 "etag": "A String", # ETag of the resource.
595 "location": "A String", # Geographic location of the event as free-form text. Optional.
596 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
597 "gadget": { # A gadget that extends this event.
598 "preferences": { # Preferences.
599 "a_key": "A String", # The preference name and corresponding value.
600 },
601 "title": "A String", # The gadget's title.
602 "height": 42, # The gadget's height in pixels. Optional.
603 "width": 42, # The gadget's width in pixels. Optional.
604 "link": "A String", # The gadget's URL.
605 "type": "A String", # The gadget's type.
606 "display": "A String", # The gadget's display mode. Optional. Possible values are:
607 # - "icon" - The gadget displays next to the event's title in the calendar view.
608 # - "chip" - The gadget displays when the event is clicked.
609 "iconLink": "A String", # The gadget's icon URL.
610 },
611 "status": "A String", # Status of the event. Optional. Possible values are:
612 # - "confirmed" - The event is confirmed. This is the default status.
613 # - "tentative" - The event is tentatively confirmed.
614 # - "cancelled" - The event is cancelled.
615 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
616 "description": "A String", # Description of the event. Optional.
617 "iCalUID": "A String", # Event ID in the iCalendar format.
618 "extendedProperties": { # Extended properties of the event.
619 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
620 "a_key": "A String", # The name of the shared property and the corresponding value.
621 },
622 "private": { # Properties that are private to the copy of the event that appears on this calendar.
623 "a_key": "A String", # The name of the private property and the corresponding value.
624 },
625 },
626 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
627 "sequence": 42, # Sequence number as per iCalendar.
628 "visibility": "default", # Visibility of the event. Optional. Possible values are:
629 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
630 # - "public" - The event is public and event details are visible to all readers of the calendar.
631 # - "private" - The event is private and only event attendees may view event details.
632 # - "confidential" - The event is private. This value is provided for compatibility reasons.
633 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
634 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
635 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800636 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700637 "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.
John Asmuth614db982014-04-24 15:46:26 -0400638 },
Craig Citro065b5302014-08-14 00:47:23 -0700639 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400640 "kind": "calendar#event", # Type of the resource ("calendar#event").
641 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
642 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700643 "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.
John Asmuth614db982014-04-24 15:46:26 -0400644 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
645 "reminders": { # Information about the event's reminders for the authenticated user.
646 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
647 {
648 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
649 "method": "A String", # The method used by this reminder. Possible values are:
650 # - "email" - Reminders are sent via email.
651 # - "sms" - Reminders are sent via SMS.
652 # - "popup" - Reminders are sent via a UI popup.
653 },
654 ],
655 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
656 },
657 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
658 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
659 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800660 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700661 "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.
John Asmuth614db982014-04-24 15:46:26 -0400662 },
663 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
664 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
665 # - "opaque" - The event blocks time on the calendar. This is the default value.
666 # - "transparent" - The event does not block time on the calendar.
667 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
668 }
669
670 sendNotifications: boolean, Whether to send notifications about the creation of the new event. Optional. The default is False.
671 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
672
673Returns:
674 An object of the form:
675
676 {
677 "creator": { # The creator of the event. Read-only.
678 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
679 "displayName": "A String", # The creator's name, if available.
680 "email": "A String", # The creator's email address, if available.
681 "id": "A String", # The creator's Profile ID, if available.
682 },
Craig Citro065b5302014-08-14 00:47:23 -0700683 "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.
John Asmuth614db982014-04-24 15:46:26 -0400684 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
685 "displayName": "A String", # The organizer's name, if available.
686 "email": "A String", # The organizer's email address, if available.
687 "id": "A String", # The organizer's Profile ID, if available.
688 },
689 "summary": "A String", # Title of the event.
690 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
691 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
692 # - the length of the ID must be between 5 and 1024 characters
693 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
694 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
695 "attendees": [ # The attendees of the event.
696 {
697 "comment": "A String", # The attendee's response comment. Optional.
698 "displayName": "A String", # The attendee's name, if available. Optional.
699 "responseStatus": "A String", # The attendee's response status. Possible values are:
700 # - "needsAction" - The attendee has not responded to the invitation.
701 # - "declined" - The attendee has declined the invitation.
702 # - "tentative" - The attendee has tentatively accepted the invitation.
703 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700704 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400705 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700706 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
707 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400708 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700709 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400710 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
711 },
712 ],
713 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
714 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800715 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700716 "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.
John Asmuth614db982014-04-24 15:46:26 -0400717 },
718 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
719 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
720 "A String",
721 ],
722 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
723 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
724 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
725 },
726 "etag": "A String", # ETag of the resource.
727 "location": "A String", # Geographic location of the event as free-form text. Optional.
728 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
729 "gadget": { # A gadget that extends this event.
730 "preferences": { # Preferences.
731 "a_key": "A String", # The preference name and corresponding value.
732 },
733 "title": "A String", # The gadget's title.
734 "height": 42, # The gadget's height in pixels. Optional.
735 "width": 42, # The gadget's width in pixels. Optional.
736 "link": "A String", # The gadget's URL.
737 "type": "A String", # The gadget's type.
738 "display": "A String", # The gadget's display mode. Optional. Possible values are:
739 # - "icon" - The gadget displays next to the event's title in the calendar view.
740 # - "chip" - The gadget displays when the event is clicked.
741 "iconLink": "A String", # The gadget's icon URL.
742 },
743 "status": "A String", # Status of the event. Optional. Possible values are:
744 # - "confirmed" - The event is confirmed. This is the default status.
745 # - "tentative" - The event is tentatively confirmed.
746 # - "cancelled" - The event is cancelled.
747 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
748 "description": "A String", # Description of the event. Optional.
749 "iCalUID": "A String", # Event ID in the iCalendar format.
750 "extendedProperties": { # Extended properties of the event.
751 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
752 "a_key": "A String", # The name of the shared property and the corresponding value.
753 },
754 "private": { # Properties that are private to the copy of the event that appears on this calendar.
755 "a_key": "A String", # The name of the private property and the corresponding value.
756 },
757 },
758 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
759 "sequence": 42, # Sequence number as per iCalendar.
760 "visibility": "default", # Visibility of the event. Optional. Possible values are:
761 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
762 # - "public" - The event is public and event details are visible to all readers of the calendar.
763 # - "private" - The event is private and only event attendees may view event details.
764 # - "confidential" - The event is private. This value is provided for compatibility reasons.
765 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
766 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
767 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800768 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700769 "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.
John Asmuth614db982014-04-24 15:46:26 -0400770 },
Craig Citro065b5302014-08-14 00:47:23 -0700771 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400772 "kind": "calendar#event", # Type of the resource ("calendar#event").
773 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
774 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700775 "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.
John Asmuth614db982014-04-24 15:46:26 -0400776 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
777 "reminders": { # Information about the event's reminders for the authenticated user.
778 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
779 {
780 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
781 "method": "A String", # The method used by this reminder. Possible values are:
782 # - "email" - Reminders are sent via email.
783 # - "sms" - Reminders are sent via SMS.
784 # - "popup" - Reminders are sent via a UI popup.
785 },
786 ],
787 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
788 },
789 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
790 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
791 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800792 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700793 "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.
John Asmuth614db982014-04-24 15:46:26 -0400794 },
795 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
796 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
797 # - "opaque" - The event blocks time on the calendar. This is the default value.
798 # - "transparent" - The event does not block time on the calendar.
799 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
800 }</pre>
801</div>
802
803<div class="method">
804 <code class="details" id="instances">instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</code>
805 <pre>Returns instances of the specified recurring event.
806
807Args:
808 calendarId: string, Calendar identifier. (required)
809 eventId: string, Recurring event identifier. (required)
810 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
Craig Citro065b5302014-08-14 00:47:23 -0700811 showDeleted: boolean, Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.
812 alwaysIncludeEmail: boolean, Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400813 pageToken: string, Token specifying which result page to return. Optional.
814 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
Craig Citro065b5302014-08-14 00:47:23 -0700815 maxResults: integer, Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
John Asmuth614db982014-04-24 15:46:26 -0400816 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
817 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
818 originalStart: string, The original start time of the instance in the result. Optional.
819
820Returns:
821 An object of the form:
822
823 {
Craig Citro065b5302014-08-14 00:47:23 -0700824 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
John Asmuth614db982014-04-24 15:46:26 -0400825 "kind": "calendar#events", # Type of the collection ("calendar#events").
Craig Citro065b5302014-08-14 00:47:23 -0700826 "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).
John Asmuth614db982014-04-24 15:46:26 -0400827 {
828 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
829 "method": "A String", # The method used by this reminder. Possible values are:
830 # - "email" - Reminders are sent via email.
831 # - "sms" - Reminders are sent via SMS.
832 # - "popup" - Reminders are sent via a UI popup.
833 },
834 ],
835 "description": "A String", # Description of the calendar. Read-only.
836 "items": [ # List of events on the calendar.
837 {
838 "creator": { # The creator of the event. Read-only.
839 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
840 "displayName": "A String", # The creator's name, if available.
841 "email": "A String", # The creator's email address, if available.
842 "id": "A String", # The creator's Profile ID, if available.
843 },
Craig Citro065b5302014-08-14 00:47:23 -0700844 "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.
John Asmuth614db982014-04-24 15:46:26 -0400845 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
846 "displayName": "A String", # The organizer's name, if available.
847 "email": "A String", # The organizer's email address, if available.
848 "id": "A String", # The organizer's Profile ID, if available.
849 },
850 "summary": "A String", # Title of the event.
851 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
852 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
853 # - the length of the ID must be between 5 and 1024 characters
854 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
855 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
856 "attendees": [ # The attendees of the event.
857 {
858 "comment": "A String", # The attendee's response comment. Optional.
859 "displayName": "A String", # The attendee's name, if available. Optional.
860 "responseStatus": "A String", # The attendee's response status. Possible values are:
861 # - "needsAction" - The attendee has not responded to the invitation.
862 # - "declined" - The attendee has declined the invitation.
863 # - "tentative" - The attendee has tentatively accepted the invitation.
864 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700865 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400866 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700867 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
868 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400869 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700870 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400871 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
872 },
873 ],
874 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
875 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800876 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700877 "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.
John Asmuth614db982014-04-24 15:46:26 -0400878 },
879 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
880 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
881 "A String",
882 ],
883 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
884 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
885 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
886 },
887 "etag": "A String", # ETag of the resource.
888 "location": "A String", # Geographic location of the event as free-form text. Optional.
889 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
890 "gadget": { # A gadget that extends this event.
891 "preferences": { # Preferences.
892 "a_key": "A String", # The preference name and corresponding value.
893 },
894 "title": "A String", # The gadget's title.
895 "height": 42, # The gadget's height in pixels. Optional.
896 "width": 42, # The gadget's width in pixels. Optional.
897 "link": "A String", # The gadget's URL.
898 "type": "A String", # The gadget's type.
899 "display": "A String", # The gadget's display mode. Optional. Possible values are:
900 # - "icon" - The gadget displays next to the event's title in the calendar view.
901 # - "chip" - The gadget displays when the event is clicked.
902 "iconLink": "A String", # The gadget's icon URL.
903 },
904 "status": "A String", # Status of the event. Optional. Possible values are:
905 # - "confirmed" - The event is confirmed. This is the default status.
906 # - "tentative" - The event is tentatively confirmed.
907 # - "cancelled" - The event is cancelled.
908 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
909 "description": "A String", # Description of the event. Optional.
910 "iCalUID": "A String", # Event ID in the iCalendar format.
911 "extendedProperties": { # Extended properties of the event.
912 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
913 "a_key": "A String", # The name of the shared property and the corresponding value.
914 },
915 "private": { # Properties that are private to the copy of the event that appears on this calendar.
916 "a_key": "A String", # The name of the private property and the corresponding value.
917 },
918 },
919 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
920 "sequence": 42, # Sequence number as per iCalendar.
921 "visibility": "default", # Visibility of the event. Optional. Possible values are:
922 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
923 # - "public" - The event is public and event details are visible to all readers of the calendar.
924 # - "private" - The event is private and only event attendees may view event details.
925 # - "confidential" - The event is private. This value is provided for compatibility reasons.
926 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
927 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
928 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800929 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700930 "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.
John Asmuth614db982014-04-24 15:46:26 -0400931 },
Craig Citro065b5302014-08-14 00:47:23 -0700932 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400933 "kind": "calendar#event", # Type of the resource ("calendar#event").
934 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
935 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700936 "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.
John Asmuth614db982014-04-24 15:46:26 -0400937 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
938 "reminders": { # Information about the event's reminders for the authenticated user.
939 "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
940 {
941 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
942 "method": "A String", # The method used by this reminder. Possible values are:
943 # - "email" - Reminders are sent via email.
944 # - "sms" - Reminders are sent via SMS.
945 # - "popup" - Reminders are sent via a UI popup.
946 },
947 ],
948 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
949 },
950 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
951 "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
952 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -0800953 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -0700954 "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.
John Asmuth614db982014-04-24 15:46:26 -0400955 },
956 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
957 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
958 # - "opaque" - The event blocks time on the calendar. This is the default value.
959 # - "transparent" - The event does not block time on the calendar.
960 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
961 },
962 ],
963 "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
964 "summary": "A String", # Title of the calendar. Read-only.
965 "etag": "A String", # ETag of the collection.
966 "timeZone": "A String", # The time zone of the calendar. Read-only.
967 "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
968 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
969 # - "none" - The user has no access.
970 # - "freeBusyReader" - The user has read access to free/busy information.
971 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
972 # - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
973 # - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
974 }</pre>
975</div>
976
977<div class="method">
978 <code class="details" id="instances_next">instances_next(previous_request, previous_response)</code>
979 <pre>Retrieves the next page of results.
980
981Args:
982 previous_request: The request for the previous page. (required)
983 previous_response: The response from the request for the previous page. (required)
984
985Returns:
986 A request object that you can call 'execute()' on to request the next
987 page. Returns None if there are no more items in the collection.
988 </pre>
989</div>
990
991<div class="method">
992 <code class="details" id="list">list(calendarId, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</code>
993 <pre>Returns events on the specified calendar.
994
995Args:
996 calendarId: string, Calendar identifier. (required)
997 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
998 Allowed values
Craig Citro065b5302014-08-14 00:47:23 -0700999 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)
John Asmuth614db982014-04-24 15:46:26 -04001000 updated - Order by last modification time (ascending).
1001 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
1002 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
1003 privateExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
1004 pageToken: string, Token specifying which result page to return. Optional.
Craig Citro065b5302014-08-14 00:47:23 -07001005 updatedMin: string, Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
John Asmuth614db982014-04-24 15:46:26 -04001006 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.
Craig Citro065b5302014-08-14 00:47:23 -07001007 alwaysIncludeEmail: boolean, Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
1008 showDeleted: boolean, Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001009 sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
1010 maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
Craig Citro065b5302014-08-14 00:47:23 -07001011 syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
1012There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.
1013
1014These are:
1015- iCalUID
1016- orderBy
1017- privateExtendedProperty
1018- q
1019- sharedExtendedProperty
1020- timeMin
1021- timeMax
1022- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
1023Learn more about incremental synchronization.
1024Optional. The default is to return all entries.
1025 iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.
1026 maxResults: integer, Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
John Asmuth614db982014-04-24 15:46:26 -04001027 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
1028 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
1029 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
1030
1031Returns:
1032 An object of the form:
1033
1034 {
Craig Citro065b5302014-08-14 00:47:23 -07001035 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
John Asmuth614db982014-04-24 15:46:26 -04001036 "kind": "calendar#events", # Type of the collection ("calendar#events").
Craig Citro065b5302014-08-14 00:47:23 -07001037 "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).
John Asmuth614db982014-04-24 15:46:26 -04001038 {
1039 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1040 "method": "A String", # The method used by this reminder. Possible values are:
1041 # - "email" - Reminders are sent via email.
1042 # - "sms" - Reminders are sent via SMS.
1043 # - "popup" - Reminders are sent via a UI popup.
1044 },
1045 ],
1046 "description": "A String", # Description of the calendar. Read-only.
1047 "items": [ # List of events on the calendar.
1048 {
1049 "creator": { # The creator of the event. Read-only.
1050 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1051 "displayName": "A String", # The creator's name, if available.
1052 "email": "A String", # The creator's email address, if available.
1053 "id": "A String", # The creator's Profile ID, if available.
1054 },
Craig Citro065b5302014-08-14 00:47:23 -07001055 "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.
John Asmuth614db982014-04-24 15:46:26 -04001056 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1057 "displayName": "A String", # The organizer's name, if available.
1058 "email": "A String", # The organizer's email address, if available.
1059 "id": "A String", # The organizer's Profile ID, if available.
1060 },
1061 "summary": "A String", # Title of the event.
1062 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1063 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1064 # - the length of the ID must be between 5 and 1024 characters
1065 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1066 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1067 "attendees": [ # The attendees of the event.
1068 {
1069 "comment": "A String", # The attendee's response comment. Optional.
1070 "displayName": "A String", # The attendee's name, if available. Optional.
1071 "responseStatus": "A String", # The attendee's response status. Possible values are:
1072 # - "needsAction" - The attendee has not responded to the invitation.
1073 # - "declined" - The attendee has declined the invitation.
1074 # - "tentative" - The attendee has tentatively accepted the invitation.
1075 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001076 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001077 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001078 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
1079 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001080 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001081 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001082 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1083 },
1084 ],
1085 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1086 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001087 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001088 "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.
John Asmuth614db982014-04-24 15:46:26 -04001089 },
1090 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1091 "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.
1092 "A String",
1093 ],
1094 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1095 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1096 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1097 },
1098 "etag": "A String", # ETag of the resource.
1099 "location": "A String", # Geographic location of the event as free-form text. Optional.
1100 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1101 "gadget": { # A gadget that extends this event.
1102 "preferences": { # Preferences.
1103 "a_key": "A String", # The preference name and corresponding value.
1104 },
1105 "title": "A String", # The gadget's title.
1106 "height": 42, # The gadget's height in pixels. Optional.
1107 "width": 42, # The gadget's width in pixels. Optional.
1108 "link": "A String", # The gadget's URL.
1109 "type": "A String", # The gadget's type.
1110 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1111 # - "icon" - The gadget displays next to the event's title in the calendar view.
1112 # - "chip" - The gadget displays when the event is clicked.
1113 "iconLink": "A String", # The gadget's icon URL.
1114 },
1115 "status": "A String", # Status of the event. Optional. Possible values are:
1116 # - "confirmed" - The event is confirmed. This is the default status.
1117 # - "tentative" - The event is tentatively confirmed.
1118 # - "cancelled" - The event is cancelled.
1119 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1120 "description": "A String", # Description of the event. Optional.
1121 "iCalUID": "A String", # Event ID in the iCalendar format.
1122 "extendedProperties": { # Extended properties of the event.
1123 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1124 "a_key": "A String", # The name of the shared property and the corresponding value.
1125 },
1126 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1127 "a_key": "A String", # The name of the private property and the corresponding value.
1128 },
1129 },
1130 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1131 "sequence": 42, # Sequence number as per iCalendar.
1132 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1133 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1134 # - "public" - The event is public and event details are visible to all readers of the calendar.
1135 # - "private" - The event is private and only event attendees may view event details.
1136 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1137 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1138 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1139 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001140 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001141 "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.
John Asmuth614db982014-04-24 15:46:26 -04001142 },
Craig Citro065b5302014-08-14 00:47:23 -07001143 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001144 "kind": "calendar#event", # Type of the resource ("calendar#event").
1145 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1146 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -07001147 "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.
John Asmuth614db982014-04-24 15:46:26 -04001148 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1149 "reminders": { # Information about the event's reminders for the authenticated user.
1150 "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.
1151 {
1152 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1153 "method": "A String", # The method used by this reminder. Possible values are:
1154 # - "email" - Reminders are sent via email.
1155 # - "sms" - Reminders are sent via SMS.
1156 # - "popup" - Reminders are sent via a UI popup.
1157 },
1158 ],
1159 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1160 },
1161 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1162 "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.
1163 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001164 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001165 "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.
John Asmuth614db982014-04-24 15:46:26 -04001166 },
1167 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1168 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1169 # - "opaque" - The event blocks time on the calendar. This is the default value.
1170 # - "transparent" - The event does not block time on the calendar.
1171 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1172 },
1173 ],
1174 "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
1175 "summary": "A String", # Title of the calendar. Read-only.
1176 "etag": "A String", # ETag of the collection.
1177 "timeZone": "A String", # The time zone of the calendar. Read-only.
1178 "nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
1179 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
1180 # - "none" - The user has no access.
1181 # - "freeBusyReader" - The user has read access to free/busy information.
1182 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
1183 # - "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.
1184 # - "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.
1185 }</pre>
1186</div>
1187
1188<div class="method">
1189 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1190 <pre>Retrieves the next page of results.
1191
1192Args:
1193 previous_request: The request for the previous page. (required)
1194 previous_response: The response from the request for the previous page. (required)
1195
1196Returns:
1197 A request object that you can call 'execute()' on to request the next
1198 page. Returns None if there are no more items in the collection.
1199 </pre>
1200</div>
1201
1202<div class="method">
1203 <code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None)</code>
1204 <pre>Moves an event to another calendar, i.e. changes an event's organizer.
1205
1206Args:
1207 calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)
1208 eventId: string, Event identifier. (required)
1209 destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)
1210 sendNotifications: boolean, Whether to send notifications about the change of the event's organizer. Optional. The default is False.
1211
1212Returns:
1213 An object of the form:
1214
1215 {
1216 "creator": { # The creator of the event. Read-only.
1217 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1218 "displayName": "A String", # The creator's name, if available.
1219 "email": "A String", # The creator's email address, if available.
1220 "id": "A String", # The creator's Profile ID, if available.
1221 },
Craig Citro065b5302014-08-14 00:47:23 -07001222 "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.
John Asmuth614db982014-04-24 15:46:26 -04001223 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1224 "displayName": "A String", # The organizer's name, if available.
1225 "email": "A String", # The organizer's email address, if available.
1226 "id": "A String", # The organizer's Profile ID, if available.
1227 },
1228 "summary": "A String", # Title of the event.
1229 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1230 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1231 # - the length of the ID must be between 5 and 1024 characters
1232 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1233 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1234 "attendees": [ # The attendees of the event.
1235 {
1236 "comment": "A String", # The attendee's response comment. Optional.
1237 "displayName": "A String", # The attendee's name, if available. Optional.
1238 "responseStatus": "A String", # The attendee's response status. Possible values are:
1239 # - "needsAction" - The attendee has not responded to the invitation.
1240 # - "declined" - The attendee has declined the invitation.
1241 # - "tentative" - The attendee has tentatively accepted the invitation.
1242 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001243 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001244 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001245 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
1246 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001247 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001248 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001249 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1250 },
1251 ],
1252 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1253 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001254 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001255 "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.
John Asmuth614db982014-04-24 15:46:26 -04001256 },
1257 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1258 "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.
1259 "A String",
1260 ],
1261 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1262 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1263 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1264 },
1265 "etag": "A String", # ETag of the resource.
1266 "location": "A String", # Geographic location of the event as free-form text. Optional.
1267 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1268 "gadget": { # A gadget that extends this event.
1269 "preferences": { # Preferences.
1270 "a_key": "A String", # The preference name and corresponding value.
1271 },
1272 "title": "A String", # The gadget's title.
1273 "height": 42, # The gadget's height in pixels. Optional.
1274 "width": 42, # The gadget's width in pixels. Optional.
1275 "link": "A String", # The gadget's URL.
1276 "type": "A String", # The gadget's type.
1277 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1278 # - "icon" - The gadget displays next to the event's title in the calendar view.
1279 # - "chip" - The gadget displays when the event is clicked.
1280 "iconLink": "A String", # The gadget's icon URL.
1281 },
1282 "status": "A String", # Status of the event. Optional. Possible values are:
1283 # - "confirmed" - The event is confirmed. This is the default status.
1284 # - "tentative" - The event is tentatively confirmed.
1285 # - "cancelled" - The event is cancelled.
1286 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1287 "description": "A String", # Description of the event. Optional.
1288 "iCalUID": "A String", # Event ID in the iCalendar format.
1289 "extendedProperties": { # Extended properties of the event.
1290 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1291 "a_key": "A String", # The name of the shared property and the corresponding value.
1292 },
1293 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1294 "a_key": "A String", # The name of the private property and the corresponding value.
1295 },
1296 },
1297 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1298 "sequence": 42, # Sequence number as per iCalendar.
1299 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1300 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1301 # - "public" - The event is public and event details are visible to all readers of the calendar.
1302 # - "private" - The event is private and only event attendees may view event details.
1303 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1304 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1305 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1306 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001307 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001308 "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.
John Asmuth614db982014-04-24 15:46:26 -04001309 },
Craig Citro065b5302014-08-14 00:47:23 -07001310 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001311 "kind": "calendar#event", # Type of the resource ("calendar#event").
1312 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1313 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -07001314 "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.
John Asmuth614db982014-04-24 15:46:26 -04001315 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1316 "reminders": { # Information about the event's reminders for the authenticated user.
1317 "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.
1318 {
1319 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1320 "method": "A String", # The method used by this reminder. Possible values are:
1321 # - "email" - Reminders are sent via email.
1322 # - "sms" - Reminders are sent via SMS.
1323 # - "popup" - Reminders are sent via a UI popup.
1324 },
1325 ],
1326 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1327 },
1328 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1329 "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.
1330 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001331 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001332 "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.
John Asmuth614db982014-04-24 15:46:26 -04001333 },
1334 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1335 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1336 # - "opaque" - The event blocks time on the calendar. This is the default value.
1337 # - "transparent" - The event does not block time on the calendar.
1338 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1339 }</pre>
1340</div>
1341
1342<div class="method">
1343 <code class="details" id="patch">patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</code>
1344 <pre>Updates an event. This method supports patch semantics.
1345
1346Args:
1347 calendarId: string, Calendar identifier. (required)
1348 eventId: string, Event identifier. (required)
1349 body: object, The request body. (required)
1350 The object takes the form of:
1351
1352{
1353 "creator": { # The creator of the event. Read-only.
1354 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1355 "displayName": "A String", # The creator's name, if available.
1356 "email": "A String", # The creator's email address, if available.
1357 "id": "A String", # The creator's Profile ID, if available.
1358 },
Craig Citro065b5302014-08-14 00:47:23 -07001359 "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.
John Asmuth614db982014-04-24 15:46:26 -04001360 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1361 "displayName": "A String", # The organizer's name, if available.
1362 "email": "A String", # The organizer's email address, if available.
1363 "id": "A String", # The organizer's Profile ID, if available.
1364 },
1365 "summary": "A String", # Title of the event.
1366 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1367 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1368 # - the length of the ID must be between 5 and 1024 characters
1369 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1370 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1371 "attendees": [ # The attendees of the event.
1372 {
1373 "comment": "A String", # The attendee's response comment. Optional.
1374 "displayName": "A String", # The attendee's name, if available. Optional.
1375 "responseStatus": "A String", # The attendee's response status. Possible values are:
1376 # - "needsAction" - The attendee has not responded to the invitation.
1377 # - "declined" - The attendee has declined the invitation.
1378 # - "tentative" - The attendee has tentatively accepted the invitation.
1379 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001380 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001381 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001382 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
1383 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001384 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001385 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001386 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1387 },
1388 ],
1389 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1390 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001391 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001392 "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.
John Asmuth614db982014-04-24 15:46:26 -04001393 },
1394 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1395 "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.
1396 "A String",
1397 ],
1398 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1399 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1400 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1401 },
1402 "etag": "A String", # ETag of the resource.
1403 "location": "A String", # Geographic location of the event as free-form text. Optional.
1404 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1405 "gadget": { # A gadget that extends this event.
1406 "preferences": { # Preferences.
1407 "a_key": "A String", # The preference name and corresponding value.
1408 },
1409 "title": "A String", # The gadget's title.
1410 "height": 42, # The gadget's height in pixels. Optional.
1411 "width": 42, # The gadget's width in pixels. Optional.
1412 "link": "A String", # The gadget's URL.
1413 "type": "A String", # The gadget's type.
1414 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1415 # - "icon" - The gadget displays next to the event's title in the calendar view.
1416 # - "chip" - The gadget displays when the event is clicked.
1417 "iconLink": "A String", # The gadget's icon URL.
1418 },
1419 "status": "A String", # Status of the event. Optional. Possible values are:
1420 # - "confirmed" - The event is confirmed. This is the default status.
1421 # - "tentative" - The event is tentatively confirmed.
1422 # - "cancelled" - The event is cancelled.
1423 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1424 "description": "A String", # Description of the event. Optional.
1425 "iCalUID": "A String", # Event ID in the iCalendar format.
1426 "extendedProperties": { # Extended properties of the event.
1427 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1428 "a_key": "A String", # The name of the shared property and the corresponding value.
1429 },
1430 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1431 "a_key": "A String", # The name of the private property and the corresponding value.
1432 },
1433 },
1434 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1435 "sequence": 42, # Sequence number as per iCalendar.
1436 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1437 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1438 # - "public" - The event is public and event details are visible to all readers of the calendar.
1439 # - "private" - The event is private and only event attendees may view event details.
1440 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1441 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1442 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1443 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001444 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001445 "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.
John Asmuth614db982014-04-24 15:46:26 -04001446 },
Craig Citro065b5302014-08-14 00:47:23 -07001447 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001448 "kind": "calendar#event", # Type of the resource ("calendar#event").
1449 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1450 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -07001451 "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.
John Asmuth614db982014-04-24 15:46:26 -04001452 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1453 "reminders": { # Information about the event's reminders for the authenticated user.
1454 "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.
1455 {
1456 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1457 "method": "A String", # The method used by this reminder. Possible values are:
1458 # - "email" - Reminders are sent via email.
1459 # - "sms" - Reminders are sent via SMS.
1460 # - "popup" - Reminders are sent via a UI popup.
1461 },
1462 ],
1463 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1464 },
1465 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1466 "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.
1467 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001468 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001469 "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.
John Asmuth614db982014-04-24 15:46:26 -04001470 },
1471 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1472 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1473 # - "opaque" - The event blocks time on the calendar. This is the default value.
1474 # - "transparent" - The event does not block time on the calendar.
1475 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1476 }
1477
1478 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
Craig Citro065b5302014-08-14 00:47:23 -07001479 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.
John Asmuth614db982014-04-24 15:46:26 -04001480 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.
1481
1482Returns:
1483 An object of the form:
1484
1485 {
1486 "creator": { # The creator of the event. Read-only.
1487 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1488 "displayName": "A String", # The creator's name, if available.
1489 "email": "A String", # The creator's email address, if available.
1490 "id": "A String", # The creator's Profile ID, if available.
1491 },
Craig Citro065b5302014-08-14 00:47:23 -07001492 "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.
John Asmuth614db982014-04-24 15:46:26 -04001493 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1494 "displayName": "A String", # The organizer's name, if available.
1495 "email": "A String", # The organizer's email address, if available.
1496 "id": "A String", # The organizer's Profile ID, if available.
1497 },
1498 "summary": "A String", # Title of the event.
1499 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1500 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1501 # - the length of the ID must be between 5 and 1024 characters
1502 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1503 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1504 "attendees": [ # The attendees of the event.
1505 {
1506 "comment": "A String", # The attendee's response comment. Optional.
1507 "displayName": "A String", # The attendee's name, if available. Optional.
1508 "responseStatus": "A String", # The attendee's response status. Possible values are:
1509 # - "needsAction" - The attendee has not responded to the invitation.
1510 # - "declined" - The attendee has declined the invitation.
1511 # - "tentative" - The attendee has tentatively accepted the invitation.
1512 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001513 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001514 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001515 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
1516 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001517 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001518 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001519 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1520 },
1521 ],
1522 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1523 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001524 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001525 "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.
John Asmuth614db982014-04-24 15:46:26 -04001526 },
1527 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1528 "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.
1529 "A String",
1530 ],
1531 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1532 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1533 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1534 },
1535 "etag": "A String", # ETag of the resource.
1536 "location": "A String", # Geographic location of the event as free-form text. Optional.
1537 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1538 "gadget": { # A gadget that extends this event.
1539 "preferences": { # Preferences.
1540 "a_key": "A String", # The preference name and corresponding value.
1541 },
1542 "title": "A String", # The gadget's title.
1543 "height": 42, # The gadget's height in pixels. Optional.
1544 "width": 42, # The gadget's width in pixels. Optional.
1545 "link": "A String", # The gadget's URL.
1546 "type": "A String", # The gadget's type.
1547 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1548 # - "icon" - The gadget displays next to the event's title in the calendar view.
1549 # - "chip" - The gadget displays when the event is clicked.
1550 "iconLink": "A String", # The gadget's icon URL.
1551 },
1552 "status": "A String", # Status of the event. Optional. Possible values are:
1553 # - "confirmed" - The event is confirmed. This is the default status.
1554 # - "tentative" - The event is tentatively confirmed.
1555 # - "cancelled" - The event is cancelled.
1556 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1557 "description": "A String", # Description of the event. Optional.
1558 "iCalUID": "A String", # Event ID in the iCalendar format.
1559 "extendedProperties": { # Extended properties of the event.
1560 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1561 "a_key": "A String", # The name of the shared property and the corresponding value.
1562 },
1563 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1564 "a_key": "A String", # The name of the private property and the corresponding value.
1565 },
1566 },
1567 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1568 "sequence": 42, # Sequence number as per iCalendar.
1569 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1570 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1571 # - "public" - The event is public and event details are visible to all readers of the calendar.
1572 # - "private" - The event is private and only event attendees may view event details.
1573 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1574 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1575 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1576 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001577 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001578 "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.
John Asmuth614db982014-04-24 15:46:26 -04001579 },
Craig Citro065b5302014-08-14 00:47:23 -07001580 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001581 "kind": "calendar#event", # Type of the resource ("calendar#event").
1582 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1583 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -07001584 "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.
John Asmuth614db982014-04-24 15:46:26 -04001585 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1586 "reminders": { # Information about the event's reminders for the authenticated user.
1587 "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.
1588 {
1589 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1590 "method": "A String", # The method used by this reminder. Possible values are:
1591 # - "email" - Reminders are sent via email.
1592 # - "sms" - Reminders are sent via SMS.
1593 # - "popup" - Reminders are sent via a UI popup.
1594 },
1595 ],
1596 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1597 },
1598 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1599 "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.
1600 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001601 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001602 "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.
John Asmuth614db982014-04-24 15:46:26 -04001603 },
1604 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1605 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1606 # - "opaque" - The event blocks time on the calendar. This is the default value.
1607 # - "transparent" - The event does not block time on the calendar.
1608 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1609 }</pre>
1610</div>
1611
1612<div class="method">
1613 <code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None)</code>
1614 <pre>Creates an event based on a simple text string.
1615
1616Args:
1617 calendarId: string, Calendar identifier. (required)
1618 text: string, The text describing the event to be created. (required)
1619 sendNotifications: boolean, Whether to send notifications about the creation of the event. Optional. The default is False.
1620
1621Returns:
1622 An object of the form:
1623
1624 {
1625 "creator": { # The creator of the event. Read-only.
1626 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1627 "displayName": "A String", # The creator's name, if available.
1628 "email": "A String", # The creator's email address, if available.
1629 "id": "A String", # The creator's Profile ID, if available.
1630 },
Craig Citro065b5302014-08-14 00:47:23 -07001631 "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.
John Asmuth614db982014-04-24 15:46:26 -04001632 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1633 "displayName": "A String", # The organizer's name, if available.
1634 "email": "A String", # The organizer's email address, if available.
1635 "id": "A String", # The organizer's Profile ID, if available.
1636 },
1637 "summary": "A String", # Title of the event.
1638 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1639 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1640 # - the length of the ID must be between 5 and 1024 characters
1641 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1642 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1643 "attendees": [ # The attendees of the event.
1644 {
1645 "comment": "A String", # The attendee's response comment. Optional.
1646 "displayName": "A String", # The attendee's name, if available. Optional.
1647 "responseStatus": "A String", # The attendee's response status. Possible values are:
1648 # - "needsAction" - The attendee has not responded to the invitation.
1649 # - "declined" - The attendee has declined the invitation.
1650 # - "tentative" - The attendee has tentatively accepted the invitation.
1651 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001652 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001653 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001654 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
1655 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001656 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001657 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001658 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1659 },
1660 ],
1661 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1662 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001663 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001664 "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.
John Asmuth614db982014-04-24 15:46:26 -04001665 },
1666 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1667 "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.
1668 "A String",
1669 ],
1670 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1671 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1672 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1673 },
1674 "etag": "A String", # ETag of the resource.
1675 "location": "A String", # Geographic location of the event as free-form text. Optional.
1676 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1677 "gadget": { # A gadget that extends this event.
1678 "preferences": { # Preferences.
1679 "a_key": "A String", # The preference name and corresponding value.
1680 },
1681 "title": "A String", # The gadget's title.
1682 "height": 42, # The gadget's height in pixels. Optional.
1683 "width": 42, # The gadget's width in pixels. Optional.
1684 "link": "A String", # The gadget's URL.
1685 "type": "A String", # The gadget's type.
1686 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1687 # - "icon" - The gadget displays next to the event's title in the calendar view.
1688 # - "chip" - The gadget displays when the event is clicked.
1689 "iconLink": "A String", # The gadget's icon URL.
1690 },
1691 "status": "A String", # Status of the event. Optional. Possible values are:
1692 # - "confirmed" - The event is confirmed. This is the default status.
1693 # - "tentative" - The event is tentatively confirmed.
1694 # - "cancelled" - The event is cancelled.
1695 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1696 "description": "A String", # Description of the event. Optional.
1697 "iCalUID": "A String", # Event ID in the iCalendar format.
1698 "extendedProperties": { # Extended properties of the event.
1699 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1700 "a_key": "A String", # The name of the shared property and the corresponding value.
1701 },
1702 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1703 "a_key": "A String", # The name of the private property and the corresponding value.
1704 },
1705 },
1706 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1707 "sequence": 42, # Sequence number as per iCalendar.
1708 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1709 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1710 # - "public" - The event is public and event details are visible to all readers of the calendar.
1711 # - "private" - The event is private and only event attendees may view event details.
1712 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1713 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1714 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1715 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001716 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001717 "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.
John Asmuth614db982014-04-24 15:46:26 -04001718 },
Craig Citro065b5302014-08-14 00:47:23 -07001719 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001720 "kind": "calendar#event", # Type of the resource ("calendar#event").
1721 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1722 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -07001723 "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.
John Asmuth614db982014-04-24 15:46:26 -04001724 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1725 "reminders": { # Information about the event's reminders for the authenticated user.
1726 "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.
1727 {
1728 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1729 "method": "A String", # The method used by this reminder. Possible values are:
1730 # - "email" - Reminders are sent via email.
1731 # - "sms" - Reminders are sent via SMS.
1732 # - "popup" - Reminders are sent via a UI popup.
1733 },
1734 ],
1735 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1736 },
1737 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1738 "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.
1739 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001740 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001741 "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.
John Asmuth614db982014-04-24 15:46:26 -04001742 },
1743 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1744 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1745 # - "opaque" - The event blocks time on the calendar. This is the default value.
1746 # - "transparent" - The event does not block time on the calendar.
1747 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1748 }</pre>
1749</div>
1750
1751<div class="method">
1752 <code class="details" id="update">update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)</code>
1753 <pre>Updates an event.
1754
1755Args:
1756 calendarId: string, Calendar identifier. (required)
1757 eventId: string, Event identifier. (required)
1758 body: object, The request body. (required)
1759 The object takes the form of:
1760
1761{
1762 "creator": { # The creator of the event. Read-only.
1763 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1764 "displayName": "A String", # The creator's name, if available.
1765 "email": "A String", # The creator's email address, if available.
1766 "id": "A String", # The creator's Profile ID, if available.
1767 },
Craig Citro065b5302014-08-14 00:47:23 -07001768 "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.
John Asmuth614db982014-04-24 15:46:26 -04001769 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1770 "displayName": "A String", # The organizer's name, if available.
1771 "email": "A String", # The organizer's email address, if available.
1772 "id": "A String", # The organizer's Profile ID, if available.
1773 },
1774 "summary": "A String", # Title of the event.
1775 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1776 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1777 # - the length of the ID must be between 5 and 1024 characters
1778 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1779 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1780 "attendees": [ # The attendees of the event.
1781 {
1782 "comment": "A String", # The attendee's response comment. Optional.
1783 "displayName": "A String", # The attendee's name, if available. Optional.
1784 "responseStatus": "A String", # The attendee's response status. Possible values are:
1785 # - "needsAction" - The attendee has not responded to the invitation.
1786 # - "declined" - The attendee has declined the invitation.
1787 # - "tentative" - The attendee has tentatively accepted the invitation.
1788 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001789 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001790 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001791 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
1792 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001793 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001794 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001795 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1796 },
1797 ],
1798 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1799 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001800 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001801 "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.
John Asmuth614db982014-04-24 15:46:26 -04001802 },
1803 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1804 "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.
1805 "A String",
1806 ],
1807 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1808 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1809 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1810 },
1811 "etag": "A String", # ETag of the resource.
1812 "location": "A String", # Geographic location of the event as free-form text. Optional.
1813 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1814 "gadget": { # A gadget that extends this event.
1815 "preferences": { # Preferences.
1816 "a_key": "A String", # The preference name and corresponding value.
1817 },
1818 "title": "A String", # The gadget's title.
1819 "height": 42, # The gadget's height in pixels. Optional.
1820 "width": 42, # The gadget's width in pixels. Optional.
1821 "link": "A String", # The gadget's URL.
1822 "type": "A String", # The gadget's type.
1823 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1824 # - "icon" - The gadget displays next to the event's title in the calendar view.
1825 # - "chip" - The gadget displays when the event is clicked.
1826 "iconLink": "A String", # The gadget's icon URL.
1827 },
1828 "status": "A String", # Status of the event. Optional. Possible values are:
1829 # - "confirmed" - The event is confirmed. This is the default status.
1830 # - "tentative" - The event is tentatively confirmed.
1831 # - "cancelled" - The event is cancelled.
1832 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1833 "description": "A String", # Description of the event. Optional.
1834 "iCalUID": "A String", # Event ID in the iCalendar format.
1835 "extendedProperties": { # Extended properties of the event.
1836 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1837 "a_key": "A String", # The name of the shared property and the corresponding value.
1838 },
1839 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1840 "a_key": "A String", # The name of the private property and the corresponding value.
1841 },
1842 },
1843 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1844 "sequence": 42, # Sequence number as per iCalendar.
1845 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1846 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1847 # - "public" - The event is public and event details are visible to all readers of the calendar.
1848 # - "private" - The event is private and only event attendees may view event details.
1849 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1850 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1851 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1852 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001853 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001854 "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.
John Asmuth614db982014-04-24 15:46:26 -04001855 },
Craig Citro065b5302014-08-14 00:47:23 -07001856 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001857 "kind": "calendar#event", # Type of the resource ("calendar#event").
1858 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1859 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -07001860 "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.
John Asmuth614db982014-04-24 15:46:26 -04001861 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1862 "reminders": { # Information about the event's reminders for the authenticated user.
1863 "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.
1864 {
1865 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1866 "method": "A String", # The method used by this reminder. Possible values are:
1867 # - "email" - Reminders are sent via email.
1868 # - "sms" - Reminders are sent via SMS.
1869 # - "popup" - Reminders are sent via a UI popup.
1870 },
1871 ],
1872 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1873 },
1874 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
1875 "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.
1876 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001877 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001878 "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.
John Asmuth614db982014-04-24 15:46:26 -04001879 },
1880 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1881 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
1882 # - "opaque" - The event blocks time on the calendar. This is the default value.
1883 # - "transparent" - The event does not block time on the calendar.
1884 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
1885 }
1886
1887 sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
Craig Citro065b5302014-08-14 00:47:23 -07001888 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.
John Asmuth614db982014-04-24 15:46:26 -04001889 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.
1890
1891Returns:
1892 An object of the form:
1893
1894 {
1895 "creator": { # The creator of the event. Read-only.
1896 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1897 "displayName": "A String", # The creator's name, if available.
1898 "email": "A String", # The creator's email address, if available.
1899 "id": "A String", # The creator's Profile ID, if available.
1900 },
Craig Citro065b5302014-08-14 00:47:23 -07001901 "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.
John Asmuth614db982014-04-24 15:46:26 -04001902 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1903 "displayName": "A String", # The organizer's name, if available.
1904 "email": "A String", # The organizer's email address, if available.
1905 "id": "A String", # The organizer's Profile ID, if available.
1906 },
1907 "summary": "A String", # Title of the event.
1908 "id": "A String", # Identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
1909 # - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
1910 # - the length of the ID must be between 5 and 1024 characters
1911 # - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
1912 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
1913 "attendees": [ # The attendees of the event.
1914 {
1915 "comment": "A String", # The attendee's response comment. Optional.
1916 "displayName": "A String", # The attendee's name, if available. Optional.
1917 "responseStatus": "A String", # The attendee's response status. Possible values are:
1918 # - "needsAction" - The attendee has not responded to the invitation.
1919 # - "declined" - The attendee has declined the invitation.
1920 # - "tentative" - The attendee has tentatively accepted the invitation.
1921 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001922 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001923 "id": "A String", # The attendee's Profile ID, if available.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001924 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
1925 "resource": false, # Whether the attendee is a resource. Read-only. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001926 "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001927 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001928 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
1929 },
1930 ],
1931 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1932 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001933 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001934 "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.
John Asmuth614db982014-04-24 15:46:26 -04001935 },
1936 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
1937 "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.
1938 "A String",
1939 ],
1940 "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
1941 "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
1942 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1943 },
1944 "etag": "A String", # ETag of the resource.
1945 "location": "A String", # Geographic location of the event as free-form text. Optional.
1946 "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
1947 "gadget": { # A gadget that extends this event.
1948 "preferences": { # Preferences.
1949 "a_key": "A String", # The preference name and corresponding value.
1950 },
1951 "title": "A String", # The gadget's title.
1952 "height": 42, # The gadget's height in pixels. Optional.
1953 "width": 42, # The gadget's width in pixels. Optional.
1954 "link": "A String", # The gadget's URL.
1955 "type": "A String", # The gadget's type.
1956 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1957 # - "icon" - The gadget displays next to the event's title in the calendar view.
1958 # - "chip" - The gadget displays when the event is clicked.
1959 "iconLink": "A String", # The gadget's icon URL.
1960 },
1961 "status": "A String", # Status of the event. Optional. Possible values are:
1962 # - "confirmed" - The event is confirmed. This is the default status.
1963 # - "tentative" - The event is tentatively confirmed.
1964 # - "cancelled" - The event is cancelled.
1965 "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
1966 "description": "A String", # Description of the event. Optional.
1967 "iCalUID": "A String", # Event ID in the iCalendar format.
1968 "extendedProperties": { # Extended properties of the event.
1969 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1970 "a_key": "A String", # The name of the shared property and the corresponding value.
1971 },
1972 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1973 "a_key": "A String", # The name of the private property and the corresponding value.
1974 },
1975 },
1976 "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
1977 "sequence": 42, # Sequence number as per iCalendar.
1978 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1979 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1980 # - "public" - The event is public and event details are visible to all readers of the calendar.
1981 # - "private" - The event is private and only event attendees may view event details.
1982 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1983 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1984 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1985 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08001986 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07001987 "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.
John Asmuth614db982014-04-24 15:46:26 -04001988 },
Craig Citro065b5302014-08-14 00:47:23 -07001989 "attendeesOmitted": false, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001990 "kind": "calendar#event", # Type of the resource ("calendar#event").
1991 "locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
1992 "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -07001993 "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.
John Asmuth614db982014-04-24 15:46:26 -04001994 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False.
1995 "reminders": { # Information about the event's reminders for the authenticated user.
1996 "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.
1997 {
1998 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
1999 "method": "A String", # The method used by this reminder. Possible values are:
2000 # - "email" - Reminders are sent via email.
2001 # - "sms" - Reminders are sent via SMS.
2002 # - "popup" - Reminders are sent via a UI popup.
2003 },
2004 ],
2005 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
2006 },
2007 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
2008 "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.
2009 "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
Craig Citroe633be12015-03-02 13:40:36 -08002010 "timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
Craig Citro065b5302014-08-14 00:47:23 -07002011 "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.
John Asmuth614db982014-04-24 15:46:26 -04002012 },
2013 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
2014 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
2015 # - "opaque" - The event blocks time on the calendar. This is the default value.
2016 # - "transparent" - The event does not block time on the calendar.
2017 "privateCopy": false, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
2018 }</pre>
2019</div>
2020
2021<div class="method">
2022 <code class="details" id="watch">watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, privateExtendedProperty=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, sharedExtendedProperty=None, maxAttendees=None, syncToken=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)</code>
2023 <pre>Watch for changes to Events resources.
2024
2025Args:
2026 calendarId: string, Calendar identifier. (required)
2027 body: object, The request body. (required)
2028 The object takes the form of:
2029
2030{
2031 "resourceUri": "A String", # A version-specific identifier for the watched resource.
2032 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
2033 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
2034 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
2035 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
2036 "params": { # Additional parameters controlling delivery channel behavior. Optional.
2037 "a_key": "A String", # Declares a new parameter by name.
2038 },
2039 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
2040 "address": "A String", # The address where notifications are delivered for this channel.
2041 "type": "A String", # The type of delivery mechanism used for this channel.
2042 "id": "A String", # A UUID or similar unique string that identifies this channel.
2043 }
2044
2045 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
2046 Allowed values
Craig Citro065b5302014-08-14 00:47:23 -07002047 startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)
John Asmuth614db982014-04-24 15:46:26 -04002048 updated - Order by last modification time (ascending).
2049 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
2050 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
2051 privateExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
2052 pageToken: string, Token specifying which result page to return. Optional.
Craig Citro065b5302014-08-14 00:47:23 -07002053 updatedMin: string, Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
John Asmuth614db982014-04-24 15:46:26 -04002054 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.
Craig Citro065b5302014-08-14 00:47:23 -07002055 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.
2056 showDeleted: boolean, Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04002057 sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)
2058 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.
Craig Citro065b5302014-08-14 00:47:23 -07002059 syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
2060There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.
2061
2062These are:
2063- iCalUID
2064- orderBy
2065- privateExtendedProperty
2066- q
2067- sharedExtendedProperty
2068- timeMin
2069- timeMax
2070- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
2071Learn more about incremental synchronization.
2072Optional. The default is to return all entries.
2073 iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.
2074 maxResults: integer, Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
John Asmuth614db982014-04-24 15:46:26 -04002075 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
2076 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
2077 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
2078
2079Returns:
2080 An object of the form:
2081
2082 {
2083 "resourceUri": "A String", # A version-specific identifier for the watched resource.
2084 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
2085 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
2086 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
2087 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
2088 "params": { # Additional parameters controlling delivery channel behavior. Optional.
2089 "a_key": "A String", # Declares a new parameter by name.
2090 },
2091 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
2092 "address": "A String", # The address where notifications are delivered for this channel.
2093 "type": "A String", # The type of delivery mechanism used for this channel.
2094 "id": "A String", # A UUID or similar unique string that identifies this channel.
2095 }</pre>
2096</div>
2097
2098</body></html>