blob: 29574a1cd2493044260b9429f54982466168e91c [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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070078 <code><a href="#delete">delete(calendarId, eventId, sendNotifications=None, sendUpdates=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040079<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">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#import_">import_(calendarId, body=None, supportsAttachments=None, conferenceDataVersion=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<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">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#insert">insert(calendarId, body=None, sendNotifications=None, supportsAttachments=None, sendUpdates=None, conferenceDataVersion=None, maxAttendees=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040088<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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102 <code><a href="#move">move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400103<p class="firstline">Moves an event to another calendar, i.e. changes an event's organizer.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 <code><a href="#patch">patch(calendarId, eventId, body=None, sendNotifications=None, alwaysIncludeEmail=None, supportsAttachments=None, maxAttendees=None, conferenceDataVersion=None, sendUpdates=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400106<p class="firstline">Updates an event. This method supports patch semantics.</p>
107<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700108 <code><a href="#quickAdd">quickAdd(calendarId, text, sendNotifications=None, sendUpdates=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400109<p class="firstline">Creates an event based on a simple text string.</p>
110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700111 <code><a href="#update">update(calendarId, eventId, body=None, sendNotifications=None, alwaysIncludeEmail=None, supportsAttachments=None, maxAttendees=None, conferenceDataVersion=None, sendUpdates=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400112<p class="firstline">Updates an event.</p>
113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700114 <code><a href="#watch">watch(calendarId, body=None, 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>
John Asmuth614db982014-04-24 15:46:26 -0400115<p class="firstline">Watch for changes to Events resources.</p>
116<h3>Method Details</h3>
117<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700118 <code class="details" id="delete">delete(calendarId, eventId, sendNotifications=None, sendUpdates=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400119 <pre>Deletes an event.
120
121Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700122 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400123 eventId: string, Event identifier. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 sendNotifications: boolean, Deprecated. Please use sendUpdates instead.
125
126Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.
127 sendUpdates: string, Guests who should receive notifications about the deletion of the event.
128 Allowed values
129 all - Notifications are sent to all guests.
130 externalOnly - Notifications are sent to non-Google Calendar guests only.
131 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).
John Asmuth614db982014-04-24 15:46:26 -0400132</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</code>
137 <pre>Returns an event.
138
139Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700140 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400141 eventId: string, Event identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700142 alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
John Asmuth614db982014-04-24 15:46:26 -0400143 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
144 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.
145
146Returns:
147 An object of the form:
148
149 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700150 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
151 # In order to modify attachments the supportsAttachments request parameter should be set to true.
152 # There can be at most 25 attachments per event,
153 {
154 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
155 "title": "A String", # Attachment title.
156 "fileUrl": "A String", # URL link to the attachment.
157 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700158 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -0700159 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
160 "fileId": "A String", # ID of the attached file. Read-only.
161 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
162 },
163 ],
John Asmuth614db982014-04-24 15:46:26 -0400164 "creator": { # The creator of the event. Read-only.
165 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
166 "displayName": "A String", # The creator's name, if available.
167 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700168 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -0400169 },
Craig Citro065b5302014-08-14 00:47:23 -0700170 "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 -0400171 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
172 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700173 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700174 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -0400175 },
176 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -0700177 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -0400178 # - 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
179 # - the length of the ID must be between 5 and 1024 characters
180 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700181 # If you do not specify an ID, it will be automatically generated by the server.
182 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -0400183 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700184 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -0400185 {
186 "comment": "A String", # The attendee's response comment. Optional.
187 "displayName": "A String", # The attendee's name, if available. Optional.
188 "responseStatus": "A String", # The attendee's response status. Possible values are:
189 # - "needsAction" - The attendee has not responded to the invitation.
190 # - "declined" - The attendee has declined the invitation.
191 # - "tentative" - The attendee has tentatively accepted the invitation.
192 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700193 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700194 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700195 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700196 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400197 "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 -0700198 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -0700199 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700200 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -0400201 },
202 ],
203 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
204 "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 -0800205 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700206 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -0400207 },
208 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700209 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -0400210 "A String",
211 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700212 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
213 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -0400214 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
215 },
216 "etag": "A String", # ETag of the resource.
217 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700218 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -0400219 "gadget": { # A gadget that extends this event.
220 "preferences": { # Preferences.
221 "a_key": "A String", # The preference name and corresponding value.
222 },
223 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -0700224 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
225 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
226 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -0400227 "type": "A String", # The gadget's type.
228 "display": "A String", # The gadget's display mode. Optional. Possible values are:
229 # - "icon" - The gadget displays next to the event's title in the calendar view.
230 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -0700231 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -0400232 },
233 "status": "A String", # Status of the event. Optional. Possible values are:
234 # - "confirmed" - The event is confirmed. This is the default status.
235 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700236 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
237 # A cancelled status represents two different states depending on the event type:
238 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
239 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
240 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
241 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
242 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700243 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700244 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700245 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
246 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -0400247 "extendedProperties": { # Extended properties of the event.
248 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
249 "a_key": "A String", # The name of the shared property and the corresponding value.
250 },
251 "private": { # Properties that are private to the copy of the event that appears on this calendar.
252 "a_key": "A String", # The name of the private property and the corresponding value.
253 },
254 },
255 "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.
256 "sequence": 42, # Sequence number as per iCalendar.
257 "visibility": "default", # Visibility of the event. Optional. Possible values are:
258 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
259 # - "public" - The event is public and event details are visible to all readers of the calendar.
260 # - "private" - The event is private and only event attendees may view event details.
261 # - "confidential" - The event is private. This value is provided for compatibility reasons.
262 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
263 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
264 "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 -0800265 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700266 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -0400267 },
Craig Citro065b5302014-08-14 00:47:23 -0700268 "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 -0400269 "kind": "calendar#event", # Type of the resource ("calendar#event").
270 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800271 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700272 "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.
273 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -0400274 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700275 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -0400276 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700277 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700278 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -0400279 "method": "A String", # The method used by this reminder. Possible values are:
280 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -0400281 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700282 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -0400283 },
284 ],
285 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
286 },
287 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700288 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -0400289 "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 -0800290 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700291 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -0400292 },
293 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
294 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700295 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
296 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -0700297 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
298 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700299 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
300 # All of them must belong to the same conference.
301 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
302 {
303 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
304 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
305 # Optional.
306 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
307 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
308 # Optional.
309 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
310 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
311 # Optional.
312 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
313 # Format:
314 # - for video, http: or https: schema is required.
315 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
316 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
317 # - for more, http: or https: schema is required.
318 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
319 "A String",
320 ],
321 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
322 # Examples:
323 # - for video: meet.google.com/aaa-bbbb-ccc
324 # - for phone: +1 123 268 2601
325 # - for sip: 12345678@altostrat.com
326 # - for more: should not be filled
327 # Optional.
328 "entryPointType": "A String", # The type of the conference entry point.
329 # Possible values are:
330 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
331 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
332 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
333 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
334 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
335 # Calendar backend will populate this field only for EntryPointType.PHONE.
336 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
337 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
338 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
339 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
340 # Optional.
341 },
342 ],
343 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
344 "addOnParameters": { # Additional add-on specific data.
345 "parameters": {
346 "a_key": "A String",
347 },
348 },
349 },
350 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
351 "conferenceId": "A String", # The ID of the conference.
352 # Can be used by developers to keep track of conferences, should not be displayed to users.
353 # Values for solution types:
354 # - "eventHangout": unset.
355 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -0700356 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
357 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700358 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
359 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
360 "status": { # The status of the conference create request.
361 "statusCode": "A String", # The current status of the conference create request. Read-only.
362 # The possible values are:
363 # - "pending": the conference create request is still being processed.
364 # - "success": the conference create request succeeded, the entry points are populated.
365 # - "failure": the conference create request failed, there are no entry points.
366 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700367 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700368 "type": "A String", # The conference solution type.
369 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
370 # The possible values are:
371 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
372 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
373 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -0700374 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700375 },
376 "requestId": "A String", # The client-generated unique ID for this request.
377 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
378 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700379 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700380 # Unset for a conference with a failed create request.
381 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
382 "iconUri": "A String", # The user-visible icon for this solution.
383 "name": "A String", # The user-visible name of this solution. Not localized.
384 "key": { # The key which can uniquely identify the conference solution for this event.
385 "type": "A String", # The conference solution type.
386 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
387 # The possible values are:
388 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
389 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
390 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -0700391 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700392 },
393 },
394 "signature": "A String", # The signature of the conference data.
395 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
396 # Unset for a conference with a failed create request.
397 # Optional for a conference with a pending create request.
398 },
John Asmuth614db982014-04-24 15:46:26 -0400399 }</pre>
400</div>
401
402<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700403 <code class="details" id="import_">import_(calendarId, body=None, supportsAttachments=None, conferenceDataVersion=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400404 <pre>Imports an event. This operation is used to add a private copy of an existing event to a calendar.
405
406Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700407 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700408 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400409 The object takes the form of:
410
411{
Takashi Matsuo06694102015-09-11 13:55:40 -0700412 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
413 # In order to modify attachments the supportsAttachments request parameter should be set to true.
414 # There can be at most 25 attachments per event,
415 {
416 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
417 "title": "A String", # Attachment title.
418 "fileUrl": "A String", # URL link to the attachment.
419 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700420 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -0700421 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
422 "fileId": "A String", # ID of the attached file. Read-only.
423 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
424 },
425 ],
John Asmuth614db982014-04-24 15:46:26 -0400426 "creator": { # The creator of the event. Read-only.
427 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
428 "displayName": "A String", # The creator's name, if available.
429 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700430 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -0400431 },
Craig Citro065b5302014-08-14 00:47:23 -0700432 "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 -0400433 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
434 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700435 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700436 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -0400437 },
438 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -0700439 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -0400440 # - 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
441 # - the length of the ID must be between 5 and 1024 characters
442 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700443 # If you do not specify an ID, it will be automatically generated by the server.
444 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -0400445 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700446 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -0400447 {
448 "comment": "A String", # The attendee's response comment. Optional.
449 "displayName": "A String", # The attendee's name, if available. Optional.
450 "responseStatus": "A String", # The attendee's response status. Possible values are:
451 # - "needsAction" - The attendee has not responded to the invitation.
452 # - "declined" - The attendee has declined the invitation.
453 # - "tentative" - The attendee has tentatively accepted the invitation.
454 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700455 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700456 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700457 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700458 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400459 "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 -0700460 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -0700461 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700462 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -0400463 },
464 ],
465 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
466 "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 -0800467 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700468 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -0400469 },
470 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700471 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -0400472 "A String",
473 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700474 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
475 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -0400476 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
477 },
478 "etag": "A String", # ETag of the resource.
479 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700480 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -0400481 "gadget": { # A gadget that extends this event.
482 "preferences": { # Preferences.
483 "a_key": "A String", # The preference name and corresponding value.
484 },
485 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -0700486 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
487 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
488 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -0400489 "type": "A String", # The gadget's type.
490 "display": "A String", # The gadget's display mode. Optional. Possible values are:
491 # - "icon" - The gadget displays next to the event's title in the calendar view.
492 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -0700493 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -0400494 },
495 "status": "A String", # Status of the event. Optional. Possible values are:
496 # - "confirmed" - The event is confirmed. This is the default status.
497 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700498 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
499 # A cancelled status represents two different states depending on the event type:
500 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
501 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
502 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
503 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
504 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700505 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700506 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700507 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
508 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -0400509 "extendedProperties": { # Extended properties of the event.
510 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
511 "a_key": "A String", # The name of the shared property and the corresponding value.
512 },
513 "private": { # Properties that are private to the copy of the event that appears on this calendar.
514 "a_key": "A String", # The name of the private property and the corresponding value.
515 },
516 },
517 "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.
518 "sequence": 42, # Sequence number as per iCalendar.
519 "visibility": "default", # Visibility of the event. Optional. Possible values are:
520 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
521 # - "public" - The event is public and event details are visible to all readers of the calendar.
522 # - "private" - The event is private and only event attendees may view event details.
523 # - "confidential" - The event is private. This value is provided for compatibility reasons.
524 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
525 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
526 "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 -0800527 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700528 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -0400529 },
Craig Citro065b5302014-08-14 00:47:23 -0700530 "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 -0400531 "kind": "calendar#event", # Type of the resource ("calendar#event").
532 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800533 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700534 "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.
535 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -0400536 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700537 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -0400538 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700539 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700540 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -0400541 "method": "A String", # The method used by this reminder. Possible values are:
542 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -0400543 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700544 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -0400545 },
546 ],
547 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
548 },
549 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700550 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -0400551 "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 -0800552 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700553 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -0400554 },
555 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
556 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700557 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
558 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -0700559 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
560 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700561 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
562 # All of them must belong to the same conference.
563 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
564 {
565 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
566 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
567 # Optional.
568 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
569 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
570 # Optional.
571 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
572 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
573 # Optional.
574 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
575 # Format:
576 # - for video, http: or https: schema is required.
577 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
578 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
579 # - for more, http: or https: schema is required.
580 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
581 "A String",
582 ],
583 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
584 # Examples:
585 # - for video: meet.google.com/aaa-bbbb-ccc
586 # - for phone: +1 123 268 2601
587 # - for sip: 12345678@altostrat.com
588 # - for more: should not be filled
589 # Optional.
590 "entryPointType": "A String", # The type of the conference entry point.
591 # Possible values are:
592 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
593 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
594 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
595 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
596 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
597 # Calendar backend will populate this field only for EntryPointType.PHONE.
598 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
599 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
600 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
601 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
602 # Optional.
603 },
604 ],
605 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
606 "addOnParameters": { # Additional add-on specific data.
607 "parameters": {
608 "a_key": "A String",
609 },
610 },
611 },
612 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
613 "conferenceId": "A String", # The ID of the conference.
614 # Can be used by developers to keep track of conferences, should not be displayed to users.
615 # Values for solution types:
616 # - "eventHangout": unset.
617 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -0700618 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
619 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700620 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
621 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
622 "status": { # The status of the conference create request.
623 "statusCode": "A String", # The current status of the conference create request. Read-only.
624 # The possible values are:
625 # - "pending": the conference create request is still being processed.
626 # - "success": the conference create request succeeded, the entry points are populated.
627 # - "failure": the conference create request failed, there are no entry points.
628 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700629 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700630 "type": "A String", # The conference solution type.
631 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
632 # The possible values are:
633 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
634 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
635 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -0700636 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700637 },
638 "requestId": "A String", # The client-generated unique ID for this request.
639 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
640 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700641 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700642 # Unset for a conference with a failed create request.
643 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
644 "iconUri": "A String", # The user-visible icon for this solution.
645 "name": "A String", # The user-visible name of this solution. Not localized.
646 "key": { # The key which can uniquely identify the conference solution for this event.
647 "type": "A String", # The conference solution type.
648 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
649 # The possible values are:
650 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
651 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
652 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -0700653 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700654 },
655 },
656 "signature": "A String", # The signature of the conference data.
657 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
658 # Unset for a conference with a failed create request.
659 # Optional for a conference with a pending create request.
660 },
John Asmuth614db982014-04-24 15:46:26 -0400661 }
662
Takashi Matsuo06694102015-09-11 13:55:40 -0700663 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700664 conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
John Asmuth614db982014-04-24 15:46:26 -0400665
666Returns:
667 An object of the form:
668
669 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700670 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
671 # In order to modify attachments the supportsAttachments request parameter should be set to true.
672 # There can be at most 25 attachments per event,
673 {
674 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
675 "title": "A String", # Attachment title.
676 "fileUrl": "A String", # URL link to the attachment.
677 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700678 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -0700679 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
680 "fileId": "A String", # ID of the attached file. Read-only.
681 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
682 },
683 ],
John Asmuth614db982014-04-24 15:46:26 -0400684 "creator": { # The creator of the event. Read-only.
685 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
686 "displayName": "A String", # The creator's name, if available.
687 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700688 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -0400689 },
Craig Citro065b5302014-08-14 00:47:23 -0700690 "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 -0400691 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
692 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700693 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700694 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -0400695 },
696 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -0700697 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -0400698 # - 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
699 # - the length of the ID must be between 5 and 1024 characters
700 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700701 # If you do not specify an ID, it will be automatically generated by the server.
702 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -0400703 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700704 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -0400705 {
706 "comment": "A String", # The attendee's response comment. Optional.
707 "displayName": "A String", # The attendee's name, if available. Optional.
708 "responseStatus": "A String", # The attendee's response status. Possible values are:
709 # - "needsAction" - The attendee has not responded to the invitation.
710 # - "declined" - The attendee has declined the invitation.
711 # - "tentative" - The attendee has tentatively accepted the invitation.
712 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700713 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700714 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700715 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700716 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400717 "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 -0700718 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -0700719 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700720 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -0400721 },
722 ],
723 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
724 "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 -0800725 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700726 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -0400727 },
728 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700729 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -0400730 "A String",
731 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700732 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
733 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -0400734 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
735 },
736 "etag": "A String", # ETag of the resource.
737 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700738 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -0400739 "gadget": { # A gadget that extends this event.
740 "preferences": { # Preferences.
741 "a_key": "A String", # The preference name and corresponding value.
742 },
743 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -0700744 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
745 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
746 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -0400747 "type": "A String", # The gadget's type.
748 "display": "A String", # The gadget's display mode. Optional. Possible values are:
749 # - "icon" - The gadget displays next to the event's title in the calendar view.
750 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -0700751 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -0400752 },
753 "status": "A String", # Status of the event. Optional. Possible values are:
754 # - "confirmed" - The event is confirmed. This is the default status.
755 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700756 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
757 # A cancelled status represents two different states depending on the event type:
758 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
759 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
760 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
761 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
762 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700763 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700764 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700765 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
766 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -0400767 "extendedProperties": { # Extended properties of the event.
768 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
769 "a_key": "A String", # The name of the shared property and the corresponding value.
770 },
771 "private": { # Properties that are private to the copy of the event that appears on this calendar.
772 "a_key": "A String", # The name of the private property and the corresponding value.
773 },
774 },
775 "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.
776 "sequence": 42, # Sequence number as per iCalendar.
777 "visibility": "default", # Visibility of the event. Optional. Possible values are:
778 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
779 # - "public" - The event is public and event details are visible to all readers of the calendar.
780 # - "private" - The event is private and only event attendees may view event details.
781 # - "confidential" - The event is private. This value is provided for compatibility reasons.
782 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
783 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
784 "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 -0800785 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700786 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -0400787 },
Craig Citro065b5302014-08-14 00:47:23 -0700788 "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 -0400789 "kind": "calendar#event", # Type of the resource ("calendar#event").
790 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800791 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700792 "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.
793 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -0400794 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700795 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -0400796 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700797 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700798 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -0400799 "method": "A String", # The method used by this reminder. Possible values are:
800 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -0400801 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700802 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -0400803 },
804 ],
805 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
806 },
807 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700808 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -0400809 "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 -0800810 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700811 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -0400812 },
813 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
814 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700815 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
816 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -0700817 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
818 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700819 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
820 # All of them must belong to the same conference.
821 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
822 {
823 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
824 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
825 # Optional.
826 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
827 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
828 # Optional.
829 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
830 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
831 # Optional.
832 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
833 # Format:
834 # - for video, http: or https: schema is required.
835 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
836 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
837 # - for more, http: or https: schema is required.
838 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
839 "A String",
840 ],
841 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
842 # Examples:
843 # - for video: meet.google.com/aaa-bbbb-ccc
844 # - for phone: +1 123 268 2601
845 # - for sip: 12345678@altostrat.com
846 # - for more: should not be filled
847 # Optional.
848 "entryPointType": "A String", # The type of the conference entry point.
849 # Possible values are:
850 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
851 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
852 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
853 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
854 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
855 # Calendar backend will populate this field only for EntryPointType.PHONE.
856 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
857 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
858 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
859 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
860 # Optional.
861 },
862 ],
863 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
864 "addOnParameters": { # Additional add-on specific data.
865 "parameters": {
866 "a_key": "A String",
867 },
868 },
869 },
870 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
871 "conferenceId": "A String", # The ID of the conference.
872 # Can be used by developers to keep track of conferences, should not be displayed to users.
873 # Values for solution types:
874 # - "eventHangout": unset.
875 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -0700876 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
877 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700878 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
879 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
880 "status": { # The status of the conference create request.
881 "statusCode": "A String", # The current status of the conference create request. Read-only.
882 # The possible values are:
883 # - "pending": the conference create request is still being processed.
884 # - "success": the conference create request succeeded, the entry points are populated.
885 # - "failure": the conference create request failed, there are no entry points.
886 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700887 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700888 "type": "A String", # The conference solution type.
889 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
890 # The possible values are:
891 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
892 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
893 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -0700894 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700895 },
896 "requestId": "A String", # The client-generated unique ID for this request.
897 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
898 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700899 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700900 # Unset for a conference with a failed create request.
901 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
902 "iconUri": "A String", # The user-visible icon for this solution.
903 "name": "A String", # The user-visible name of this solution. Not localized.
904 "key": { # The key which can uniquely identify the conference solution for this event.
905 "type": "A String", # The conference solution type.
906 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
907 # The possible values are:
908 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
909 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
910 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -0700911 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700912 },
913 },
914 "signature": "A String", # The signature of the conference data.
915 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
916 # Unset for a conference with a failed create request.
917 # Optional for a conference with a pending create request.
918 },
John Asmuth614db982014-04-24 15:46:26 -0400919 }</pre>
920</div>
921
922<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700923 <code class="details" id="insert">insert(calendarId, body=None, sendNotifications=None, supportsAttachments=None, sendUpdates=None, conferenceDataVersion=None, maxAttendees=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400924 <pre>Creates an event.
925
926Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700927 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700928 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400929 The object takes the form of:
930
931{
Takashi Matsuo06694102015-09-11 13:55:40 -0700932 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
933 # In order to modify attachments the supportsAttachments request parameter should be set to true.
934 # There can be at most 25 attachments per event,
935 {
936 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
937 "title": "A String", # Attachment title.
938 "fileUrl": "A String", # URL link to the attachment.
939 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700940 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -0700941 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
942 "fileId": "A String", # ID of the attached file. Read-only.
943 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
944 },
945 ],
John Asmuth614db982014-04-24 15:46:26 -0400946 "creator": { # The creator of the event. Read-only.
947 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
948 "displayName": "A String", # The creator's name, if available.
949 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700950 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -0400951 },
Craig Citro065b5302014-08-14 00:47:23 -0700952 "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 -0400953 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
954 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700955 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700956 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -0400957 },
958 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -0700959 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -0400960 # - 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
961 # - the length of the ID must be between 5 and 1024 characters
962 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700963 # If you do not specify an ID, it will be automatically generated by the server.
964 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -0400965 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700966 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -0400967 {
968 "comment": "A String", # The attendee's response comment. Optional.
969 "displayName": "A String", # The attendee's name, if available. Optional.
970 "responseStatus": "A String", # The attendee's response status. Possible values are:
971 # - "needsAction" - The attendee has not responded to the invitation.
972 # - "declined" - The attendee has declined the invitation.
973 # - "tentative" - The attendee has tentatively accepted the invitation.
974 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700975 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700976 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700977 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700978 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -0400979 "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 -0700980 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -0700981 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700982 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -0400983 },
984 ],
985 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
986 "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 -0800987 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700988 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -0400989 },
990 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700991 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -0400992 "A String",
993 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700994 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
995 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -0400996 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
997 },
998 "etag": "A String", # ETag of the resource.
999 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07001000 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04001001 "gadget": { # A gadget that extends this event.
1002 "preferences": { # Preferences.
1003 "a_key": "A String", # The preference name and corresponding value.
1004 },
1005 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -07001006 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
1007 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
1008 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001009 "type": "A String", # The gadget's type.
1010 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1011 # - "icon" - The gadget displays next to the event's title in the calendar view.
1012 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -07001013 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001014 },
1015 "status": "A String", # Status of the event. Optional. Possible values are:
1016 # - "confirmed" - The event is confirmed. This is the default status.
1017 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001018 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
1019 # A cancelled status represents two different states depending on the event type:
1020 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
1021 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
1022 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
1023 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
1024 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -07001025 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -07001026 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07001027 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
1028 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04001029 "extendedProperties": { # Extended properties of the event.
1030 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1031 "a_key": "A String", # The name of the shared property and the corresponding value.
1032 },
1033 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1034 "a_key": "A String", # The name of the private property and the corresponding value.
1035 },
1036 },
1037 "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.
1038 "sequence": 42, # Sequence number as per iCalendar.
1039 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1040 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1041 # - "public" - The event is public and event details are visible to all readers of the calendar.
1042 # - "private" - The event is private and only event attendees may view event details.
1043 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1044 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1045 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1046 "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 -08001047 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001048 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04001049 },
Craig Citro065b5302014-08-14 00:47:23 -07001050 "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 -04001051 "kind": "calendar#event", # Type of the resource ("calendar#event").
1052 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001053 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001054 "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.
1055 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04001056 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -07001057 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -04001058 {
Takashi Matsuo06694102015-09-11 13:55:40 -07001059 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001060 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001061 "method": "A String", # The method used by this reminder. Possible values are:
1062 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04001063 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001064 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001065 },
1066 ],
1067 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1068 },
1069 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001070 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04001071 "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 -08001072 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001073 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04001074 },
1075 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1076 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001077 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
1078 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -07001079 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
1080 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001081 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
1082 # All of them must belong to the same conference.
1083 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
1084 {
1085 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
1086 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1087 # Optional.
1088 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
1089 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1090 # Optional.
1091 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
1092 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1093 # Optional.
1094 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
1095 # Format:
1096 # - for video, http: or https: schema is required.
1097 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
1098 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
1099 # - for more, http: or https: schema is required.
1100 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
1101 "A String",
1102 ],
1103 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
1104 # Examples:
1105 # - for video: meet.google.com/aaa-bbbb-ccc
1106 # - for phone: +1 123 268 2601
1107 # - for sip: 12345678@altostrat.com
1108 # - for more: should not be filled
1109 # Optional.
1110 "entryPointType": "A String", # The type of the conference entry point.
1111 # Possible values are:
1112 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
1113 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
1114 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
1115 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
1116 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
1117 # Calendar backend will populate this field only for EntryPointType.PHONE.
1118 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
1119 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1120 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
1121 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1122 # Optional.
1123 },
1124 ],
1125 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
1126 "addOnParameters": { # Additional add-on specific data.
1127 "parameters": {
1128 "a_key": "A String",
1129 },
1130 },
1131 },
1132 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
1133 "conferenceId": "A String", # The ID of the conference.
1134 # Can be used by developers to keep track of conferences, should not be displayed to users.
1135 # Values for solution types:
1136 # - "eventHangout": unset.
1137 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -07001138 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
1139 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001140 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
1141 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
1142 "status": { # The status of the conference create request.
1143 "statusCode": "A String", # The current status of the conference create request. Read-only.
1144 # The possible values are:
1145 # - "pending": the conference create request is still being processed.
1146 # - "success": the conference create request succeeded, the entry points are populated.
1147 # - "failure": the conference create request failed, there are no entry points.
1148 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001149 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001150 "type": "A String", # The conference solution type.
1151 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
1152 # The possible values are:
1153 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
1154 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
1155 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07001156 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001157 },
1158 "requestId": "A String", # The client-generated unique ID for this request.
1159 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
1160 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001161 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001162 # Unset for a conference with a failed create request.
1163 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
1164 "iconUri": "A String", # The user-visible icon for this solution.
1165 "name": "A String", # The user-visible name of this solution. Not localized.
1166 "key": { # The key which can uniquely identify the conference solution for this event.
1167 "type": "A String", # The conference solution type.
1168 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
1169 # The possible values are:
1170 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
1171 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
1172 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07001173 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001174 },
1175 },
1176 "signature": "A String", # The signature of the conference data.
1177 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
1178 # Unset for a conference with a failed create request.
1179 # Optional for a conference with a pending create request.
1180 },
John Asmuth614db982014-04-24 15:46:26 -04001181 }
1182
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001183 sendNotifications: boolean, Deprecated. Please use sendUpdates instead.
1184
1185Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.
Takashi Matsuo06694102015-09-11 13:55:40 -07001186 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001187 sendUpdates: string, Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.
1188 Allowed values
1189 all - Notifications are sent to all guests.
1190 externalOnly - Notifications are sent to non-Google Calendar guests only.
1191 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).
1192 conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
John Asmuth614db982014-04-24 15:46:26 -04001193 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.
1194
1195Returns:
1196 An object of the form:
1197
1198 {
Takashi Matsuo06694102015-09-11 13:55:40 -07001199 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
1200 # In order to modify attachments the supportsAttachments request parameter should be set to true.
1201 # There can be at most 25 attachments per event,
1202 {
1203 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
1204 "title": "A String", # Attachment title.
1205 "fileUrl": "A String", # URL link to the attachment.
1206 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001207 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -07001208 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
1209 "fileId": "A String", # ID of the attached file. Read-only.
1210 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
1211 },
1212 ],
John Asmuth614db982014-04-24 15:46:26 -04001213 "creator": { # The creator of the event. Read-only.
1214 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1215 "displayName": "A String", # The creator's name, if available.
1216 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001217 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04001218 },
Craig Citro065b5302014-08-14 00:47:23 -07001219 "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 -04001220 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1221 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -07001222 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001223 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04001224 },
1225 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -07001226 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -04001227 # - 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
1228 # - the length of the ID must be between 5 and 1024 characters
1229 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001230 # If you do not specify an ID, it will be automatically generated by the server.
1231 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04001232 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07001233 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -04001234 {
1235 "comment": "A String", # The attendee's response comment. Optional.
1236 "displayName": "A String", # The attendee's name, if available. Optional.
1237 "responseStatus": "A String", # The attendee's response status. Possible values are:
1238 # - "needsAction" - The attendee has not responded to the invitation.
1239 # - "declined" - The attendee has declined the invitation.
1240 # - "tentative" - The attendee has tentatively accepted the invitation.
1241 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001242 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001243 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001244 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001245 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001246 "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 -07001247 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -07001248 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001249 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -04001250 },
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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001255 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001258 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -04001259 "A String",
1260 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07001261 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
1262 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001263 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001267 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04001268 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001273 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
1274 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
1275 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001276 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001280 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001281 },
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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001285 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
1286 # A cancelled status represents two different states depending on the event type:
1287 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
1288 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
1289 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
1290 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
1291 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -07001292 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -07001293 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07001294 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
1295 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04001296 "extendedProperties": { # Extended properties of the event.
1297 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1298 "a_key": "A String", # The name of the shared property and the corresponding value.
1299 },
1300 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1301 "a_key": "A String", # The name of the private property and the corresponding value.
1302 },
1303 },
1304 "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.
1305 "sequence": 42, # Sequence number as per iCalendar.
1306 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1307 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1308 # - "public" - The event is public and event details are visible to all readers of the calendar.
1309 # - "private" - The event is private and only event attendees may view event details.
1310 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1311 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1312 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1313 "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 -08001314 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001315 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04001316 },
Craig Citro065b5302014-08-14 00:47:23 -07001317 "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 -04001318 "kind": "calendar#event", # Type of the resource ("calendar#event").
1319 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001320 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001321 "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.
1322 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04001323 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -07001324 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -04001325 {
Takashi Matsuo06694102015-09-11 13:55:40 -07001326 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001327 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001328 "method": "A String", # The method used by this reminder. Possible values are:
1329 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04001330 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001331 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001332 },
1333 ],
1334 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1335 },
1336 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001337 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04001338 "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 -08001339 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001340 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04001341 },
1342 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1343 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001344 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
1345 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -07001346 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
1347 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001348 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
1349 # All of them must belong to the same conference.
1350 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
1351 {
1352 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
1353 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1354 # Optional.
1355 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
1356 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1357 # Optional.
1358 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
1359 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1360 # Optional.
1361 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
1362 # Format:
1363 # - for video, http: or https: schema is required.
1364 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
1365 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
1366 # - for more, http: or https: schema is required.
1367 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
1368 "A String",
1369 ],
1370 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
1371 # Examples:
1372 # - for video: meet.google.com/aaa-bbbb-ccc
1373 # - for phone: +1 123 268 2601
1374 # - for sip: 12345678@altostrat.com
1375 # - for more: should not be filled
1376 # Optional.
1377 "entryPointType": "A String", # The type of the conference entry point.
1378 # Possible values are:
1379 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
1380 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
1381 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
1382 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
1383 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
1384 # Calendar backend will populate this field only for EntryPointType.PHONE.
1385 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
1386 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1387 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
1388 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1389 # Optional.
1390 },
1391 ],
1392 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
1393 "addOnParameters": { # Additional add-on specific data.
1394 "parameters": {
1395 "a_key": "A String",
1396 },
1397 },
1398 },
1399 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
1400 "conferenceId": "A String", # The ID of the conference.
1401 # Can be used by developers to keep track of conferences, should not be displayed to users.
1402 # Values for solution types:
1403 # - "eventHangout": unset.
1404 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -07001405 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
1406 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001407 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
1408 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
1409 "status": { # The status of the conference create request.
1410 "statusCode": "A String", # The current status of the conference create request. Read-only.
1411 # The possible values are:
1412 # - "pending": the conference create request is still being processed.
1413 # - "success": the conference create request succeeded, the entry points are populated.
1414 # - "failure": the conference create request failed, there are no entry points.
1415 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001416 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001417 "type": "A String", # The conference solution type.
1418 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
1419 # The possible values are:
1420 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
1421 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
1422 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07001423 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001424 },
1425 "requestId": "A String", # The client-generated unique ID for this request.
1426 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
1427 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001428 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001429 # Unset for a conference with a failed create request.
1430 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
1431 "iconUri": "A String", # The user-visible icon for this solution.
1432 "name": "A String", # The user-visible name of this solution. Not localized.
1433 "key": { # The key which can uniquely identify the conference solution for this event.
1434 "type": "A String", # The conference solution type.
1435 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
1436 # The possible values are:
1437 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
1438 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
1439 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07001440 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001441 },
1442 },
1443 "signature": "A String", # The signature of the conference data.
1444 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
1445 # Unset for a conference with a failed create request.
1446 # Optional for a conference with a pending create request.
1447 },
John Asmuth614db982014-04-24 15:46:26 -04001448 }</pre>
1449</div>
1450
1451<div class="method">
1452 <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>
1453 <pre>Returns instances of the specified recurring event.
1454
1455Args:
Takashi Matsuo06694102015-09-11 13:55:40 -07001456 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -04001457 eventId: string, Recurring event identifier. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -07001458 timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.
Craig Citro065b5302014-08-14 00:47:23 -07001459 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.
Dan O'Mearadd494642020-05-01 07:42:23 -07001460 alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
John Asmuth614db982014-04-24 15:46:26 -04001461 pageToken: string, Token specifying which result page to return. Optional.
1462 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 -07001463 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001464 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.
John Asmuth614db982014-04-24 15:46:26 -04001465 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
1466 originalStart: string, The original start time of the instance in the result. Optional.
1467
1468Returns:
1469 An object of the form:
1470
1471 {
Craig Citro065b5302014-08-14 00:47:23 -07001472 "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 -04001473 "kind": "calendar#events", # Type of the collection ("calendar#events").
Craig Citro065b5302014-08-14 00:47:23 -07001474 "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 -04001475 {
Takashi Matsuo06694102015-09-11 13:55:40 -07001476 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001477 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001478 "method": "A String", # The method used by this reminder. Possible values are:
1479 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04001480 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001481 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001482 },
1483 ],
1484 "description": "A String", # Description of the calendar. Read-only.
1485 "items": [ # List of events on the calendar.
1486 {
Takashi Matsuo06694102015-09-11 13:55:40 -07001487 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
1488 # In order to modify attachments the supportsAttachments request parameter should be set to true.
1489 # There can be at most 25 attachments per event,
1490 {
1491 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
1492 "title": "A String", # Attachment title.
1493 "fileUrl": "A String", # URL link to the attachment.
1494 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001495 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -07001496 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
1497 "fileId": "A String", # ID of the attached file. Read-only.
1498 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
1499 },
1500 ],
John Asmuth614db982014-04-24 15:46:26 -04001501 "creator": { # The creator of the event. Read-only.
1502 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1503 "displayName": "A String", # The creator's name, if available.
1504 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001505 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04001506 },
Craig Citro065b5302014-08-14 00:47:23 -07001507 "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 -04001508 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1509 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -07001510 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001511 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04001512 },
1513 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -07001514 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -04001515 # - 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
1516 # - the length of the ID must be between 5 and 1024 characters
1517 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001518 # If you do not specify an ID, it will be automatically generated by the server.
1519 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04001520 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07001521 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -04001522 {
1523 "comment": "A String", # The attendee's response comment. Optional.
1524 "displayName": "A String", # The attendee's name, if available. Optional.
1525 "responseStatus": "A String", # The attendee's response status. Possible values are:
1526 # - "needsAction" - The attendee has not responded to the invitation.
1527 # - "declined" - The attendee has declined the invitation.
1528 # - "tentative" - The attendee has tentatively accepted the invitation.
1529 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001530 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001531 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001532 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001533 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001534 "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 -07001535 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -07001536 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001537 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -04001538 },
1539 ],
1540 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1541 "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 -08001542 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001543 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04001544 },
1545 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07001546 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -04001547 "A String",
1548 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07001549 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
1550 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001551 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1552 },
1553 "etag": "A String", # ETag of the resource.
1554 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07001555 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04001556 "gadget": { # A gadget that extends this event.
1557 "preferences": { # Preferences.
1558 "a_key": "A String", # The preference name and corresponding value.
1559 },
1560 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -07001561 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
1562 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
1563 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001564 "type": "A String", # The gadget's type.
1565 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1566 # - "icon" - The gadget displays next to the event's title in the calendar view.
1567 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -07001568 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001569 },
1570 "status": "A String", # Status of the event. Optional. Possible values are:
1571 # - "confirmed" - The event is confirmed. This is the default status.
1572 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001573 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
1574 # A cancelled status represents two different states depending on the event type:
1575 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
1576 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
1577 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
1578 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
1579 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -07001580 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -07001581 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07001582 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
1583 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04001584 "extendedProperties": { # Extended properties of the event.
1585 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1586 "a_key": "A String", # The name of the shared property and the corresponding value.
1587 },
1588 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1589 "a_key": "A String", # The name of the private property and the corresponding value.
1590 },
1591 },
1592 "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.
1593 "sequence": 42, # Sequence number as per iCalendar.
1594 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1595 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1596 # - "public" - The event is public and event details are visible to all readers of the calendar.
1597 # - "private" - The event is private and only event attendees may view event details.
1598 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1599 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1600 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1601 "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 -08001602 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001603 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04001604 },
Craig Citro065b5302014-08-14 00:47:23 -07001605 "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 -04001606 "kind": "calendar#event", # Type of the resource ("calendar#event").
1607 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001608 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001609 "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.
1610 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04001611 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -07001612 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -04001613 {
Takashi Matsuo06694102015-09-11 13:55:40 -07001614 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001615 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001616 "method": "A String", # The method used by this reminder. Possible values are:
1617 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04001618 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001619 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001620 },
1621 ],
1622 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1623 },
1624 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001625 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04001626 "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 -08001627 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001628 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04001629 },
1630 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1631 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001632 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
1633 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -07001634 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
1635 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001636 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
1637 # All of them must belong to the same conference.
1638 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
1639 {
1640 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
1641 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1642 # Optional.
1643 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
1644 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1645 # Optional.
1646 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
1647 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1648 # Optional.
1649 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
1650 # Format:
1651 # - for video, http: or https: schema is required.
1652 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
1653 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
1654 # - for more, http: or https: schema is required.
1655 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
1656 "A String",
1657 ],
1658 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
1659 # Examples:
1660 # - for video: meet.google.com/aaa-bbbb-ccc
1661 # - for phone: +1 123 268 2601
1662 # - for sip: 12345678@altostrat.com
1663 # - for more: should not be filled
1664 # Optional.
1665 "entryPointType": "A String", # The type of the conference entry point.
1666 # Possible values are:
1667 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
1668 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
1669 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
1670 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
1671 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
1672 # Calendar backend will populate this field only for EntryPointType.PHONE.
1673 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
1674 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1675 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
1676 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1677 # Optional.
1678 },
1679 ],
1680 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
1681 "addOnParameters": { # Additional add-on specific data.
1682 "parameters": {
1683 "a_key": "A String",
1684 },
1685 },
1686 },
1687 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
1688 "conferenceId": "A String", # The ID of the conference.
1689 # Can be used by developers to keep track of conferences, should not be displayed to users.
1690 # Values for solution types:
1691 # - "eventHangout": unset.
1692 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -07001693 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
1694 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001695 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
1696 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
1697 "status": { # The status of the conference create request.
1698 "statusCode": "A String", # The current status of the conference create request. Read-only.
1699 # The possible values are:
1700 # - "pending": the conference create request is still being processed.
1701 # - "success": the conference create request succeeded, the entry points are populated.
1702 # - "failure": the conference create request failed, there are no entry points.
1703 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001704 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001705 "type": "A String", # The conference solution type.
1706 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
1707 # The possible values are:
1708 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
1709 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
1710 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07001711 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001712 },
1713 "requestId": "A String", # The client-generated unique ID for this request.
1714 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
1715 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001716 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001717 # Unset for a conference with a failed create request.
1718 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
1719 "iconUri": "A String", # The user-visible icon for this solution.
1720 "name": "A String", # The user-visible name of this solution. Not localized.
1721 "key": { # The key which can uniquely identify the conference solution for this event.
1722 "type": "A String", # The conference solution type.
1723 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
1724 # The possible values are:
1725 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
1726 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
1727 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07001728 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001729 },
1730 },
1731 "signature": "A String", # The signature of the conference data.
1732 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
1733 # Unset for a conference with a failed create request.
1734 # Optional for a conference with a pending create request.
1735 },
John Asmuth614db982014-04-24 15:46:26 -04001736 },
1737 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07001738 "updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04001739 "summary": "A String", # Title of the calendar. Read-only.
1740 "etag": "A String", # ETag of the collection.
1741 "timeZone": "A String", # The time zone of the calendar. Read-only.
1742 "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.
1743 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
1744 # - "none" - The user has no access.
1745 # - "freeBusyReader" - The user has read access to free/busy information.
1746 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
1747 # - "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.
1748 # - "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.
1749 }</pre>
1750</div>
1751
1752<div class="method">
1753 <code class="details" id="instances_next">instances_next(previous_request, previous_response)</code>
1754 <pre>Retrieves the next page of results.
1755
1756Args:
1757 previous_request: The request for the previous page. (required)
1758 previous_response: The response from the request for the previous page. (required)
1759
1760Returns:
1761 A request object that you can call 'execute()' on to request the next
1762 page. Returns None if there are no more items in the collection.
1763 </pre>
1764</div>
1765
1766<div class="method">
1767 <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>
1768 <pre>Returns events on the specified calendar.
1769
1770Args:
Takashi Matsuo06694102015-09-11 13:55:40 -07001771 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -04001772 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
1773 Allowed values
Craig Citro065b5302014-08-14 00:47:23 -07001774 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 -04001775 updated - Order by last modification time (ascending).
1776 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001777 timeMin: string, Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
John Asmuth614db982014-04-24 15:46:26 -04001778 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)
1779 pageToken: string, Token specifying which result page to return. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07001780 updatedMin: string, Lower bound for an event's last modification time (as a RFC3339 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 -04001781 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.
Dan O'Mearadd494642020-05-01 07:42:23 -07001782 alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
Craig Citro065b5302014-08-14 00:47:23 -07001783 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 -04001784 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)
1785 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 -07001786 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.
1787There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.
1788
1789These are:
1790- iCalUID
1791- orderBy
1792- privateExtendedProperty
1793- q
1794- sharedExtendedProperty
1795- timeMin
1796- timeMax
1797- 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.
1798Learn more about incremental synchronization.
1799Optional. The default is to return all entries.
1800 iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001801 maxResults: integer, Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001802 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
John Asmuth614db982014-04-24 15:46:26 -04001803 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
1804 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
1805
1806Returns:
1807 An object of the form:
1808
1809 {
Craig Citro065b5302014-08-14 00:47:23 -07001810 "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 -04001811 "kind": "calendar#events", # Type of the collection ("calendar#events").
Craig Citro065b5302014-08-14 00:47:23 -07001812 "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 -04001813 {
Takashi Matsuo06694102015-09-11 13:55:40 -07001814 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001815 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001816 "method": "A String", # The method used by this reminder. Possible values are:
1817 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04001818 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001819 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001820 },
1821 ],
1822 "description": "A String", # Description of the calendar. Read-only.
1823 "items": [ # List of events on the calendar.
1824 {
Takashi Matsuo06694102015-09-11 13:55:40 -07001825 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
1826 # In order to modify attachments the supportsAttachments request parameter should be set to true.
1827 # There can be at most 25 attachments per event,
1828 {
1829 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
1830 "title": "A String", # Attachment title.
1831 "fileUrl": "A String", # URL link to the attachment.
1832 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001833 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -07001834 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
1835 "fileId": "A String", # ID of the attached file. Read-only.
1836 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
1837 },
1838 ],
John Asmuth614db982014-04-24 15:46:26 -04001839 "creator": { # The creator of the event. Read-only.
1840 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1841 "displayName": "A String", # The creator's name, if available.
1842 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001843 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04001844 },
Craig Citro065b5302014-08-14 00:47:23 -07001845 "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 -04001846 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
1847 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -07001848 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001849 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04001850 },
1851 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -07001852 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -04001853 # - 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
1854 # - the length of the ID must be between 5 and 1024 characters
1855 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001856 # If you do not specify an ID, it will be automatically generated by the server.
1857 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04001858 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07001859 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -04001860 {
1861 "comment": "A String", # The attendee's response comment. Optional.
1862 "displayName": "A String", # The attendee's name, if available. Optional.
1863 "responseStatus": "A String", # The attendee's response status. Possible values are:
1864 # - "needsAction" - The attendee has not responded to the invitation.
1865 # - "declined" - The attendee has declined the invitation.
1866 # - "tentative" - The attendee has tentatively accepted the invitation.
1867 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001868 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001869 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001870 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001871 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04001872 "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 -07001873 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -07001874 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001875 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -04001876 },
1877 ],
1878 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
1879 "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 -08001880 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001881 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04001882 },
1883 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07001884 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -04001885 "A String",
1886 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07001887 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
1888 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001889 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
1890 },
1891 "etag": "A String", # ETag of the resource.
1892 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07001893 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04001894 "gadget": { # A gadget that extends this event.
1895 "preferences": { # Preferences.
1896 "a_key": "A String", # The preference name and corresponding value.
1897 },
1898 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -07001899 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
1900 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
1901 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001902 "type": "A String", # The gadget's type.
1903 "display": "A String", # The gadget's display mode. Optional. Possible values are:
1904 # - "icon" - The gadget displays next to the event's title in the calendar view.
1905 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -07001906 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04001907 },
1908 "status": "A String", # Status of the event. Optional. Possible values are:
1909 # - "confirmed" - The event is confirmed. This is the default status.
1910 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001911 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
1912 # A cancelled status represents two different states depending on the event type:
1913 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
1914 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
1915 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
1916 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
1917 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -07001918 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -07001919 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07001920 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
1921 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04001922 "extendedProperties": { # Extended properties of the event.
1923 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
1924 "a_key": "A String", # The name of the shared property and the corresponding value.
1925 },
1926 "private": { # Properties that are private to the copy of the event that appears on this calendar.
1927 "a_key": "A String", # The name of the private property and the corresponding value.
1928 },
1929 },
1930 "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.
1931 "sequence": 42, # Sequence number as per iCalendar.
1932 "visibility": "default", # Visibility of the event. Optional. Possible values are:
1933 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
1934 # - "public" - The event is public and event details are visible to all readers of the calendar.
1935 # - "private" - The event is private and only event attendees may view event details.
1936 # - "confidential" - The event is private. This value is provided for compatibility reasons.
1937 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
1938 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
1939 "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 -08001940 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001941 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04001942 },
Craig Citro065b5302014-08-14 00:47:23 -07001943 "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 -04001944 "kind": "calendar#event", # Type of the resource ("calendar#event").
1945 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001946 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001947 "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.
1948 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04001949 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -07001950 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -04001951 {
Takashi Matsuo06694102015-09-11 13:55:40 -07001952 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001953 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001954 "method": "A String", # The method used by this reminder. Possible values are:
1955 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04001956 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001957 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04001958 },
1959 ],
1960 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
1961 },
1962 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001963 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04001964 "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 -08001965 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07001966 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04001967 },
1968 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
1969 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001970 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
1971 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -07001972 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
1973 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001974 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
1975 # All of them must belong to the same conference.
1976 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
1977 {
1978 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
1979 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1980 # Optional.
1981 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
1982 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1983 # Optional.
1984 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
1985 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
1986 # Optional.
1987 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
1988 # Format:
1989 # - for video, http: or https: schema is required.
1990 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
1991 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
1992 # - for more, http: or https: schema is required.
1993 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
1994 "A String",
1995 ],
1996 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
1997 # Examples:
1998 # - for video: meet.google.com/aaa-bbbb-ccc
1999 # - for phone: +1 123 268 2601
2000 # - for sip: 12345678@altostrat.com
2001 # - for more: should not be filled
2002 # Optional.
2003 "entryPointType": "A String", # The type of the conference entry point.
2004 # Possible values are:
2005 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
2006 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
2007 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
2008 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
2009 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
2010 # Calendar backend will populate this field only for EntryPointType.PHONE.
2011 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
2012 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2013 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
2014 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2015 # Optional.
2016 },
2017 ],
2018 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
2019 "addOnParameters": { # Additional add-on specific data.
2020 "parameters": {
2021 "a_key": "A String",
2022 },
2023 },
2024 },
2025 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
2026 "conferenceId": "A String", # The ID of the conference.
2027 # Can be used by developers to keep track of conferences, should not be displayed to users.
2028 # Values for solution types:
2029 # - "eventHangout": unset.
2030 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -07002031 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
2032 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002033 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
2034 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2035 "status": { # The status of the conference create request.
2036 "statusCode": "A String", # The current status of the conference create request. Read-only.
2037 # The possible values are:
2038 # - "pending": the conference create request is still being processed.
2039 # - "success": the conference create request succeeded, the entry points are populated.
2040 # - "failure": the conference create request failed, there are no entry points.
2041 },
Dan O'Mearadd494642020-05-01 07:42:23 -07002042 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002043 "type": "A String", # The conference solution type.
2044 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
2045 # The possible values are:
2046 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
2047 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
2048 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07002049 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002050 },
2051 "requestId": "A String", # The client-generated unique ID for this request.
2052 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
2053 },
Dan O'Mearadd494642020-05-01 07:42:23 -07002054 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002055 # Unset for a conference with a failed create request.
2056 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2057 "iconUri": "A String", # The user-visible icon for this solution.
2058 "name": "A String", # The user-visible name of this solution. Not localized.
2059 "key": { # The key which can uniquely identify the conference solution for this event.
2060 "type": "A String", # The conference solution type.
2061 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
2062 # The possible values are:
2063 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
2064 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
2065 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07002066 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002067 },
2068 },
2069 "signature": "A String", # The signature of the conference data.
2070 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
2071 # Unset for a conference with a failed create request.
2072 # Optional for a conference with a pending create request.
2073 },
John Asmuth614db982014-04-24 15:46:26 -04002074 },
2075 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07002076 "updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04002077 "summary": "A String", # Title of the calendar. Read-only.
2078 "etag": "A String", # ETag of the collection.
2079 "timeZone": "A String", # The time zone of the calendar. Read-only.
2080 "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.
2081 "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
2082 # - "none" - The user has no access.
2083 # - "freeBusyReader" - The user has read access to free/busy information.
2084 # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
2085 # - "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.
2086 # - "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.
2087 }</pre>
2088</div>
2089
2090<div class="method">
2091 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
2092 <pre>Retrieves the next page of results.
2093
2094Args:
2095 previous_request: The request for the previous page. (required)
2096 previous_response: The response from the request for the previous page. (required)
2097
2098Returns:
2099 A request object that you can call 'execute()' on to request the next
2100 page. Returns None if there are no more items in the collection.
2101 </pre>
2102</div>
2103
2104<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002105 <code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)</code>
John Asmuth614db982014-04-24 15:46:26 -04002106 <pre>Moves an event to another calendar, i.e. changes an event's organizer.
2107
2108Args:
2109 calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)
2110 eventId: string, Event identifier. (required)
2111 destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002112 sendNotifications: boolean, Deprecated. Please use sendUpdates instead.
2113
2114Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.
2115 sendUpdates: string, Guests who should receive notifications about the change of the event's organizer.
2116 Allowed values
2117 all - Notifications are sent to all guests.
2118 externalOnly - Notifications are sent to non-Google Calendar guests only.
2119 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).
John Asmuth614db982014-04-24 15:46:26 -04002120
2121Returns:
2122 An object of the form:
2123
2124 {
Takashi Matsuo06694102015-09-11 13:55:40 -07002125 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
2126 # In order to modify attachments the supportsAttachments request parameter should be set to true.
2127 # There can be at most 25 attachments per event,
2128 {
2129 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
2130 "title": "A String", # Attachment title.
2131 "fileUrl": "A String", # URL link to the attachment.
2132 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002133 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -07002134 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
2135 "fileId": "A String", # ID of the attached file. Read-only.
2136 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
2137 },
2138 ],
John Asmuth614db982014-04-24 15:46:26 -04002139 "creator": { # The creator of the event. Read-only.
2140 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
2141 "displayName": "A String", # The creator's name, if available.
2142 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002143 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04002144 },
Craig Citro065b5302014-08-14 00:47:23 -07002145 "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 -04002146 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
2147 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -07002148 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002149 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04002150 },
2151 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -07002152 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -04002153 # - 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
2154 # - the length of the ID must be between 5 and 1024 characters
2155 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002156 # If you do not specify an ID, it will be automatically generated by the server.
2157 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04002158 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07002159 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -04002160 {
2161 "comment": "A String", # The attendee's response comment. Optional.
2162 "displayName": "A String", # The attendee's name, if available. Optional.
2163 "responseStatus": "A String", # The attendee's response status. Possible values are:
2164 # - "needsAction" - The attendee has not responded to the invitation.
2165 # - "declined" - The attendee has declined the invitation.
2166 # - "tentative" - The attendee has tentatively accepted the invitation.
2167 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07002168 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002169 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -07002170 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002171 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04002172 "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 -07002173 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -07002174 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002175 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -04002176 },
2177 ],
2178 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
2179 "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 -08002180 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002181 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04002182 },
2183 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07002184 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -04002185 "A String",
2186 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07002187 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
2188 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04002189 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
2190 },
2191 "etag": "A String", # ETag of the resource.
2192 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07002193 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04002194 "gadget": { # A gadget that extends this event.
2195 "preferences": { # Preferences.
2196 "a_key": "A String", # The preference name and corresponding value.
2197 },
2198 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -07002199 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
2200 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
2201 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04002202 "type": "A String", # The gadget's type.
2203 "display": "A String", # The gadget's display mode. Optional. Possible values are:
2204 # - "icon" - The gadget displays next to the event's title in the calendar view.
2205 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -07002206 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04002207 },
2208 "status": "A String", # Status of the event. Optional. Possible values are:
2209 # - "confirmed" - The event is confirmed. This is the default status.
2210 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002211 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
2212 # A cancelled status represents two different states depending on the event type:
2213 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
2214 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
2215 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
2216 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
2217 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -07002218 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -07002219 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07002220 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
2221 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04002222 "extendedProperties": { # Extended properties of the event.
2223 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
2224 "a_key": "A String", # The name of the shared property and the corresponding value.
2225 },
2226 "private": { # Properties that are private to the copy of the event that appears on this calendar.
2227 "a_key": "A String", # The name of the private property and the corresponding value.
2228 },
2229 },
2230 "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.
2231 "sequence": 42, # Sequence number as per iCalendar.
2232 "visibility": "default", # Visibility of the event. Optional. Possible values are:
2233 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
2234 # - "public" - The event is public and event details are visible to all readers of the calendar.
2235 # - "private" - The event is private and only event attendees may view event details.
2236 # - "confidential" - The event is private. This value is provided for compatibility reasons.
2237 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
2238 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
2239 "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 -08002240 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002241 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04002242 },
Craig Citro065b5302014-08-14 00:47:23 -07002243 "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 -04002244 "kind": "calendar#event", # Type of the resource ("calendar#event").
2245 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08002246 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002247 "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.
2248 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04002249 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -07002250 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -04002251 {
Takashi Matsuo06694102015-09-11 13:55:40 -07002252 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002253 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04002254 "method": "A String", # The method used by this reminder. Possible values are:
2255 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04002256 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002257 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04002258 },
2259 ],
2260 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
2261 },
2262 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002263 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04002264 "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 -08002265 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002266 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04002267 },
2268 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
2269 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002270 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
2271 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -07002272 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
2273 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002274 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
2275 # All of them must belong to the same conference.
2276 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2277 {
2278 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
2279 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2280 # Optional.
2281 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
2282 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2283 # Optional.
2284 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
2285 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2286 # Optional.
2287 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
2288 # Format:
2289 # - for video, http: or https: schema is required.
2290 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
2291 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
2292 # - for more, http: or https: schema is required.
2293 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
2294 "A String",
2295 ],
2296 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
2297 # Examples:
2298 # - for video: meet.google.com/aaa-bbbb-ccc
2299 # - for phone: +1 123 268 2601
2300 # - for sip: 12345678@altostrat.com
2301 # - for more: should not be filled
2302 # Optional.
2303 "entryPointType": "A String", # The type of the conference entry point.
2304 # Possible values are:
2305 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
2306 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
2307 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
2308 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
2309 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
2310 # Calendar backend will populate this field only for EntryPointType.PHONE.
2311 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
2312 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2313 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
2314 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2315 # Optional.
2316 },
2317 ],
2318 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
2319 "addOnParameters": { # Additional add-on specific data.
2320 "parameters": {
2321 "a_key": "A String",
2322 },
2323 },
2324 },
2325 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
2326 "conferenceId": "A String", # The ID of the conference.
2327 # Can be used by developers to keep track of conferences, should not be displayed to users.
2328 # Values for solution types:
2329 # - "eventHangout": unset.
2330 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -07002331 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
2332 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002333 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
2334 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2335 "status": { # The status of the conference create request.
2336 "statusCode": "A String", # The current status of the conference create request. Read-only.
2337 # The possible values are:
2338 # - "pending": the conference create request is still being processed.
2339 # - "success": the conference create request succeeded, the entry points are populated.
2340 # - "failure": the conference create request failed, there are no entry points.
2341 },
Dan O'Mearadd494642020-05-01 07:42:23 -07002342 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002343 "type": "A String", # The conference solution type.
2344 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
2345 # The possible values are:
2346 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
2347 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
2348 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07002349 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002350 },
2351 "requestId": "A String", # The client-generated unique ID for this request.
2352 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
2353 },
Dan O'Mearadd494642020-05-01 07:42:23 -07002354 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002355 # Unset for a conference with a failed create request.
2356 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2357 "iconUri": "A String", # The user-visible icon for this solution.
2358 "name": "A String", # The user-visible name of this solution. Not localized.
2359 "key": { # The key which can uniquely identify the conference solution for this event.
2360 "type": "A String", # The conference solution type.
2361 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
2362 # The possible values are:
2363 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
2364 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
2365 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07002366 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002367 },
2368 },
2369 "signature": "A String", # The signature of the conference data.
2370 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
2371 # Unset for a conference with a failed create request.
2372 # Optional for a conference with a pending create request.
2373 },
John Asmuth614db982014-04-24 15:46:26 -04002374 }</pre>
2375</div>
2376
2377<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07002378 <code class="details" id="patch">patch(calendarId, eventId, body=None, sendNotifications=None, alwaysIncludeEmail=None, supportsAttachments=None, maxAttendees=None, conferenceDataVersion=None, sendUpdates=None)</code>
John Asmuth614db982014-04-24 15:46:26 -04002379 <pre>Updates an event. This method supports patch semantics.
2380
2381Args:
Takashi Matsuo06694102015-09-11 13:55:40 -07002382 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -04002383 eventId: string, Event identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07002384 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -04002385 The object takes the form of:
2386
2387{
Takashi Matsuo06694102015-09-11 13:55:40 -07002388 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
2389 # In order to modify attachments the supportsAttachments request parameter should be set to true.
2390 # There can be at most 25 attachments per event,
2391 {
2392 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
2393 "title": "A String", # Attachment title.
2394 "fileUrl": "A String", # URL link to the attachment.
2395 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002396 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -07002397 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
2398 "fileId": "A String", # ID of the attached file. Read-only.
2399 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
2400 },
2401 ],
John Asmuth614db982014-04-24 15:46:26 -04002402 "creator": { # The creator of the event. Read-only.
2403 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
2404 "displayName": "A String", # The creator's name, if available.
2405 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002406 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04002407 },
Craig Citro065b5302014-08-14 00:47:23 -07002408 "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 -04002409 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
2410 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -07002411 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002412 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04002413 },
2414 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -07002415 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -04002416 # - 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
2417 # - the length of the ID must be between 5 and 1024 characters
2418 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002419 # If you do not specify an ID, it will be automatically generated by the server.
2420 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04002421 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07002422 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -04002423 {
2424 "comment": "A String", # The attendee's response comment. Optional.
2425 "displayName": "A String", # The attendee's name, if available. Optional.
2426 "responseStatus": "A String", # The attendee's response status. Possible values are:
2427 # - "needsAction" - The attendee has not responded to the invitation.
2428 # - "declined" - The attendee has declined the invitation.
2429 # - "tentative" - The attendee has tentatively accepted the invitation.
2430 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07002431 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002432 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -07002433 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002434 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04002435 "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 -07002436 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -07002437 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002438 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -04002439 },
2440 ],
2441 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
2442 "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 -08002443 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002444 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04002445 },
2446 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07002447 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -04002448 "A String",
2449 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07002450 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
2451 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04002452 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
2453 },
2454 "etag": "A String", # ETag of the resource.
2455 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07002456 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04002457 "gadget": { # A gadget that extends this event.
2458 "preferences": { # Preferences.
2459 "a_key": "A String", # The preference name and corresponding value.
2460 },
2461 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -07002462 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
2463 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
2464 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04002465 "type": "A String", # The gadget's type.
2466 "display": "A String", # The gadget's display mode. Optional. Possible values are:
2467 # - "icon" - The gadget displays next to the event's title in the calendar view.
2468 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -07002469 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04002470 },
2471 "status": "A String", # Status of the event. Optional. Possible values are:
2472 # - "confirmed" - The event is confirmed. This is the default status.
2473 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002474 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
2475 # A cancelled status represents two different states depending on the event type:
2476 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
2477 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
2478 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
2479 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
2480 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -07002481 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -07002482 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07002483 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
2484 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04002485 "extendedProperties": { # Extended properties of the event.
2486 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
2487 "a_key": "A String", # The name of the shared property and the corresponding value.
2488 },
2489 "private": { # Properties that are private to the copy of the event that appears on this calendar.
2490 "a_key": "A String", # The name of the private property and the corresponding value.
2491 },
2492 },
2493 "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.
2494 "sequence": 42, # Sequence number as per iCalendar.
2495 "visibility": "default", # Visibility of the event. Optional. Possible values are:
2496 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
2497 # - "public" - The event is public and event details are visible to all readers of the calendar.
2498 # - "private" - The event is private and only event attendees may view event details.
2499 # - "confidential" - The event is private. This value is provided for compatibility reasons.
2500 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
2501 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
2502 "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 -08002503 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002504 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04002505 },
Craig Citro065b5302014-08-14 00:47:23 -07002506 "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 -04002507 "kind": "calendar#event", # Type of the resource ("calendar#event").
2508 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08002509 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002510 "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.
2511 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04002512 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -07002513 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -04002514 {
Takashi Matsuo06694102015-09-11 13:55:40 -07002515 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002516 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04002517 "method": "A String", # The method used by this reminder. Possible values are:
2518 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04002519 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002520 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04002521 },
2522 ],
2523 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
2524 },
2525 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002526 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04002527 "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 -08002528 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002529 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04002530 },
2531 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
2532 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002533 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
2534 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -07002535 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
2536 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002537 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
2538 # All of them must belong to the same conference.
2539 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2540 {
2541 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
2542 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2543 # Optional.
2544 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
2545 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2546 # Optional.
2547 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
2548 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2549 # Optional.
2550 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
2551 # Format:
2552 # - for video, http: or https: schema is required.
2553 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
2554 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
2555 # - for more, http: or https: schema is required.
2556 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
2557 "A String",
2558 ],
2559 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
2560 # Examples:
2561 # - for video: meet.google.com/aaa-bbbb-ccc
2562 # - for phone: +1 123 268 2601
2563 # - for sip: 12345678@altostrat.com
2564 # - for more: should not be filled
2565 # Optional.
2566 "entryPointType": "A String", # The type of the conference entry point.
2567 # Possible values are:
2568 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
2569 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
2570 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
2571 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
2572 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
2573 # Calendar backend will populate this field only for EntryPointType.PHONE.
2574 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
2575 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2576 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
2577 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2578 # Optional.
2579 },
2580 ],
2581 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
2582 "addOnParameters": { # Additional add-on specific data.
2583 "parameters": {
2584 "a_key": "A String",
2585 },
2586 },
2587 },
2588 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
2589 "conferenceId": "A String", # The ID of the conference.
2590 # Can be used by developers to keep track of conferences, should not be displayed to users.
2591 # Values for solution types:
2592 # - "eventHangout": unset.
2593 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -07002594 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
2595 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002596 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
2597 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2598 "status": { # The status of the conference create request.
2599 "statusCode": "A String", # The current status of the conference create request. Read-only.
2600 # The possible values are:
2601 # - "pending": the conference create request is still being processed.
2602 # - "success": the conference create request succeeded, the entry points are populated.
2603 # - "failure": the conference create request failed, there are no entry points.
2604 },
Dan O'Mearadd494642020-05-01 07:42:23 -07002605 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002606 "type": "A String", # The conference solution type.
2607 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
2608 # The possible values are:
2609 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
2610 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
2611 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07002612 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002613 },
2614 "requestId": "A String", # The client-generated unique ID for this request.
2615 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
2616 },
Dan O'Mearadd494642020-05-01 07:42:23 -07002617 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002618 # Unset for a conference with a failed create request.
2619 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2620 "iconUri": "A String", # The user-visible icon for this solution.
2621 "name": "A String", # The user-visible name of this solution. Not localized.
2622 "key": { # The key which can uniquely identify the conference solution for this event.
2623 "type": "A String", # The conference solution type.
2624 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
2625 # The possible values are:
2626 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
2627 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
2628 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07002629 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002630 },
2631 },
2632 "signature": "A String", # The signature of the conference data.
2633 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
2634 # Unset for a conference with a failed create request.
2635 # Optional for a conference with a pending create request.
2636 },
John Asmuth614db982014-04-24 15:46:26 -04002637 }
2638
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002639 sendNotifications: boolean, Deprecated. Please use sendUpdates instead.
2640
2641Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
Dan O'Mearadd494642020-05-01 07:42:23 -07002642 alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
Takashi Matsuo06694102015-09-11 13:55:40 -07002643 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04002644 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002645 conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
2646 sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).
2647 Allowed values
2648 all - Notifications are sent to all guests.
2649 externalOnly - Notifications are sent to non-Google Calendar guests only.
2650 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).
John Asmuth614db982014-04-24 15:46:26 -04002651
2652Returns:
2653 An object of the form:
2654
2655 {
Takashi Matsuo06694102015-09-11 13:55:40 -07002656 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
2657 # In order to modify attachments the supportsAttachments request parameter should be set to true.
2658 # There can be at most 25 attachments per event,
2659 {
2660 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
2661 "title": "A String", # Attachment title.
2662 "fileUrl": "A String", # URL link to the attachment.
2663 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002664 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -07002665 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
2666 "fileId": "A String", # ID of the attached file. Read-only.
2667 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
2668 },
2669 ],
John Asmuth614db982014-04-24 15:46:26 -04002670 "creator": { # The creator of the event. Read-only.
2671 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
2672 "displayName": "A String", # The creator's name, if available.
2673 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002674 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04002675 },
Craig Citro065b5302014-08-14 00:47:23 -07002676 "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 -04002677 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
2678 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -07002679 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002680 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04002681 },
2682 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -07002683 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -04002684 # - 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
2685 # - the length of the ID must be between 5 and 1024 characters
2686 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002687 # If you do not specify an ID, it will be automatically generated by the server.
2688 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04002689 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07002690 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -04002691 {
2692 "comment": "A String", # The attendee's response comment. Optional.
2693 "displayName": "A String", # The attendee's name, if available. Optional.
2694 "responseStatus": "A String", # The attendee's response status. Possible values are:
2695 # - "needsAction" - The attendee has not responded to the invitation.
2696 # - "declined" - The attendee has declined the invitation.
2697 # - "tentative" - The attendee has tentatively accepted the invitation.
2698 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07002699 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002700 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -07002701 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002702 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04002703 "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 -07002704 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -07002705 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002706 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -04002707 },
2708 ],
2709 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
2710 "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 -08002711 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002712 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04002713 },
2714 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07002715 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -04002716 "A String",
2717 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07002718 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
2719 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04002720 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
2721 },
2722 "etag": "A String", # ETag of the resource.
2723 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07002724 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04002725 "gadget": { # A gadget that extends this event.
2726 "preferences": { # Preferences.
2727 "a_key": "A String", # The preference name and corresponding value.
2728 },
2729 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -07002730 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
2731 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
2732 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04002733 "type": "A String", # The gadget's type.
2734 "display": "A String", # The gadget's display mode. Optional. Possible values are:
2735 # - "icon" - The gadget displays next to the event's title in the calendar view.
2736 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -07002737 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04002738 },
2739 "status": "A String", # Status of the event. Optional. Possible values are:
2740 # - "confirmed" - The event is confirmed. This is the default status.
2741 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002742 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
2743 # A cancelled status represents two different states depending on the event type:
2744 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
2745 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
2746 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
2747 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
2748 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -07002749 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -07002750 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07002751 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
2752 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04002753 "extendedProperties": { # Extended properties of the event.
2754 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
2755 "a_key": "A String", # The name of the shared property and the corresponding value.
2756 },
2757 "private": { # Properties that are private to the copy of the event that appears on this calendar.
2758 "a_key": "A String", # The name of the private property and the corresponding value.
2759 },
2760 },
2761 "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.
2762 "sequence": 42, # Sequence number as per iCalendar.
2763 "visibility": "default", # Visibility of the event. Optional. Possible values are:
2764 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
2765 # - "public" - The event is public and event details are visible to all readers of the calendar.
2766 # - "private" - The event is private and only event attendees may view event details.
2767 # - "confidential" - The event is private. This value is provided for compatibility reasons.
2768 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
2769 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
2770 "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 -08002771 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002772 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04002773 },
Craig Citro065b5302014-08-14 00:47:23 -07002774 "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 -04002775 "kind": "calendar#event", # Type of the resource ("calendar#event").
2776 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08002777 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002778 "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.
2779 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04002780 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -07002781 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -04002782 {
Takashi Matsuo06694102015-09-11 13:55:40 -07002783 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002784 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04002785 "method": "A String", # The method used by this reminder. Possible values are:
2786 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04002787 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002788 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04002789 },
2790 ],
2791 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
2792 },
2793 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002794 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04002795 "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 -08002796 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002797 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04002798 },
2799 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
2800 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002801 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
2802 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -07002803 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
2804 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002805 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
2806 # All of them must belong to the same conference.
2807 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2808 {
2809 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
2810 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2811 # Optional.
2812 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
2813 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2814 # Optional.
2815 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
2816 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2817 # Optional.
2818 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
2819 # Format:
2820 # - for video, http: or https: schema is required.
2821 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
2822 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
2823 # - for more, http: or https: schema is required.
2824 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
2825 "A String",
2826 ],
2827 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
2828 # Examples:
2829 # - for video: meet.google.com/aaa-bbbb-ccc
2830 # - for phone: +1 123 268 2601
2831 # - for sip: 12345678@altostrat.com
2832 # - for more: should not be filled
2833 # Optional.
2834 "entryPointType": "A String", # The type of the conference entry point.
2835 # Possible values are:
2836 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
2837 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
2838 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
2839 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
2840 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
2841 # Calendar backend will populate this field only for EntryPointType.PHONE.
2842 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
2843 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2844 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
2845 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
2846 # Optional.
2847 },
2848 ],
2849 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
2850 "addOnParameters": { # Additional add-on specific data.
2851 "parameters": {
2852 "a_key": "A String",
2853 },
2854 },
2855 },
2856 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
2857 "conferenceId": "A String", # The ID of the conference.
2858 # Can be used by developers to keep track of conferences, should not be displayed to users.
2859 # Values for solution types:
2860 # - "eventHangout": unset.
2861 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -07002862 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
2863 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002864 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
2865 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2866 "status": { # The status of the conference create request.
2867 "statusCode": "A String", # The current status of the conference create request. Read-only.
2868 # The possible values are:
2869 # - "pending": the conference create request is still being processed.
2870 # - "success": the conference create request succeeded, the entry points are populated.
2871 # - "failure": the conference create request failed, there are no entry points.
2872 },
Dan O'Mearadd494642020-05-01 07:42:23 -07002873 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002874 "type": "A String", # The conference solution type.
2875 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
2876 # The possible values are:
2877 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
2878 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
2879 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07002880 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002881 },
2882 "requestId": "A String", # The client-generated unique ID for this request.
2883 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
2884 },
Dan O'Mearadd494642020-05-01 07:42:23 -07002885 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002886 # Unset for a conference with a failed create request.
2887 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
2888 "iconUri": "A String", # The user-visible icon for this solution.
2889 "name": "A String", # The user-visible name of this solution. Not localized.
2890 "key": { # The key which can uniquely identify the conference solution for this event.
2891 "type": "A String", # The conference solution type.
2892 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
2893 # The possible values are:
2894 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
2895 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
2896 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07002897 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002898 },
2899 },
2900 "signature": "A String", # The signature of the conference data.
2901 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
2902 # Unset for a conference with a failed create request.
2903 # Optional for a conference with a pending create request.
2904 },
John Asmuth614db982014-04-24 15:46:26 -04002905 }</pre>
2906</div>
2907
2908<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002909 <code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None, sendUpdates=None)</code>
John Asmuth614db982014-04-24 15:46:26 -04002910 <pre>Creates an event based on a simple text string.
2911
2912Args:
Takashi Matsuo06694102015-09-11 13:55:40 -07002913 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -04002914 text: string, The text describing the event to be created. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002915 sendNotifications: boolean, Deprecated. Please use sendUpdates instead.
2916
2917Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.
2918 sendUpdates: string, Guests who should receive notifications about the creation of the new event.
2919 Allowed values
2920 all - Notifications are sent to all guests.
2921 externalOnly - Notifications are sent to non-Google Calendar guests only.
2922 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).
John Asmuth614db982014-04-24 15:46:26 -04002923
2924Returns:
2925 An object of the form:
2926
2927 {
Takashi Matsuo06694102015-09-11 13:55:40 -07002928 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
2929 # In order to modify attachments the supportsAttachments request parameter should be set to true.
2930 # There can be at most 25 attachments per event,
2931 {
2932 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
2933 "title": "A String", # Attachment title.
2934 "fileUrl": "A String", # URL link to the attachment.
2935 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002936 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -07002937 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
2938 "fileId": "A String", # ID of the attached file. Read-only.
2939 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
2940 },
2941 ],
John Asmuth614db982014-04-24 15:46:26 -04002942 "creator": { # The creator of the event. Read-only.
2943 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
2944 "displayName": "A String", # The creator's name, if available.
2945 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002946 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04002947 },
Craig Citro065b5302014-08-14 00:47:23 -07002948 "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 -04002949 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
2950 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -07002951 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002952 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04002953 },
2954 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -07002955 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -04002956 # - 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
2957 # - the length of the ID must be between 5 and 1024 characters
2958 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002959 # If you do not specify an ID, it will be automatically generated by the server.
2960 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04002961 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07002962 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -04002963 {
2964 "comment": "A String", # The attendee's response comment. Optional.
2965 "displayName": "A String", # The attendee's name, if available. Optional.
2966 "responseStatus": "A String", # The attendee's response status. Possible values are:
2967 # - "needsAction" - The attendee has not responded to the invitation.
2968 # - "declined" - The attendee has declined the invitation.
2969 # - "tentative" - The attendee has tentatively accepted the invitation.
2970 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07002971 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002972 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -07002973 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002974 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04002975 "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 -07002976 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -07002977 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07002978 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -04002979 },
2980 ],
2981 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
2982 "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 -08002983 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07002984 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04002985 },
2986 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07002987 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -04002988 "A String",
2989 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07002990 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
2991 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04002992 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
2993 },
2994 "etag": "A String", # ETag of the resource.
2995 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07002996 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04002997 "gadget": { # A gadget that extends this event.
2998 "preferences": { # Preferences.
2999 "a_key": "A String", # The preference name and corresponding value.
3000 },
3001 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -07003002 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
3003 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
3004 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04003005 "type": "A String", # The gadget's type.
3006 "display": "A String", # The gadget's display mode. Optional. Possible values are:
3007 # - "icon" - The gadget displays next to the event's title in the calendar view.
3008 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -07003009 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04003010 },
3011 "status": "A String", # Status of the event. Optional. Possible values are:
3012 # - "confirmed" - The event is confirmed. This is the default status.
3013 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003014 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
3015 # A cancelled status represents two different states depending on the event type:
3016 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
3017 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
3018 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
3019 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
3020 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -07003021 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -07003022 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07003023 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
3024 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04003025 "extendedProperties": { # Extended properties of the event.
3026 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
3027 "a_key": "A String", # The name of the shared property and the corresponding value.
3028 },
3029 "private": { # Properties that are private to the copy of the event that appears on this calendar.
3030 "a_key": "A String", # The name of the private property and the corresponding value.
3031 },
3032 },
3033 "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.
3034 "sequence": 42, # Sequence number as per iCalendar.
3035 "visibility": "default", # Visibility of the event. Optional. Possible values are:
3036 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
3037 # - "public" - The event is public and event details are visible to all readers of the calendar.
3038 # - "private" - The event is private and only event attendees may view event details.
3039 # - "confidential" - The event is private. This value is provided for compatibility reasons.
3040 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
3041 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
3042 "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 -08003043 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07003044 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04003045 },
Craig Citro065b5302014-08-14 00:47:23 -07003046 "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 -04003047 "kind": "calendar#event", # Type of the resource ("calendar#event").
3048 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08003049 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003050 "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.
3051 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04003052 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -07003053 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -04003054 {
Takashi Matsuo06694102015-09-11 13:55:40 -07003055 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003056 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04003057 "method": "A String", # The method used by this reminder. Possible values are:
3058 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04003059 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003060 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04003061 },
3062 ],
3063 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
3064 },
3065 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003066 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04003067 "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 -08003068 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07003069 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04003070 },
3071 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
3072 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003073 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
3074 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -07003075 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
3076 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003077 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
3078 # All of them must belong to the same conference.
3079 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
3080 {
3081 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
3082 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3083 # Optional.
3084 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
3085 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3086 # Optional.
3087 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
3088 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3089 # Optional.
3090 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
3091 # Format:
3092 # - for video, http: or https: schema is required.
3093 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
3094 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
3095 # - for more, http: or https: schema is required.
3096 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
3097 "A String",
3098 ],
3099 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
3100 # Examples:
3101 # - for video: meet.google.com/aaa-bbbb-ccc
3102 # - for phone: +1 123 268 2601
3103 # - for sip: 12345678@altostrat.com
3104 # - for more: should not be filled
3105 # Optional.
3106 "entryPointType": "A String", # The type of the conference entry point.
3107 # Possible values are:
3108 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
3109 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
3110 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
3111 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
3112 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
3113 # Calendar backend will populate this field only for EntryPointType.PHONE.
3114 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
3115 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3116 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
3117 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3118 # Optional.
3119 },
3120 ],
3121 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
3122 "addOnParameters": { # Additional add-on specific data.
3123 "parameters": {
3124 "a_key": "A String",
3125 },
3126 },
3127 },
3128 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
3129 "conferenceId": "A String", # The ID of the conference.
3130 # Can be used by developers to keep track of conferences, should not be displayed to users.
3131 # Values for solution types:
3132 # - "eventHangout": unset.
3133 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -07003134 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
3135 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003136 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
3137 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
3138 "status": { # The status of the conference create request.
3139 "statusCode": "A String", # The current status of the conference create request. Read-only.
3140 # The possible values are:
3141 # - "pending": the conference create request is still being processed.
3142 # - "success": the conference create request succeeded, the entry points are populated.
3143 # - "failure": the conference create request failed, there are no entry points.
3144 },
Dan O'Mearadd494642020-05-01 07:42:23 -07003145 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003146 "type": "A String", # The conference solution type.
3147 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
3148 # The possible values are:
3149 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
3150 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
3151 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07003152 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003153 },
3154 "requestId": "A String", # The client-generated unique ID for this request.
3155 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
3156 },
Dan O'Mearadd494642020-05-01 07:42:23 -07003157 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003158 # Unset for a conference with a failed create request.
3159 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
3160 "iconUri": "A String", # The user-visible icon for this solution.
3161 "name": "A String", # The user-visible name of this solution. Not localized.
3162 "key": { # The key which can uniquely identify the conference solution for this event.
3163 "type": "A String", # The conference solution type.
3164 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
3165 # The possible values are:
3166 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
3167 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
3168 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07003169 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003170 },
3171 },
3172 "signature": "A String", # The signature of the conference data.
3173 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
3174 # Unset for a conference with a failed create request.
3175 # Optional for a conference with a pending create request.
3176 },
John Asmuth614db982014-04-24 15:46:26 -04003177 }</pre>
3178</div>
3179
3180<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07003181 <code class="details" id="update">update(calendarId, eventId, body=None, sendNotifications=None, alwaysIncludeEmail=None, supportsAttachments=None, maxAttendees=None, conferenceDataVersion=None, sendUpdates=None)</code>
John Asmuth614db982014-04-24 15:46:26 -04003182 <pre>Updates an event.
3183
3184Args:
Takashi Matsuo06694102015-09-11 13:55:40 -07003185 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -04003186 eventId: string, Event identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07003187 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -04003188 The object takes the form of:
3189
3190{
Takashi Matsuo06694102015-09-11 13:55:40 -07003191 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
3192 # In order to modify attachments the supportsAttachments request parameter should be set to true.
3193 # There can be at most 25 attachments per event,
3194 {
3195 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
3196 "title": "A String", # Attachment title.
3197 "fileUrl": "A String", # URL link to the attachment.
3198 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003199 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -07003200 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
3201 "fileId": "A String", # ID of the attached file. Read-only.
3202 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
3203 },
3204 ],
John Asmuth614db982014-04-24 15:46:26 -04003205 "creator": { # The creator of the event. Read-only.
3206 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
3207 "displayName": "A String", # The creator's name, if available.
3208 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003209 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04003210 },
Craig Citro065b5302014-08-14 00:47:23 -07003211 "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 -04003212 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
3213 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -07003214 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003215 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04003216 },
3217 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -07003218 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -04003219 # - 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
3220 # - the length of the ID must be between 5 and 1024 characters
3221 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07003222 # If you do not specify an ID, it will be automatically generated by the server.
3223 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04003224 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07003225 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -04003226 {
3227 "comment": "A String", # The attendee's response comment. Optional.
3228 "displayName": "A String", # The attendee's name, if available. Optional.
3229 "responseStatus": "A String", # The attendee's response status. Possible values are:
3230 # - "needsAction" - The attendee has not responded to the invitation.
3231 # - "declined" - The attendee has declined the invitation.
3232 # - "tentative" - The attendee has tentatively accepted the invitation.
3233 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07003234 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003235 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -07003236 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003237 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04003238 "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 -07003239 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -07003240 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003241 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -04003242 },
3243 ],
3244 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
3245 "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 -08003246 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07003247 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04003248 },
3249 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07003250 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -04003251 "A String",
3252 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07003253 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
3254 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04003255 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
3256 },
3257 "etag": "A String", # ETag of the resource.
3258 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07003259 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04003260 "gadget": { # A gadget that extends this event.
3261 "preferences": { # Preferences.
3262 "a_key": "A String", # The preference name and corresponding value.
3263 },
3264 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -07003265 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
3266 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
3267 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04003268 "type": "A String", # The gadget's type.
3269 "display": "A String", # The gadget's display mode. Optional. Possible values are:
3270 # - "icon" - The gadget displays next to the event's title in the calendar view.
3271 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -07003272 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04003273 },
3274 "status": "A String", # Status of the event. Optional. Possible values are:
3275 # - "confirmed" - The event is confirmed. This is the default status.
3276 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003277 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
3278 # A cancelled status represents two different states depending on the event type:
3279 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
3280 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
3281 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
3282 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
3283 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -07003284 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -07003285 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07003286 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
3287 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04003288 "extendedProperties": { # Extended properties of the event.
3289 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
3290 "a_key": "A String", # The name of the shared property and the corresponding value.
3291 },
3292 "private": { # Properties that are private to the copy of the event that appears on this calendar.
3293 "a_key": "A String", # The name of the private property and the corresponding value.
3294 },
3295 },
3296 "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.
3297 "sequence": 42, # Sequence number as per iCalendar.
3298 "visibility": "default", # Visibility of the event. Optional. Possible values are:
3299 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
3300 # - "public" - The event is public and event details are visible to all readers of the calendar.
3301 # - "private" - The event is private and only event attendees may view event details.
3302 # - "confidential" - The event is private. This value is provided for compatibility reasons.
3303 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
3304 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
3305 "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 -08003306 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07003307 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04003308 },
Craig Citro065b5302014-08-14 00:47:23 -07003309 "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 -04003310 "kind": "calendar#event", # Type of the resource ("calendar#event").
3311 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08003312 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003313 "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.
3314 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04003315 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -07003316 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -04003317 {
Takashi Matsuo06694102015-09-11 13:55:40 -07003318 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003319 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04003320 "method": "A String", # The method used by this reminder. Possible values are:
3321 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04003322 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003323 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04003324 },
3325 ],
3326 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
3327 },
3328 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003329 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04003330 "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 -08003331 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07003332 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04003333 },
3334 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
3335 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003336 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
3337 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -07003338 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
3339 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003340 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
3341 # All of them must belong to the same conference.
3342 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
3343 {
3344 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
3345 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3346 # Optional.
3347 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
3348 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3349 # Optional.
3350 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
3351 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3352 # Optional.
3353 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
3354 # Format:
3355 # - for video, http: or https: schema is required.
3356 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
3357 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
3358 # - for more, http: or https: schema is required.
3359 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
3360 "A String",
3361 ],
3362 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
3363 # Examples:
3364 # - for video: meet.google.com/aaa-bbbb-ccc
3365 # - for phone: +1 123 268 2601
3366 # - for sip: 12345678@altostrat.com
3367 # - for more: should not be filled
3368 # Optional.
3369 "entryPointType": "A String", # The type of the conference entry point.
3370 # Possible values are:
3371 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
3372 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
3373 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
3374 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
3375 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
3376 # Calendar backend will populate this field only for EntryPointType.PHONE.
3377 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
3378 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3379 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
3380 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3381 # Optional.
3382 },
3383 ],
3384 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
3385 "addOnParameters": { # Additional add-on specific data.
3386 "parameters": {
3387 "a_key": "A String",
3388 },
3389 },
3390 },
3391 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
3392 "conferenceId": "A String", # The ID of the conference.
3393 # Can be used by developers to keep track of conferences, should not be displayed to users.
3394 # Values for solution types:
3395 # - "eventHangout": unset.
3396 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -07003397 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
3398 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003399 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
3400 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
3401 "status": { # The status of the conference create request.
3402 "statusCode": "A String", # The current status of the conference create request. Read-only.
3403 # The possible values are:
3404 # - "pending": the conference create request is still being processed.
3405 # - "success": the conference create request succeeded, the entry points are populated.
3406 # - "failure": the conference create request failed, there are no entry points.
3407 },
Dan O'Mearadd494642020-05-01 07:42:23 -07003408 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003409 "type": "A String", # The conference solution type.
3410 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
3411 # The possible values are:
3412 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
3413 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
3414 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07003415 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003416 },
3417 "requestId": "A String", # The client-generated unique ID for this request.
3418 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
3419 },
Dan O'Mearadd494642020-05-01 07:42:23 -07003420 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003421 # Unset for a conference with a failed create request.
3422 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
3423 "iconUri": "A String", # The user-visible icon for this solution.
3424 "name": "A String", # The user-visible name of this solution. Not localized.
3425 "key": { # The key which can uniquely identify the conference solution for this event.
3426 "type": "A String", # The conference solution type.
3427 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
3428 # The possible values are:
3429 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
3430 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
3431 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07003432 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003433 },
3434 },
3435 "signature": "A String", # The signature of the conference data.
3436 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
3437 # Unset for a conference with a failed create request.
3438 # Optional for a conference with a pending create request.
3439 },
John Asmuth614db982014-04-24 15:46:26 -04003440 }
3441
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003442 sendNotifications: boolean, Deprecated. Please use sendUpdates instead.
3443
3444Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
Dan O'Mearadd494642020-05-01 07:42:23 -07003445 alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
Takashi Matsuo06694102015-09-11 13:55:40 -07003446 supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04003447 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003448 conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
3449 sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).
3450 Allowed values
3451 all - Notifications are sent to all guests.
3452 externalOnly - Notifications are sent to non-Google Calendar guests only.
3453 none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).
John Asmuth614db982014-04-24 15:46:26 -04003454
3455Returns:
3456 An object of the form:
3457
3458 {
Takashi Matsuo06694102015-09-11 13:55:40 -07003459 "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.
3460 # In order to modify attachments the supportsAttachments request parameter should be set to true.
3461 # There can be at most 25 attachments per event,
3462 {
3463 "mimeType": "A String", # Internet media type (MIME type) of the attachment.
3464 "title": "A String", # Attachment title.
3465 "fileUrl": "A String", # URL link to the attachment.
3466 # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003467 # Required when adding an attachment.
Takashi Matsuo06694102015-09-11 13:55:40 -07003468 "iconLink": "A String", # URL link to the attachment's icon. Read-only.
3469 "fileId": "A String", # ID of the attached file. Read-only.
3470 # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
3471 },
3472 ],
John Asmuth614db982014-04-24 15:46:26 -04003473 "creator": { # The creator of the event. Read-only.
3474 "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
3475 "displayName": "A String", # The creator's name, if available.
3476 "email": "A String", # The creator's email address, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003477 "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04003478 },
Craig Citro065b5302014-08-14 00:47:23 -07003479 "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 -04003480 "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
3481 "displayName": "A String", # The organizer's name, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -07003482 "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003483 "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
John Asmuth614db982014-04-24 15:46:26 -04003484 },
3485 "summary": "A String", # Title of the event.
Takashi Matsuo06694102015-09-11 13:55:40 -07003486 "id": "A String", # Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
John Asmuth614db982014-04-24 15:46:26 -04003487 # - 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
3488 # - the length of the ID must be between 5 and 1024 characters
3489 # - 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.
Takashi Matsuo06694102015-09-11 13:55:40 -07003490 # If you do not specify an ID, it will be automatically generated by the server.
3491 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04003492 "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07003493 "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
John Asmuth614db982014-04-24 15:46:26 -04003494 {
3495 "comment": "A String", # The attendee's response comment. Optional.
3496 "displayName": "A String", # The attendee's name, if available. Optional.
3497 "responseStatus": "A String", # The attendee's response status. Possible values are:
3498 # - "needsAction" - The attendee has not responded to the invitation.
3499 # - "declined" - The attendee has declined the invitation.
3500 # - "tentative" - The attendee has tentatively accepted the invitation.
3501 # - "accepted" - The attendee has accepted the invitation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -07003502 "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003503 "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
Craig Citro0e5b9bf2014-10-15 10:26:14 -07003504 "additionalGuests": 0, # Number of additional guests. Optional. The default is 0.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003505 "resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
John Asmuth614db982014-04-24 15:46:26 -04003506 "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 -07003507 "optional": false, # Whether this is an optional attendee. Optional. The default is False.
Takashi Matsuo06694102015-09-11 13:55:40 -07003508 "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003509 # Required when adding an attendee.
John Asmuth614db982014-04-24 15:46:26 -04003510 },
3511 ],
3512 "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
3513 "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 -08003514 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07003515 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04003516 },
3517 "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -07003518 "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
John Asmuth614db982014-04-24 15:46:26 -04003519 "A String",
3520 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07003521 "source": { # Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
3522 "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04003523 "title": "A String", # Title of the source; for example a title of a web page or an email subject.
3524 },
3525 "etag": "A String", # ETag of the resource.
3526 "location": "A String", # Geographic location of the event as free-form text. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07003527 "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04003528 "gadget": { # A gadget that extends this event.
3529 "preferences": { # Preferences.
3530 "a_key": "A String", # The preference name and corresponding value.
3531 },
3532 "title": "A String", # The gadget's title.
Takashi Matsuo06694102015-09-11 13:55:40 -07003533 "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.
3534 "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.
3535 "link": "A String", # The gadget's URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04003536 "type": "A String", # The gadget's type.
3537 "display": "A String", # The gadget's display mode. Optional. Possible values are:
3538 # - "icon" - The gadget displays next to the event's title in the calendar view.
3539 # - "chip" - The gadget displays when the event is clicked.
Takashi Matsuo06694102015-09-11 13:55:40 -07003540 "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.
John Asmuth614db982014-04-24 15:46:26 -04003541 },
3542 "status": "A String", # Status of the event. Optional. Possible values are:
3543 # - "confirmed" - The event is confirmed. This is the default status.
3544 # - "tentative" - The event is tentatively confirmed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003545 # - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.
3546 # A cancelled status represents two different states depending on the event type:
3547 # - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.
3548 # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
3549 # - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
3550 # Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
3551 # If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
Takashi Matsuo06694102015-09-11 13:55:40 -07003552 "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -07003553 "description": "A String", # Description of the event. Can contain HTML. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07003554 "iCalUID": "A String", # Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
3555 # Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
John Asmuth614db982014-04-24 15:46:26 -04003556 "extendedProperties": { # Extended properties of the event.
3557 "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
3558 "a_key": "A String", # The name of the shared property and the corresponding value.
3559 },
3560 "private": { # Properties that are private to the copy of the event that appears on this calendar.
3561 "a_key": "A String", # The name of the private property and the corresponding value.
3562 },
3563 },
3564 "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.
3565 "sequence": 42, # Sequence number as per iCalendar.
3566 "visibility": "default", # Visibility of the event. Optional. Possible values are:
3567 # - "default" - Uses the default visibility for events on the calendar. This is the default value.
3568 # - "public" - The event is public and event details are visible to all readers of the calendar.
3569 # - "private" - The event is private and only event attendees may view event details.
3570 # - "confidential" - The event is private. This value is provided for compatibility reasons.
3571 "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
3572 "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
3573 "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 -08003574 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07003575 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04003576 },
Craig Citro065b5302014-08-14 00:47:23 -07003577 "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 -04003578 "kind": "calendar#event", # Type of the resource ("calendar#event").
3579 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08003580 "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003581 "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.
3582 "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.
John Asmuth614db982014-04-24 15:46:26 -04003583 "reminders": { # Information about the event's reminders for the authenticated user.
Takashi Matsuo06694102015-09-11 13:55:40 -07003584 "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. The maximum number of override reminders is 5.
John Asmuth614db982014-04-24 15:46:26 -04003585 {
Takashi Matsuo06694102015-09-11 13:55:40 -07003586 "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003587 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04003588 "method": "A String", # The method used by this reminder. Possible values are:
3589 # - "email" - Reminders are sent via email.
John Asmuth614db982014-04-24 15:46:26 -04003590 # - "popup" - Reminders are sent via a UI popup.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003591 # Required when adding a reminder.
John Asmuth614db982014-04-24 15:46:26 -04003592 },
3593 ],
3594 "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
3595 },
3596 "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003597 "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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
John Asmuth614db982014-04-24 15:46:26 -04003598 "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 -08003599 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -07003600 "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
John Asmuth614db982014-04-24 15:46:26 -04003601 },
3602 "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
3603 "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003604 # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
3605 # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
Dan O'Mearadd494642020-05-01 07:42:23 -07003606 "privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
3607 "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003608 "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.
3609 # All of them must belong to the same conference.
3610 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
3611 {
3612 "password": "A String", # The password to access the conference. The maximum length is 128 characters.
3613 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3614 # Optional.
3615 "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.
3616 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3617 # Optional.
3618 "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.
3619 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3620 # Optional.
3621 "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.
3622 # Format:
3623 # - for video, http: or https: schema is required.
3624 # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
3625 # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
3626 # - for more, http: or https: schema is required.
3627 "entryPointFeatures": [ # Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
3628 "A String",
3629 ],
3630 "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.
3631 # Examples:
3632 # - for video: meet.google.com/aaa-bbbb-ccc
3633 # - for phone: +1 123 268 2601
3634 # - for sip: 12345678@altostrat.com
3635 # - for more: should not be filled
3636 # Optional.
3637 "entryPointType": "A String", # The type of the conference entry point.
3638 # Possible values are:
3639 # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
3640 # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
3641 # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
3642 # - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
3643 "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
3644 # Calendar backend will populate this field only for EntryPointType.PHONE.
3645 "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.
3646 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3647 "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.
3648 # When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
3649 # Optional.
3650 },
3651 ],
3652 "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
3653 "addOnParameters": { # Additional add-on specific data.
3654 "parameters": {
3655 "a_key": "A String",
3656 },
3657 },
3658 },
3659 "notes": "A String", # Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
3660 "conferenceId": "A String", # The ID of the conference.
3661 # Can be used by developers to keep track of conferences, should not be displayed to users.
3662 # Values for solution types:
3663 # - "eventHangout": unset.
3664 # - "eventNamedHangout": the name of the Hangout.
Dan O'Mearadd494642020-05-01 07:42:23 -07003665 # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
3666 # - "addOn": defined by 3P conference provider. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003667 "createRequest": { # A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
3668 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
3669 "status": { # The status of the conference create request.
3670 "statusCode": "A String", # The current status of the conference create request. Read-only.
3671 # The possible values are:
3672 # - "pending": the conference create request is still being processed.
3673 # - "success": the conference create request succeeded, the entry points are populated.
3674 # - "failure": the conference create request failed, there are no entry points.
3675 },
Dan O'Mearadd494642020-05-01 07:42:23 -07003676 "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003677 "type": "A String", # The conference solution type.
3678 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
3679 # The possible values are:
3680 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
3681 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
3682 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07003683 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003684 },
3685 "requestId": "A String", # The client-generated unique ID for this request.
3686 # Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
3687 },
Dan O'Mearadd494642020-05-01 07:42:23 -07003688 "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003689 # Unset for a conference with a failed create request.
3690 # Either conferenceSolution and at least one entryPoint, or createRequest is required.
3691 "iconUri": "A String", # The user-visible icon for this solution.
3692 "name": "A String", # The user-visible name of this solution. Not localized.
3693 "key": { # The key which can uniquely identify the conference solution for this event.
3694 "type": "A String", # The conference solution type.
3695 # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.
3696 # The possible values are:
3697 # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
3698 # - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
3699 # - "hangoutsMeet" for Hangouts Meet (http://meet.google.com)
Dan O'Mearadd494642020-05-01 07:42:23 -07003700 # - "addOn" for 3P conference providers
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003701 },
3702 },
3703 "signature": "A String", # The signature of the conference data.
3704 # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
3705 # Unset for a conference with a failed create request.
3706 # Optional for a conference with a pending create request.
3707 },
John Asmuth614db982014-04-24 15:46:26 -04003708 }</pre>
3709</div>
3710
3711<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07003712 <code class="details" id="watch">watch(calendarId, body=None, 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>
John Asmuth614db982014-04-24 15:46:26 -04003713 <pre>Watch for changes to Events resources.
3714
3715Args:
Takashi Matsuo06694102015-09-11 13:55:40 -07003716 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07003717 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -04003718 The object takes the form of:
3719
3720{
3721 "resourceUri": "A String", # A version-specific identifier for the watched resource.
Dan O'Mearadd494642020-05-01 07:42:23 -07003722 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
John Asmuth614db982014-04-24 15:46:26 -04003723 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
3724 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
3725 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
3726 "params": { # Additional parameters controlling delivery channel behavior. Optional.
3727 "a_key": "A String", # Declares a new parameter by name.
3728 },
3729 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
3730 "address": "A String", # The address where notifications are delivered for this channel.
3731 "type": "A String", # The type of delivery mechanism used for this channel.
3732 "id": "A String", # A UUID or similar unique string that identifies this channel.
3733 }
3734
3735 orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
3736 Allowed values
Craig Citro065b5302014-08-14 00:47:23 -07003737 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 -04003738 updated - Order by last modification time (ascending).
3739 showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003740 timeMin: string, Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
John Asmuth614db982014-04-24 15:46:26 -04003741 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)
3742 pageToken: string, Token specifying which result page to return. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -07003743 updatedMin: string, Lower bound for an event's last modification time (as a RFC3339 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 -04003744 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.
Dan O'Mearadd494642020-05-01 07:42:23 -07003745 alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
Craig Citro065b5302014-08-14 00:47:23 -07003746 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 -04003747 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)
3748 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 -07003749 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.
3750There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.
3751
3752These are:
3753- iCalUID
3754- orderBy
3755- privateExtendedProperty
3756- q
3757- sharedExtendedProperty
3758- timeMin
3759- timeMax
3760- 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.
3761Learn more about incremental synchronization.
3762Optional. The default is to return all entries.
3763 iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04003764 maxResults: integer, Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07003765 timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
John Asmuth614db982014-04-24 15:46:26 -04003766 q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
3767 timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
3768
3769Returns:
3770 An object of the form:
3771
3772 {
3773 "resourceUri": "A String", # A version-specific identifier for the watched resource.
Dan O'Mearadd494642020-05-01 07:42:23 -07003774 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
John Asmuth614db982014-04-24 15:46:26 -04003775 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
3776 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
3777 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
3778 "params": { # Additional parameters controlling delivery channel behavior. Optional.
3779 "a_key": "A String", # Declares a new parameter by name.
3780 },
3781 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
3782 "address": "A String", # The address where notifications are delivered for this channel.
3783 "type": "A String", # The type of delivery mechanism used for this channel.
3784 "id": "A String", # A UUID or similar unique string that identifies this channel.
3785 }</pre>
3786</div>
3787
3788</body></html>