| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 81 | <code><a href="#delete">delete(calendarId, eventId, sendUpdates=None, sendNotifications=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Deletes an event.</p> |
| 83 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 84 | <code><a href="#get">get(calendarId, eventId, timeZone=None, alwaysIncludeEmail=None, maxAttendees=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 85 | <p class="firstline">Returns an event.</p> |
| 86 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 87 | <code><a href="#import_">import_(calendarId, body=None, conferenceDataVersion=None, supportsAttachments=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 88 | <p class="firstline">Imports an event. This operation is used to add a private copy of an existing event to a calendar.</p> |
| 89 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 90 | <code><a href="#insert">insert(calendarId, body=None, sendUpdates=None, supportsAttachments=None, maxAttendees=None, sendNotifications=None, conferenceDataVersion=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 91 | <p class="firstline">Creates an event.</p> |
| 92 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 93 | <code><a href="#instances">instances(calendarId, eventId, timeZone=None, pageToken=None, alwaysIncludeEmail=None, maxResults=None, timeMax=None, timeMin=None, originalStart=None, showDeleted=None, maxAttendees=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 94 | <p class="firstline">Returns instances of the specified recurring event.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#instances_next">instances_next(previous_request, previous_response)</a></code></p> |
| 97 | <p class="firstline">Retrieves the next page of results.</p> |
| 98 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 99 | <code><a href="#list">list(calendarId, sharedExtendedProperty=None, updatedMin=None, showHiddenInvitations=None, orderBy=None, showDeleted=None, iCalUID=None, singleEvents=None, pageToken=None, timeZone=None, timeMax=None, maxResults=None, q=None, alwaysIncludeEmail=None, maxAttendees=None, syncToken=None, timeMin=None, privateExtendedProperty=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 100 | <p class="firstline">Returns events on the specified calendar.</p> |
| 101 | <p class="toc_element"> |
| 102 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 103 | <p class="firstline">Retrieves the next page of results.</p> |
| 104 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 105 | <code><a href="#move">move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 106 | <p class="firstline">Moves an event to another calendar, i.e. changes an event's organizer.</p> |
| 107 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 108 | <code><a href="#patch">patch(calendarId, eventId, body=None, maxAttendees=None, supportsAttachments=None, alwaysIncludeEmail=None, sendUpdates=None, sendNotifications=None, conferenceDataVersion=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 109 | <p class="firstline">Updates an event. This method supports patch semantics.</p> |
| 110 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 111 | <code><a href="#quickAdd">quickAdd(calendarId, text, sendUpdates=None, sendNotifications=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 112 | <p class="firstline">Creates an event based on a simple text string.</p> |
| 113 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 114 | <code><a href="#update">update(calendarId, eventId, body=None, supportsAttachments=None, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None, sendUpdates=None, conferenceDataVersion=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 115 | <p class="firstline">Updates an event.</p> |
| 116 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 117 | <code><a href="#watch">watch(calendarId, body=None, sharedExtendedProperty=None, q=None, timeMin=None, showDeleted=None, privateExtendedProperty=None, iCalUID=None, timeMax=None, updatedMin=None, singleEvents=None, syncToken=None, alwaysIncludeEmail=None, timeZone=None, pageToken=None, showHiddenInvitations=None, orderBy=None, maxResults=None, maxAttendees=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 118 | <p class="firstline">Watch for changes to Events resources.</p> |
| 119 | <h3>Method Details</h3> |
| 120 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 121 | <code class="details" id="close">close()</code> |
| 122 | <pre>Close httplib2 connections.</pre> |
| 123 | </div> |
| 124 | |
| 125 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 126 | <code class="details" id="delete">delete(calendarId, eventId, sendUpdates=None, sendNotifications=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 127 | <pre>Deletes an event. |
| 128 | |
| 129 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 130 | 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 Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 131 | eventId: string, Event identifier. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 132 | sendUpdates: string, Guests who should receive notifications about the deletion of the event. |
| 133 | Allowed values |
| 134 | all - Notifications are sent to all guests. |
| 135 | externalOnly - Notifications are sent to non-Google Calendar guests only. |
| 136 | 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). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 137 | sendNotifications: boolean, Deprecated. Please use sendUpdates instead. |
| 138 | |
| 139 | Whether 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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 140 | </pre> |
| 141 | </div> |
| 142 | |
| 143 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 144 | <code class="details" id="get">get(calendarId, eventId, timeZone=None, alwaysIncludeEmail=None, maxAttendees=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 145 | <pre>Returns an event. |
| 146 | |
| 147 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 148 | 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 Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 149 | eventId: string, Event identifier. (required) |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 150 | timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 151 | 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). |
| 152 | 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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 153 | |
| 154 | Returns: |
| 155 | An object of the form: |
| 156 | |
| 157 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 158 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 159 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 160 | # There can be at most 25 attachments per event, |
| 161 | { |
| 162 | "title": "A String", # Attachment title. |
| 163 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| 164 | "fileUrl": "A String", # URL link to the attachment. |
| 165 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 166 | # Required when adding an attachment. |
| 167 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 168 | "fileId": "A String", # ID of the attached file. Read-only. |
| 169 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| 170 | }, |
| 171 | ], |
| 172 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 173 | "title": "A String", # The gadget's title. Deprecated. |
| 174 | "preferences": { # Preferences. |
| 175 | "a_key": "A String", # The preference name and corresponding value. |
| 176 | }, |
| 177 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 178 | "type": "A String", # The gadget's type. Deprecated. |
| 179 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 180 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 181 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 182 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 183 | # - "chip" - The gadget displays when the event is clicked. |
| 184 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 185 | }, |
| 186 | "summary": "A String", # Title of the event. |
| 187 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 188 | { |
| 189 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 190 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 191 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 192 | "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. |
| 193 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 194 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 195 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 196 | "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. |
| 197 | # Required when adding an attendee. |
| 198 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 199 | # - "needsAction" - The attendee has not responded to the invitation. |
| 200 | # - "declined" - The attendee has declined the invitation. |
| 201 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 202 | # - "accepted" - The attendee has accepted the invitation. |
| 203 | "comment": "A String", # The attendee's response comment. Optional. |
| 204 | }, |
| 205 | ], |
| 206 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 207 | "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. |
| 208 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 209 | "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. |
| 210 | }, |
| 211 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 212 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 213 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 214 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 215 | "method": "A String", # The method used by this reminder. Possible values are: |
| 216 | # - "email" - Reminders are sent via email. |
| 217 | # - "popup" - Reminders are sent via a UI popup. |
| 218 | # Required when adding a reminder. |
| 219 | "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). |
| 220 | # Required when adding a reminder. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 221 | }, |
| 222 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 223 | }, |
| 224 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| 225 | "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. |
| 226 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 227 | "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. |
| 228 | }, |
| 229 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 230 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 231 | "extendedProperties": { # Extended properties of the event. |
| 232 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 233 | "a_key": "A String", # The name of the private property and the corresponding value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 234 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 235 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 236 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 237 | }, |
| 238 | }, |
| 239 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 240 | # - "confirmed" - The event is confirmed. This is the default status. |
| 241 | # - "tentative" - The event is tentatively confirmed. |
| 242 | # - "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. |
| 243 | # A cancelled status represents two different states depending on the event type: |
| 244 | # - 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. |
| 245 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 246 | # - 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. |
| 247 | # 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. |
| 248 | # 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. |
| 249 | "creator": { # The creator of the event. Read-only. |
| 250 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 251 | "email": "A String", # The creator's email address, if available. |
| 252 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 253 | "displayName": "A String", # The creator's name, if available. |
| 254 | }, |
| 255 | "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. |
| 256 | "A String", |
| 257 | ], |
| 258 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 259 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 260 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 261 | # - "private" - The event is private and only event attendees may view event details. |
| 262 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 263 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 264 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 265 | "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. |
| 266 | "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. |
| 267 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 268 | "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. |
| 269 | }, |
| 270 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 271 | "sequence": 42, # Sequence number as per iCalendar. |
| 272 | "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. |
| 273 | "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. |
| 274 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 275 | "status": { # The status of the conference create request. |
| 276 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 277 | # The possible values are: |
| 278 | # - "pending": the conference create request is still being processed. |
| 279 | # - "success": the conference create request succeeded, the entry points are populated. |
| 280 | # - "failure": the conference create request failed, there are no entry points. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 281 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 282 | "requestId": "A String", # The client-generated unique ID for this request. |
| 283 | # 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. |
| 284 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 285 | "type": "A String", # The conference solution type. |
| 286 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 287 | # The possible values are: |
| 288 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 289 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 290 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 291 | # - "addOn" for 3P conference providers |
| 292 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 293 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 294 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 295 | "addOnParameters": { # Additional add-on specific data. |
| 296 | "parameters": { |
| 297 | "a_key": "A String", |
| 298 | }, |
| 299 | }, |
| 300 | }, |
| 301 | "signature": "A String", # The signature of the conference data. |
| 302 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 303 | # Unset for a conference with a failed create request. |
| 304 | # Optional for a conference with a pending create request. |
| 305 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 306 | # Unset for a conference with a failed create request. |
| 307 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 308 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 309 | "iconUri": "A String", # The user-visible icon for this solution. |
| 310 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 311 | "type": "A String", # The conference solution type. |
| 312 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 313 | # The possible values are: |
| 314 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 315 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 316 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 317 | # - "addOn" for 3P conference providers |
| 318 | }, |
| 319 | }, |
| 320 | "conferenceId": "A String", # The ID of the conference. |
| 321 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 322 | # Values for solution types: |
| 323 | # - "eventHangout": unset. |
| 324 | # - "eventNamedHangout": the name of the Hangout. |
| 325 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 326 | # - "addOn": defined by 3P conference provider. Optional. |
| 327 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 328 | # All of them must belong to the same conference. |
| 329 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 330 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 331 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 332 | # 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. |
| 333 | # Optional. |
| 334 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 335 | # 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. |
| 336 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 339 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 340 | # 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. |
| 341 | # Optional. |
| 342 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 343 | # Examples: |
| 344 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 345 | # - for phone: +1 123 268 2601 |
| 346 | # - for sip: 12345678@altostrat.com |
| 347 | # - for more: should not be filled |
| 348 | # Optional. |
| 349 | "entryPointType": "A String", # The type of the conference entry point. |
| 350 | # Possible values are: |
| 351 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 352 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 353 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 354 | # - "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. |
| 355 | "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. |
| 356 | "A String", |
| 357 | ], |
| 358 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 359 | # 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. |
| 360 | # Optional. |
| 361 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 362 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 363 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 364 | # Format: |
| 365 | # - for video, http: or https: schema is required. |
| 366 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 367 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 368 | # - for more, http: or https: schema is required. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 369 | }, |
| 370 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 371 | "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. |
| 372 | }, |
| 373 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 374 | # - "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. |
| 375 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| 376 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| 377 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| 378 | "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. |
| 379 | "displayName": "A String", # The organizer's name, if available. |
| 380 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 381 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 382 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 383 | }, |
| 384 | "etag": "A String", # ETag of the resource. |
| 385 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 386 | "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. |
| 387 | "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. |
| 388 | # 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. |
| 389 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 390 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 391 | "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. |
| 392 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 393 | "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. |
| 394 | "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. |
| 395 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 396 | "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. |
| 397 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 398 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 399 | }, |
| 400 | "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. |
| 401 | "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: |
| 402 | # - 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 |
| 403 | # - the length of the ID must be between 5 and 1024 characters |
| 404 | # - 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. |
| 405 | # If you do not specify an ID, it will be automatically generated by the server. |
| 406 | # 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. |
| 407 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 408 | </div> |
| 409 | |
| 410 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 411 | <code class="details" id="import_">import_(calendarId, body=None, conferenceDataVersion=None, supportsAttachments=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 412 | <pre>Imports an event. This operation is used to add a private copy of an existing event to a calendar. |
| 413 | |
| 414 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 415 | 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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 416 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 417 | The object takes the form of: |
| 418 | |
| 419 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 420 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 421 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 422 | # There can be at most 25 attachments per event, |
| 423 | { |
| 424 | "title": "A String", # Attachment title. |
| 425 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| 426 | "fileUrl": "A String", # URL link to the attachment. |
| 427 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 428 | # Required when adding an attachment. |
| 429 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 430 | "fileId": "A String", # ID of the attached file. Read-only. |
| 431 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| 432 | }, |
| 433 | ], |
| 434 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 435 | "title": "A String", # The gadget's title. Deprecated. |
| 436 | "preferences": { # Preferences. |
| 437 | "a_key": "A String", # The preference name and corresponding value. |
| 438 | }, |
| 439 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 440 | "type": "A String", # The gadget's type. Deprecated. |
| 441 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 442 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 443 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 444 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 445 | # - "chip" - The gadget displays when the event is clicked. |
| 446 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 447 | }, |
| 448 | "summary": "A String", # Title of the event. |
| 449 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 450 | { |
| 451 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 452 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 453 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 454 | "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. |
| 455 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 456 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 457 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 458 | "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. |
| 459 | # Required when adding an attendee. |
| 460 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 461 | # - "needsAction" - The attendee has not responded to the invitation. |
| 462 | # - "declined" - The attendee has declined the invitation. |
| 463 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 464 | # - "accepted" - The attendee has accepted the invitation. |
| 465 | "comment": "A String", # The attendee's response comment. Optional. |
| 466 | }, |
| 467 | ], |
| 468 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 469 | "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. |
| 470 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 471 | "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. |
| 472 | }, |
| 473 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 474 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 475 | "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. |
| 476 | { |
| 477 | "method": "A String", # The method used by this reminder. Possible values are: |
| 478 | # - "email" - Reminders are sent via email. |
| 479 | # - "popup" - Reminders are sent via a UI popup. |
| 480 | # Required when adding a reminder. |
| 481 | "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). |
| 482 | # Required when adding a reminder. |
| 483 | }, |
| 484 | ], |
| 485 | }, |
| 486 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| 487 | "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. |
| 488 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 489 | "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. |
| 490 | }, |
| 491 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 492 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 493 | "extendedProperties": { # Extended properties of the event. |
| 494 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 495 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 496 | }, |
| 497 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 498 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 499 | }, |
| 500 | }, |
| 501 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 502 | # - "confirmed" - The event is confirmed. This is the default status. |
| 503 | # - "tentative" - The event is tentatively confirmed. |
| 504 | # - "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. |
| 505 | # A cancelled status represents two different states depending on the event type: |
| 506 | # - 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. |
| 507 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 508 | # - 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. |
| 509 | # 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. |
| 510 | # 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. |
| 511 | "creator": { # The creator of the event. Read-only. |
| 512 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 513 | "email": "A String", # The creator's email address, if available. |
| 514 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 515 | "displayName": "A String", # The creator's name, if available. |
| 516 | }, |
| 517 | "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. |
| 518 | "A String", |
| 519 | ], |
| 520 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 521 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 522 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 523 | # - "private" - The event is private and only event attendees may view event details. |
| 524 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 525 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 526 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 527 | "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. |
| 528 | "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. |
| 529 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 530 | "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. |
| 531 | }, |
| 532 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 533 | "sequence": 42, # Sequence number as per iCalendar. |
| 534 | "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. |
| 535 | "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. |
| 536 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 537 | "status": { # The status of the conference create request. |
| 538 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 539 | # The possible values are: |
| 540 | # - "pending": the conference create request is still being processed. |
| 541 | # - "success": the conference create request succeeded, the entry points are populated. |
| 542 | # - "failure": the conference create request failed, there are no entry points. |
| 543 | }, |
| 544 | "requestId": "A String", # The client-generated unique ID for this request. |
| 545 | # 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. |
| 546 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 547 | "type": "A String", # The conference solution type. |
| 548 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 549 | # The possible values are: |
| 550 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 551 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 552 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 553 | # - "addOn" for 3P conference providers |
| 554 | }, |
| 555 | }, |
| 556 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 557 | "addOnParameters": { # Additional add-on specific data. |
| 558 | "parameters": { |
| 559 | "a_key": "A String", |
| 560 | }, |
| 561 | }, |
| 562 | }, |
| 563 | "signature": "A String", # The signature of the conference data. |
| 564 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 565 | # Unset for a conference with a failed create request. |
| 566 | # Optional for a conference with a pending create request. |
| 567 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 568 | # Unset for a conference with a failed create request. |
| 569 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 570 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 571 | "iconUri": "A String", # The user-visible icon for this solution. |
| 572 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 573 | "type": "A String", # The conference solution type. |
| 574 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 575 | # The possible values are: |
| 576 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 577 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 578 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 579 | # - "addOn" for 3P conference providers |
| 580 | }, |
| 581 | }, |
| 582 | "conferenceId": "A String", # The ID of the conference. |
| 583 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 584 | # Values for solution types: |
| 585 | # - "eventHangout": unset. |
| 586 | # - "eventNamedHangout": the name of the Hangout. |
| 587 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 588 | # - "addOn": defined by 3P conference provider. Optional. |
| 589 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 590 | # All of them must belong to the same conference. |
| 591 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 592 | { |
| 593 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 594 | # 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. |
| 595 | # Optional. |
| 596 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 597 | # 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. |
| 598 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 601 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 602 | # 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. |
| 603 | # Optional. |
| 604 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 605 | # Examples: |
| 606 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 607 | # - for phone: +1 123 268 2601 |
| 608 | # - for sip: 12345678@altostrat.com |
| 609 | # - for more: should not be filled |
| 610 | # Optional. |
| 611 | "entryPointType": "A String", # The type of the conference entry point. |
| 612 | # Possible values are: |
| 613 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 614 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 615 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 616 | # - "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. |
| 617 | "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. |
| 618 | "A String", |
| 619 | ], |
| 620 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 621 | # 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. |
| 622 | # Optional. |
| 623 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 624 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 625 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 626 | # Format: |
| 627 | # - for video, http: or https: schema is required. |
| 628 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 629 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 630 | # - for more, http: or https: schema is required. |
| 631 | }, |
| 632 | ], |
| 633 | "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. |
| 634 | }, |
| 635 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 636 | # - "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. |
| 637 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| 638 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| 639 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| 640 | "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. |
| 641 | "displayName": "A String", # The organizer's name, if available. |
| 642 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 643 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 644 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 645 | }, |
| 646 | "etag": "A String", # ETag of the resource. |
| 647 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 648 | "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. |
| 649 | "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. |
| 650 | # 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. |
| 651 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 652 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 653 | "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. |
| 654 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 655 | "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. |
| 656 | "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. |
| 657 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 658 | "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. |
| 659 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 660 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 661 | }, |
| 662 | "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. |
| 663 | "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: |
| 664 | # - 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 |
| 665 | # - the length of the ID must be between 5 and 1024 characters |
| 666 | # - 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. |
| 667 | # If you do not specify an ID, it will be automatically generated by the server. |
| 668 | # 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. |
| 669 | } |
| 670 | |
| 671 | 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. |
| 672 | supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. |
| 673 | |
| 674 | Returns: |
| 675 | An object of the form: |
| 676 | |
| 677 | { |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 678 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 679 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 680 | # There can be at most 25 attachments per event, |
| 681 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 682 | "title": "A String", # Attachment title. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 683 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 684 | "fileUrl": "A String", # URL link to the attachment. |
| 685 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 686 | # Required when adding an attachment. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 687 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 688 | "fileId": "A String", # ID of the attached file. Read-only. |
| 689 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 690 | }, |
| 691 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 692 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 693 | "title": "A String", # The gadget's title. Deprecated. |
| 694 | "preferences": { # Preferences. |
| 695 | "a_key": "A String", # The preference name and corresponding value. |
| 696 | }, |
| 697 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 698 | "type": "A String", # The gadget's type. Deprecated. |
| 699 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 700 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 701 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 702 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 703 | # - "chip" - The gadget displays when the event is clicked. |
| 704 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 705 | }, |
| 706 | "summary": "A String", # Title of the event. |
| 707 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 708 | { |
| 709 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 710 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 711 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 712 | "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. |
| 713 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 714 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 715 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 716 | "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. |
| 717 | # Required when adding an attendee. |
| 718 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 719 | # - "needsAction" - The attendee has not responded to the invitation. |
| 720 | # - "declined" - The attendee has declined the invitation. |
| 721 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 722 | # - "accepted" - The attendee has accepted the invitation. |
| 723 | "comment": "A String", # The attendee's response comment. Optional. |
| 724 | }, |
| 725 | ], |
| 726 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 727 | "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. |
| 728 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 729 | "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. |
| 730 | }, |
| 731 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 732 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 733 | "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. |
| 734 | { |
| 735 | "method": "A String", # The method used by this reminder. Possible values are: |
| 736 | # - "email" - Reminders are sent via email. |
| 737 | # - "popup" - Reminders are sent via a UI popup. |
| 738 | # Required when adding a reminder. |
| 739 | "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). |
| 740 | # Required when adding a reminder. |
| 741 | }, |
| 742 | ], |
| 743 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 744 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 745 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 746 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 747 | "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. |
| 748 | }, |
| 749 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 750 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 751 | "extendedProperties": { # Extended properties of the event. |
| 752 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 753 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 754 | }, |
| 755 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 756 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 757 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 758 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 759 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 760 | # - "confirmed" - The event is confirmed. This is the default status. |
| 761 | # - "tentative" - The event is tentatively confirmed. |
| 762 | # - "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. |
| 763 | # A cancelled status represents two different states depending on the event type: |
| 764 | # - 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. |
| 765 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 766 | # - 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. |
| 767 | # 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. |
| 768 | # 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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 769 | "creator": { # The creator of the event. Read-only. |
| 770 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 771 | "email": "A String", # The creator's email address, if available. |
| 772 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 773 | "displayName": "A String", # The creator's name, if available. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 774 | }, |
| 775 | "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. |
| 776 | "A String", |
| 777 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 778 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 779 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 780 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 781 | # - "private" - The event is private and only event attendees may view event details. |
| 782 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 783 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 784 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 785 | "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. |
| 786 | "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. |
| 787 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 788 | "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. |
| 789 | }, |
| 790 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 791 | "sequence": 42, # Sequence number as per iCalendar. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 792 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 793 | "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. |
| 794 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 795 | "status": { # The status of the conference create request. |
| 796 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 797 | # The possible values are: |
| 798 | # - "pending": the conference create request is still being processed. |
| 799 | # - "success": the conference create request succeeded, the entry points are populated. |
| 800 | # - "failure": the conference create request failed, there are no entry points. |
| 801 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 802 | "requestId": "A String", # The client-generated unique ID for this request. |
| 803 | # 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. |
| 804 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 805 | "type": "A String", # The conference solution type. |
| 806 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 807 | # The possible values are: |
| 808 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 809 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 810 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 811 | # - "addOn" for 3P conference providers |
| 812 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 813 | }, |
| 814 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 815 | "addOnParameters": { # Additional add-on specific data. |
| 816 | "parameters": { |
| 817 | "a_key": "A String", |
| 818 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 819 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 820 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 821 | "signature": "A String", # The signature of the conference data. |
| 822 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 823 | # Unset for a conference with a failed create request. |
| 824 | # Optional for a conference with a pending create request. |
| 825 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 826 | # Unset for a conference with a failed create request. |
| 827 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 828 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 829 | "iconUri": "A String", # The user-visible icon for this solution. |
| 830 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 831 | "type": "A String", # The conference solution type. |
| 832 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 833 | # The possible values are: |
| 834 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 835 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 836 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 837 | # - "addOn" for 3P conference providers |
| 838 | }, |
| 839 | }, |
| 840 | "conferenceId": "A String", # The ID of the conference. |
| 841 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 842 | # Values for solution types: |
| 843 | # - "eventHangout": unset. |
| 844 | # - "eventNamedHangout": the name of the Hangout. |
| 845 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 846 | # - "addOn": defined by 3P conference provider. Optional. |
| 847 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 848 | # All of them must belong to the same conference. |
| 849 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 850 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 851 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 852 | # 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. |
| 853 | # Optional. |
| 854 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 855 | # 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. |
| 856 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 859 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 860 | # 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. |
| 861 | # Optional. |
| 862 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 863 | # Examples: |
| 864 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 865 | # - for phone: +1 123 268 2601 |
| 866 | # - for sip: 12345678@altostrat.com |
| 867 | # - for more: should not be filled |
| 868 | # Optional. |
| 869 | "entryPointType": "A String", # The type of the conference entry point. |
| 870 | # Possible values are: |
| 871 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 872 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 873 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 874 | # - "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. |
| 875 | "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. |
| 876 | "A String", |
| 877 | ], |
| 878 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 879 | # 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. |
| 880 | # Optional. |
| 881 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 882 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 883 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 884 | # Format: |
| 885 | # - for video, http: or https: schema is required. |
| 886 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 887 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 888 | # - for more, http: or https: schema is required. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 889 | }, |
| 890 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 891 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 892 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 893 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 894 | # - "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. |
| 895 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 896 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 897 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 898 | "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. |
| 899 | "displayName": "A String", # The organizer's name, if available. |
| 900 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 901 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 902 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 903 | }, |
| 904 | "etag": "A String", # ETag of the resource. |
| 905 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 906 | "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. |
| 907 | "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. |
| 908 | # 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. |
| 909 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 910 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 911 | "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. |
| 912 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 913 | "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. |
| 914 | "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. |
| 915 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 916 | "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. |
| 917 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 918 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 919 | }, |
| 920 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 921 | "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: |
| 922 | # - 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 |
| 923 | # - the length of the ID must be between 5 and 1024 characters |
| 924 | # - 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. |
| 925 | # If you do not specify an ID, it will be automatically generated by the server. |
| 926 | # 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 927 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 928 | </div> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 929 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 930 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 931 | <code class="details" id="insert">insert(calendarId, body=None, sendUpdates=None, supportsAttachments=None, maxAttendees=None, sendNotifications=None, conferenceDataVersion=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 932 | <pre>Creates an event. |
| 933 | |
| 934 | Args: |
| 935 | 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) |
| 936 | body: object, The request body. |
| 937 | The object takes the form of: |
| 938 | |
| 939 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 940 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 941 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 942 | # There can be at most 25 attachments per event, |
| 943 | { |
| 944 | "title": "A String", # Attachment title. |
| 945 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| 946 | "fileUrl": "A String", # URL link to the attachment. |
| 947 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 948 | # Required when adding an attachment. |
| 949 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 950 | "fileId": "A String", # ID of the attached file. Read-only. |
| 951 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| 952 | }, |
| 953 | ], |
| 954 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 955 | "title": "A String", # The gadget's title. Deprecated. |
| 956 | "preferences": { # Preferences. |
| 957 | "a_key": "A String", # The preference name and corresponding value. |
| 958 | }, |
| 959 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 960 | "type": "A String", # The gadget's type. Deprecated. |
| 961 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 962 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 963 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 964 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 965 | # - "chip" - The gadget displays when the event is clicked. |
| 966 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 967 | }, |
| 968 | "summary": "A String", # Title of the event. |
| 969 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 970 | { |
| 971 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 972 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 973 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 974 | "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. |
| 975 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 976 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 977 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 978 | "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. |
| 979 | # Required when adding an attendee. |
| 980 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 981 | # - "needsAction" - The attendee has not responded to the invitation. |
| 982 | # - "declined" - The attendee has declined the invitation. |
| 983 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 984 | # - "accepted" - The attendee has accepted the invitation. |
| 985 | "comment": "A String", # The attendee's response comment. Optional. |
| 986 | }, |
| 987 | ], |
| 988 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 989 | "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. |
| 990 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 991 | "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. |
| 992 | }, |
| 993 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 994 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 995 | "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. |
| 996 | { |
| 997 | "method": "A String", # The method used by this reminder. Possible values are: |
| 998 | # - "email" - Reminders are sent via email. |
| 999 | # - "popup" - Reminders are sent via a UI popup. |
| 1000 | # Required when adding a reminder. |
| 1001 | "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). |
| 1002 | # Required when adding a reminder. |
| 1003 | }, |
| 1004 | ], |
| 1005 | }, |
| 1006 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| 1007 | "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. |
| 1008 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 1009 | "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. |
| 1010 | }, |
| 1011 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 1012 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 1013 | "extendedProperties": { # Extended properties of the event. |
| 1014 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 1015 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 1016 | }, |
| 1017 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 1018 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 1019 | }, |
| 1020 | }, |
| 1021 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 1022 | # - "confirmed" - The event is confirmed. This is the default status. |
| 1023 | # - "tentative" - The event is tentatively confirmed. |
| 1024 | # - "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. |
| 1025 | # A cancelled status represents two different states depending on the event type: |
| 1026 | # - 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. |
| 1027 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 1028 | # - 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. |
| 1029 | # 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. |
| 1030 | # 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. |
| 1031 | "creator": { # The creator of the event. Read-only. |
| 1032 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 1033 | "email": "A String", # The creator's email address, if available. |
| 1034 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 1035 | "displayName": "A String", # The creator's name, if available. |
| 1036 | }, |
| 1037 | "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. |
| 1038 | "A String", |
| 1039 | ], |
| 1040 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 1041 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 1042 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 1043 | # - "private" - The event is private and only event attendees may view event details. |
| 1044 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 1045 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 1046 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 1047 | "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. |
| 1048 | "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. |
| 1049 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 1050 | "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. |
| 1051 | }, |
| 1052 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 1053 | "sequence": 42, # Sequence number as per iCalendar. |
| 1054 | "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. |
| 1055 | "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. |
| 1056 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 1057 | "status": { # The status of the conference create request. |
| 1058 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 1059 | # The possible values are: |
| 1060 | # - "pending": the conference create request is still being processed. |
| 1061 | # - "success": the conference create request succeeded, the entry points are populated. |
| 1062 | # - "failure": the conference create request failed, there are no entry points. |
| 1063 | }, |
| 1064 | "requestId": "A String", # The client-generated unique ID for this request. |
| 1065 | # 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. |
| 1066 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 1067 | "type": "A String", # The conference solution type. |
| 1068 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 1069 | # The possible values are: |
| 1070 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 1071 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 1072 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 1073 | # - "addOn" for 3P conference providers |
| 1074 | }, |
| 1075 | }, |
| 1076 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 1077 | "addOnParameters": { # Additional add-on specific data. |
| 1078 | "parameters": { |
| 1079 | "a_key": "A String", |
| 1080 | }, |
| 1081 | }, |
| 1082 | }, |
| 1083 | "signature": "A String", # The signature of the conference data. |
| 1084 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 1085 | # Unset for a conference with a failed create request. |
| 1086 | # Optional for a conference with a pending create request. |
| 1087 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 1088 | # Unset for a conference with a failed create request. |
| 1089 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 1090 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 1091 | "iconUri": "A String", # The user-visible icon for this solution. |
| 1092 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 1093 | "type": "A String", # The conference solution type. |
| 1094 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 1095 | # The possible values are: |
| 1096 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 1097 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 1098 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 1099 | # - "addOn" for 3P conference providers |
| 1100 | }, |
| 1101 | }, |
| 1102 | "conferenceId": "A String", # The ID of the conference. |
| 1103 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 1104 | # Values for solution types: |
| 1105 | # - "eventHangout": unset. |
| 1106 | # - "eventNamedHangout": the name of the Hangout. |
| 1107 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 1108 | # - "addOn": defined by 3P conference provider. Optional. |
| 1109 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 1110 | # All of them must belong to the same conference. |
| 1111 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 1112 | { |
| 1113 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 1114 | # 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. |
| 1115 | # Optional. |
| 1116 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 1117 | # 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. |
| 1118 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 1121 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 1122 | # 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. |
| 1123 | # Optional. |
| 1124 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 1125 | # Examples: |
| 1126 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 1127 | # - for phone: +1 123 268 2601 |
| 1128 | # - for sip: 12345678@altostrat.com |
| 1129 | # - for more: should not be filled |
| 1130 | # Optional. |
| 1131 | "entryPointType": "A String", # The type of the conference entry point. |
| 1132 | # Possible values are: |
| 1133 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 1134 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 1135 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 1136 | # - "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. |
| 1137 | "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. |
| 1138 | "A String", |
| 1139 | ], |
| 1140 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 1141 | # 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. |
| 1142 | # Optional. |
| 1143 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 1144 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 1145 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 1146 | # Format: |
| 1147 | # - for video, http: or https: schema is required. |
| 1148 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 1149 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 1150 | # - for more, http: or https: schema is required. |
| 1151 | }, |
| 1152 | ], |
| 1153 | "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. |
| 1154 | }, |
| 1155 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 1156 | # - "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. |
| 1157 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| 1158 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| 1159 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| 1160 | "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. |
| 1161 | "displayName": "A String", # The organizer's name, if available. |
| 1162 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 1163 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 1164 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 1165 | }, |
| 1166 | "etag": "A String", # ETag of the resource. |
| 1167 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 1168 | "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. |
| 1169 | "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. |
| 1170 | # 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. |
| 1171 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 1172 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 1173 | "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. |
| 1174 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 1175 | "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. |
| 1176 | "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. |
| 1177 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 1178 | "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. |
| 1179 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 1180 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 1181 | }, |
| 1182 | "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. |
| 1183 | "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: |
| 1184 | # - 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 |
| 1185 | # - the length of the ID must be between 5 and 1024 characters |
| 1186 | # - 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. |
| 1187 | # If you do not specify an ID, it will be automatically generated by the server. |
| 1188 | # 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. |
| 1189 | } |
| 1190 | |
| 1191 | 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. |
| 1192 | Allowed values |
| 1193 | all - Notifications are sent to all guests. |
| 1194 | externalOnly - Notifications are sent to non-Google Calendar guests only. |
| 1195 | 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). |
| 1196 | supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. |
| 1197 | 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. |
| 1198 | sendNotifications: boolean, Deprecated. Please use sendUpdates instead. |
| 1199 | |
| 1200 | Whether 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. |
| 1201 | 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. |
| 1202 | |
| 1203 | Returns: |
| 1204 | An object of the form: |
| 1205 | |
| 1206 | { |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1207 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 1208 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 1209 | # There can be at most 25 attachments per event, |
| 1210 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1211 | "title": "A String", # Attachment title. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1212 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1213 | "fileUrl": "A String", # URL link to the attachment. |
| 1214 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 1215 | # Required when adding an attachment. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1216 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 1217 | "fileId": "A String", # ID of the attached file. Read-only. |
| 1218 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1219 | }, |
| 1220 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1221 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 1222 | "title": "A String", # The gadget's title. Deprecated. |
| 1223 | "preferences": { # Preferences. |
| 1224 | "a_key": "A String", # The preference name and corresponding value. |
| 1225 | }, |
| 1226 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 1227 | "type": "A String", # The gadget's type. Deprecated. |
| 1228 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 1229 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 1230 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 1231 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 1232 | # - "chip" - The gadget displays when the event is clicked. |
| 1233 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 1234 | }, |
| 1235 | "summary": "A String", # Title of the event. |
| 1236 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 1237 | { |
| 1238 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 1239 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 1240 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 1241 | "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. |
| 1242 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 1243 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 1244 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 1245 | "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. |
| 1246 | # Required when adding an attendee. |
| 1247 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 1248 | # - "needsAction" - The attendee has not responded to the invitation. |
| 1249 | # - "declined" - The attendee has declined the invitation. |
| 1250 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 1251 | # - "accepted" - The attendee has accepted the invitation. |
| 1252 | "comment": "A String", # The attendee's response comment. Optional. |
| 1253 | }, |
| 1254 | ], |
| 1255 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 1256 | "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. |
| 1257 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 1258 | "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. |
| 1259 | }, |
| 1260 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 1261 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 1262 | "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. |
| 1263 | { |
| 1264 | "method": "A String", # The method used by this reminder. Possible values are: |
| 1265 | # - "email" - Reminders are sent via email. |
| 1266 | # - "popup" - Reminders are sent via a UI popup. |
| 1267 | # Required when adding a reminder. |
| 1268 | "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). |
| 1269 | # Required when adding a reminder. |
| 1270 | }, |
| 1271 | ], |
| 1272 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1273 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1274 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1275 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1276 | "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. |
| 1277 | }, |
| 1278 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 1279 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 1280 | "extendedProperties": { # Extended properties of the event. |
| 1281 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 1282 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 1283 | }, |
| 1284 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 1285 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 1286 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1287 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1288 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 1289 | # - "confirmed" - The event is confirmed. This is the default status. |
| 1290 | # - "tentative" - The event is tentatively confirmed. |
| 1291 | # - "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. |
| 1292 | # A cancelled status represents two different states depending on the event type: |
| 1293 | # - 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. |
| 1294 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 1295 | # - 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. |
| 1296 | # 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. |
| 1297 | # 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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1298 | "creator": { # The creator of the event. Read-only. |
| 1299 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1300 | "email": "A String", # The creator's email address, if available. |
| 1301 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1302 | "displayName": "A String", # The creator's name, if available. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1303 | }, |
| 1304 | "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. |
| 1305 | "A String", |
| 1306 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1307 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 1308 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 1309 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 1310 | # - "private" - The event is private and only event attendees may view event details. |
| 1311 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 1312 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 1313 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 1314 | "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. |
| 1315 | "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. |
| 1316 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 1317 | "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. |
| 1318 | }, |
| 1319 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 1320 | "sequence": 42, # Sequence number as per iCalendar. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1321 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1322 | "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. |
| 1323 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1324 | "status": { # The status of the conference create request. |
| 1325 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 1326 | # The possible values are: |
| 1327 | # - "pending": the conference create request is still being processed. |
| 1328 | # - "success": the conference create request succeeded, the entry points are populated. |
| 1329 | # - "failure": the conference create request failed, there are no entry points. |
| 1330 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1331 | "requestId": "A String", # The client-generated unique ID for this request. |
| 1332 | # 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. |
| 1333 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 1334 | "type": "A String", # The conference solution type. |
| 1335 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 1336 | # The possible values are: |
| 1337 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 1338 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 1339 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 1340 | # - "addOn" for 3P conference providers |
| 1341 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1342 | }, |
| 1343 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 1344 | "addOnParameters": { # Additional add-on specific data. |
| 1345 | "parameters": { |
| 1346 | "a_key": "A String", |
| 1347 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1348 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1349 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1350 | "signature": "A String", # The signature of the conference data. |
| 1351 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 1352 | # Unset for a conference with a failed create request. |
| 1353 | # Optional for a conference with a pending create request. |
| 1354 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 1355 | # Unset for a conference with a failed create request. |
| 1356 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 1357 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 1358 | "iconUri": "A String", # The user-visible icon for this solution. |
| 1359 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 1360 | "type": "A String", # The conference solution type. |
| 1361 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 1362 | # The possible values are: |
| 1363 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 1364 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 1365 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 1366 | # - "addOn" for 3P conference providers |
| 1367 | }, |
| 1368 | }, |
| 1369 | "conferenceId": "A String", # The ID of the conference. |
| 1370 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 1371 | # Values for solution types: |
| 1372 | # - "eventHangout": unset. |
| 1373 | # - "eventNamedHangout": the name of the Hangout. |
| 1374 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 1375 | # - "addOn": defined by 3P conference provider. Optional. |
| 1376 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 1377 | # All of them must belong to the same conference. |
| 1378 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1379 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1380 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 1381 | # 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. |
| 1382 | # Optional. |
| 1383 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 1384 | # 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. |
| 1385 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 1388 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 1389 | # 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. |
| 1390 | # Optional. |
| 1391 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 1392 | # Examples: |
| 1393 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 1394 | # - for phone: +1 123 268 2601 |
| 1395 | # - for sip: 12345678@altostrat.com |
| 1396 | # - for more: should not be filled |
| 1397 | # Optional. |
| 1398 | "entryPointType": "A String", # The type of the conference entry point. |
| 1399 | # Possible values are: |
| 1400 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 1401 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 1402 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 1403 | # - "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. |
| 1404 | "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. |
| 1405 | "A String", |
| 1406 | ], |
| 1407 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 1408 | # 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. |
| 1409 | # Optional. |
| 1410 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 1411 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 1412 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 1413 | # Format: |
| 1414 | # - for video, http: or https: schema is required. |
| 1415 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 1416 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 1417 | # - for more, http: or https: schema is required. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1418 | }, |
| 1419 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1420 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1421 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1422 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 1423 | # - "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. |
| 1424 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1425 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1426 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1427 | "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. |
| 1428 | "displayName": "A String", # The organizer's name, if available. |
| 1429 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 1430 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 1431 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 1432 | }, |
| 1433 | "etag": "A String", # ETag of the resource. |
| 1434 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 1435 | "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. |
| 1436 | "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. |
| 1437 | # 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. |
| 1438 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 1439 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 1440 | "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. |
| 1441 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 1442 | "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. |
| 1443 | "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. |
| 1444 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 1445 | "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. |
| 1446 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 1447 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 1448 | }, |
| 1449 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1450 | "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: |
| 1451 | # - 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 |
| 1452 | # - the length of the ID must be between 5 and 1024 characters |
| 1453 | # - 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. |
| 1454 | # If you do not specify an ID, it will be automatically generated by the server. |
| 1455 | # 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1456 | }</pre> |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1457 | </div> |
| 1458 | |
| 1459 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1460 | <code class="details" id="instances">instances(calendarId, eventId, timeZone=None, pageToken=None, alwaysIncludeEmail=None, maxResults=None, timeMax=None, timeMin=None, originalStart=None, showDeleted=None, maxAttendees=None)</code> |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1461 | <pre>Returns instances of the specified recurring event. |
| 1462 | |
| 1463 | Args: |
| 1464 | 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) |
| 1465 | eventId: string, Recurring event identifier. (required) |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1466 | timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1467 | pageToken: string, Token specifying which result page to return. Optional. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1468 | 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). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1469 | 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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1470 | 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1471 | 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. |
| 1472 | originalStart: string, The original start time of the instance in the result. Optional. |
| 1473 | 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. |
| 1474 | 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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1475 | |
| 1476 | Returns: |
| 1477 | An object of the form: |
| 1478 | |
| 1479 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1480 | "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are: |
| 1481 | # - "none" - The user has no access. |
| 1482 | # - "freeBusyReader" - The user has read access to free/busy information. |
| 1483 | # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. |
| 1484 | # - "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. |
| 1485 | # - "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1486 | "kind": "calendar#events", # Type of the collection ("calendar#events"). |
| 1487 | "updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only. |
| 1488 | "summary": "A String", # Title of the calendar. Read-only. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1489 | "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). |
| 1490 | { |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1491 | "method": "A String", # The method used by this reminder. Possible values are: |
| 1492 | # - "email" - Reminders are sent via email. |
| 1493 | # - "popup" - Reminders are sent via a UI popup. |
| 1494 | # Required when adding a reminder. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1495 | "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). |
| 1496 | # Required when adding a reminder. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1497 | }, |
| 1498 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1499 | "items": [ # List of events on the calendar. |
| 1500 | { |
| 1501 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 1502 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 1503 | # There can be at most 25 attachments per event, |
| 1504 | { |
| 1505 | "title": "A String", # Attachment title. |
| 1506 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| 1507 | "fileUrl": "A String", # URL link to the attachment. |
| 1508 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 1509 | # Required when adding an attachment. |
| 1510 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 1511 | "fileId": "A String", # ID of the attached file. Read-only. |
| 1512 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| 1513 | }, |
| 1514 | ], |
| 1515 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 1516 | "title": "A String", # The gadget's title. Deprecated. |
| 1517 | "preferences": { # Preferences. |
| 1518 | "a_key": "A String", # The preference name and corresponding value. |
| 1519 | }, |
| 1520 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 1521 | "type": "A String", # The gadget's type. Deprecated. |
| 1522 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 1523 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 1524 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 1525 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 1526 | # - "chip" - The gadget displays when the event is clicked. |
| 1527 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 1528 | }, |
| 1529 | "summary": "A String", # Title of the event. |
| 1530 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 1531 | { |
| 1532 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 1533 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 1534 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 1535 | "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. |
| 1536 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 1537 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 1538 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 1539 | "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. |
| 1540 | # Required when adding an attendee. |
| 1541 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 1542 | # - "needsAction" - The attendee has not responded to the invitation. |
| 1543 | # - "declined" - The attendee has declined the invitation. |
| 1544 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 1545 | # - "accepted" - The attendee has accepted the invitation. |
| 1546 | "comment": "A String", # The attendee's response comment. Optional. |
| 1547 | }, |
| 1548 | ], |
| 1549 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 1550 | "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. |
| 1551 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 1552 | "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. |
| 1553 | }, |
| 1554 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 1555 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 1556 | "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. |
| 1557 | { |
| 1558 | "method": "A String", # The method used by this reminder. Possible values are: |
| 1559 | # - "email" - Reminders are sent via email. |
| 1560 | # - "popup" - Reminders are sent via a UI popup. |
| 1561 | # Required when adding a reminder. |
| 1562 | "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). |
| 1563 | # Required when adding a reminder. |
| 1564 | }, |
| 1565 | ], |
| 1566 | }, |
| 1567 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| 1568 | "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. |
| 1569 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 1570 | "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. |
| 1571 | }, |
| 1572 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 1573 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 1574 | "extendedProperties": { # Extended properties of the event. |
| 1575 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 1576 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 1577 | }, |
| 1578 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 1579 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 1580 | }, |
| 1581 | }, |
| 1582 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 1583 | # - "confirmed" - The event is confirmed. This is the default status. |
| 1584 | # - "tentative" - The event is tentatively confirmed. |
| 1585 | # - "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. |
| 1586 | # A cancelled status represents two different states depending on the event type: |
| 1587 | # - 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. |
| 1588 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 1589 | # - 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. |
| 1590 | # 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. |
| 1591 | # 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. |
| 1592 | "creator": { # The creator of the event. Read-only. |
| 1593 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 1594 | "email": "A String", # The creator's email address, if available. |
| 1595 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 1596 | "displayName": "A String", # The creator's name, if available. |
| 1597 | }, |
| 1598 | "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. |
| 1599 | "A String", |
| 1600 | ], |
| 1601 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 1602 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 1603 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 1604 | # - "private" - The event is private and only event attendees may view event details. |
| 1605 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 1606 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 1607 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 1608 | "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. |
| 1609 | "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. |
| 1610 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 1611 | "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. |
| 1612 | }, |
| 1613 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 1614 | "sequence": 42, # Sequence number as per iCalendar. |
| 1615 | "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. |
| 1616 | "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. |
| 1617 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 1618 | "status": { # The status of the conference create request. |
| 1619 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 1620 | # The possible values are: |
| 1621 | # - "pending": the conference create request is still being processed. |
| 1622 | # - "success": the conference create request succeeded, the entry points are populated. |
| 1623 | # - "failure": the conference create request failed, there are no entry points. |
| 1624 | }, |
| 1625 | "requestId": "A String", # The client-generated unique ID for this request. |
| 1626 | # 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. |
| 1627 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 1628 | "type": "A String", # The conference solution type. |
| 1629 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 1630 | # The possible values are: |
| 1631 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 1632 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 1633 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 1634 | # - "addOn" for 3P conference providers |
| 1635 | }, |
| 1636 | }, |
| 1637 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 1638 | "addOnParameters": { # Additional add-on specific data. |
| 1639 | "parameters": { |
| 1640 | "a_key": "A String", |
| 1641 | }, |
| 1642 | }, |
| 1643 | }, |
| 1644 | "signature": "A String", # The signature of the conference data. |
| 1645 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 1646 | # Unset for a conference with a failed create request. |
| 1647 | # Optional for a conference with a pending create request. |
| 1648 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 1649 | # Unset for a conference with a failed create request. |
| 1650 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 1651 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 1652 | "iconUri": "A String", # The user-visible icon for this solution. |
| 1653 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 1654 | "type": "A String", # The conference solution type. |
| 1655 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 1656 | # The possible values are: |
| 1657 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 1658 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 1659 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 1660 | # - "addOn" for 3P conference providers |
| 1661 | }, |
| 1662 | }, |
| 1663 | "conferenceId": "A String", # The ID of the conference. |
| 1664 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 1665 | # Values for solution types: |
| 1666 | # - "eventHangout": unset. |
| 1667 | # - "eventNamedHangout": the name of the Hangout. |
| 1668 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 1669 | # - "addOn": defined by 3P conference provider. Optional. |
| 1670 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 1671 | # All of them must belong to the same conference. |
| 1672 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 1673 | { |
| 1674 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 1675 | # 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. |
| 1676 | # Optional. |
| 1677 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 1678 | # 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. |
| 1679 | "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. |
| 1680 | # 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. |
| 1681 | # Optional. |
| 1682 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 1683 | # 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. |
| 1684 | # Optional. |
| 1685 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 1686 | # Examples: |
| 1687 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 1688 | # - for phone: +1 123 268 2601 |
| 1689 | # - for sip: 12345678@altostrat.com |
| 1690 | # - for more: should not be filled |
| 1691 | # Optional. |
| 1692 | "entryPointType": "A String", # The type of the conference entry point. |
| 1693 | # Possible values are: |
| 1694 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 1695 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 1696 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 1697 | # - "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. |
| 1698 | "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. |
| 1699 | "A String", |
| 1700 | ], |
| 1701 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 1702 | # 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. |
| 1703 | # Optional. |
| 1704 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 1705 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 1706 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 1707 | # Format: |
| 1708 | # - for video, http: or https: schema is required. |
| 1709 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 1710 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 1711 | # - for more, http: or https: schema is required. |
| 1712 | }, |
| 1713 | ], |
| 1714 | "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. |
| 1715 | }, |
| 1716 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 1717 | # - "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. |
| 1718 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| 1719 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| 1720 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| 1721 | "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. |
| 1722 | "displayName": "A String", # The organizer's name, if available. |
| 1723 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 1724 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 1725 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 1726 | }, |
| 1727 | "etag": "A String", # ETag of the resource. |
| 1728 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 1729 | "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. |
| 1730 | "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. |
| 1731 | # 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. |
| 1732 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 1733 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 1734 | "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. |
| 1735 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 1736 | "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. |
| 1737 | "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. |
| 1738 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 1739 | "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. |
| 1740 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 1741 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 1742 | }, |
| 1743 | "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. |
| 1744 | "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: |
| 1745 | # - 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 |
| 1746 | # - the length of the ID must be between 5 and 1024 characters |
| 1747 | # - 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. |
| 1748 | # If you do not specify an ID, it will be automatically generated by the server. |
| 1749 | # 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. |
| 1750 | }, |
| 1751 | ], |
| 1752 | "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. |
| 1753 | "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. |
| 1754 | "etag": "A String", # ETag of the collection. |
| 1755 | "description": "A String", # Description of the calendar. Read-only. |
| 1756 | "timeZone": "A String", # The time zone of the calendar. Read-only. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1757 | }</pre> |
| 1758 | </div> |
| 1759 | |
| 1760 | <div class="method"> |
| 1761 | <code class="details" id="instances_next">instances_next(previous_request, previous_response)</code> |
| 1762 | <pre>Retrieves the next page of results. |
| 1763 | |
| 1764 | Args: |
| 1765 | previous_request: The request for the previous page. (required) |
| 1766 | previous_response: The response from the request for the previous page. (required) |
| 1767 | |
| 1768 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1769 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1770 | page. Returns None if there are no more items in the collection. |
| 1771 | </pre> |
| 1772 | </div> |
| 1773 | |
| 1774 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1775 | <code class="details" id="list">list(calendarId, sharedExtendedProperty=None, updatedMin=None, showHiddenInvitations=None, orderBy=None, showDeleted=None, iCalUID=None, singleEvents=None, pageToken=None, timeZone=None, timeMax=None, maxResults=None, q=None, alwaysIncludeEmail=None, maxAttendees=None, syncToken=None, timeMin=None, privateExtendedProperty=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1776 | <pre>Returns events on the specified calendar. |
| 1777 | |
| 1778 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1779 | 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) |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1780 | 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) |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1781 | 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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1782 | showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1783 | orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order. |
| 1784 | Allowed values |
| 1785 | startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True) |
| 1786 | updated - Order by last modification time (ascending). |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1787 | 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1788 | iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional. |
| 1789 | 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. |
| 1790 | pageToken: string, Token specifying which result page to return. Optional. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1791 | timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1792 | 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. |
| 1793 | 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. |
| 1794 | q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional. |
| 1795 | 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). |
| 1796 | 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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 1797 | 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. |
| 1798 | There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. |
| 1799 | |
| 1800 | These are: |
| 1801 | - iCalUID |
| 1802 | - orderBy |
| 1803 | - privateExtendedProperty |
| 1804 | - q |
| 1805 | - sharedExtendedProperty |
| 1806 | - timeMin |
| 1807 | - timeMax |
| 1808 | - 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. |
| 1809 | Learn more about incremental synchronization. |
| 1810 | Optional. The default is to return all entries. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1811 | 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. |
| 1812 | 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) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1813 | |
| 1814 | Returns: |
| 1815 | An object of the form: |
| 1816 | |
| 1817 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1818 | "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are: |
| 1819 | # - "none" - The user has no access. |
| 1820 | # - "freeBusyReader" - The user has read access to free/busy information. |
| 1821 | # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. |
| 1822 | # - "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. |
| 1823 | # - "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1824 | "kind": "calendar#events", # Type of the collection ("calendar#events"). |
| 1825 | "updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only. |
| 1826 | "summary": "A String", # Title of the calendar. Read-only. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1827 | "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). |
| 1828 | { |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1829 | "method": "A String", # The method used by this reminder. Possible values are: |
| 1830 | # - "email" - Reminders are sent via email. |
| 1831 | # - "popup" - Reminders are sent via a UI popup. |
| 1832 | # Required when adding a reminder. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1833 | "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). |
| 1834 | # Required when adding a reminder. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1835 | }, |
| 1836 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1837 | "items": [ # List of events on the calendar. |
| 1838 | { |
| 1839 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 1840 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 1841 | # There can be at most 25 attachments per event, |
| 1842 | { |
| 1843 | "title": "A String", # Attachment title. |
| 1844 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| 1845 | "fileUrl": "A String", # URL link to the attachment. |
| 1846 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 1847 | # Required when adding an attachment. |
| 1848 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 1849 | "fileId": "A String", # ID of the attached file. Read-only. |
| 1850 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| 1851 | }, |
| 1852 | ], |
| 1853 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 1854 | "title": "A String", # The gadget's title. Deprecated. |
| 1855 | "preferences": { # Preferences. |
| 1856 | "a_key": "A String", # The preference name and corresponding value. |
| 1857 | }, |
| 1858 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 1859 | "type": "A String", # The gadget's type. Deprecated. |
| 1860 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 1861 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 1862 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 1863 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 1864 | # - "chip" - The gadget displays when the event is clicked. |
| 1865 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 1866 | }, |
| 1867 | "summary": "A String", # Title of the event. |
| 1868 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 1869 | { |
| 1870 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 1871 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 1872 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 1873 | "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. |
| 1874 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 1875 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 1876 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 1877 | "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. |
| 1878 | # Required when adding an attendee. |
| 1879 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 1880 | # - "needsAction" - The attendee has not responded to the invitation. |
| 1881 | # - "declined" - The attendee has declined the invitation. |
| 1882 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 1883 | # - "accepted" - The attendee has accepted the invitation. |
| 1884 | "comment": "A String", # The attendee's response comment. Optional. |
| 1885 | }, |
| 1886 | ], |
| 1887 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 1888 | "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. |
| 1889 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 1890 | "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. |
| 1891 | }, |
| 1892 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 1893 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 1894 | "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. |
| 1895 | { |
| 1896 | "method": "A String", # The method used by this reminder. Possible values are: |
| 1897 | # - "email" - Reminders are sent via email. |
| 1898 | # - "popup" - Reminders are sent via a UI popup. |
| 1899 | # Required when adding a reminder. |
| 1900 | "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). |
| 1901 | # Required when adding a reminder. |
| 1902 | }, |
| 1903 | ], |
| 1904 | }, |
| 1905 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| 1906 | "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. |
| 1907 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 1908 | "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. |
| 1909 | }, |
| 1910 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 1911 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 1912 | "extendedProperties": { # Extended properties of the event. |
| 1913 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 1914 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 1915 | }, |
| 1916 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 1917 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 1918 | }, |
| 1919 | }, |
| 1920 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 1921 | # - "confirmed" - The event is confirmed. This is the default status. |
| 1922 | # - "tentative" - The event is tentatively confirmed. |
| 1923 | # - "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. |
| 1924 | # A cancelled status represents two different states depending on the event type: |
| 1925 | # - 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. |
| 1926 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 1927 | # - 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. |
| 1928 | # 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. |
| 1929 | # 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. |
| 1930 | "creator": { # The creator of the event. Read-only. |
| 1931 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 1932 | "email": "A String", # The creator's email address, if available. |
| 1933 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 1934 | "displayName": "A String", # The creator's name, if available. |
| 1935 | }, |
| 1936 | "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. |
| 1937 | "A String", |
| 1938 | ], |
| 1939 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 1940 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 1941 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 1942 | # - "private" - The event is private and only event attendees may view event details. |
| 1943 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 1944 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 1945 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 1946 | "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. |
| 1947 | "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. |
| 1948 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 1949 | "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. |
| 1950 | }, |
| 1951 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 1952 | "sequence": 42, # Sequence number as per iCalendar. |
| 1953 | "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. |
| 1954 | "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. |
| 1955 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 1956 | "status": { # The status of the conference create request. |
| 1957 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 1958 | # The possible values are: |
| 1959 | # - "pending": the conference create request is still being processed. |
| 1960 | # - "success": the conference create request succeeded, the entry points are populated. |
| 1961 | # - "failure": the conference create request failed, there are no entry points. |
| 1962 | }, |
| 1963 | "requestId": "A String", # The client-generated unique ID for this request. |
| 1964 | # 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. |
| 1965 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 1966 | "type": "A String", # The conference solution type. |
| 1967 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 1968 | # The possible values are: |
| 1969 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 1970 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 1971 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 1972 | # - "addOn" for 3P conference providers |
| 1973 | }, |
| 1974 | }, |
| 1975 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 1976 | "addOnParameters": { # Additional add-on specific data. |
| 1977 | "parameters": { |
| 1978 | "a_key": "A String", |
| 1979 | }, |
| 1980 | }, |
| 1981 | }, |
| 1982 | "signature": "A String", # The signature of the conference data. |
| 1983 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 1984 | # Unset for a conference with a failed create request. |
| 1985 | # Optional for a conference with a pending create request. |
| 1986 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 1987 | # Unset for a conference with a failed create request. |
| 1988 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 1989 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 1990 | "iconUri": "A String", # The user-visible icon for this solution. |
| 1991 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 1992 | "type": "A String", # The conference solution type. |
| 1993 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 1994 | # The possible values are: |
| 1995 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 1996 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 1997 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 1998 | # - "addOn" for 3P conference providers |
| 1999 | }, |
| 2000 | }, |
| 2001 | "conferenceId": "A String", # The ID of the conference. |
| 2002 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 2003 | # Values for solution types: |
| 2004 | # - "eventHangout": unset. |
| 2005 | # - "eventNamedHangout": the name of the Hangout. |
| 2006 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 2007 | # - "addOn": defined by 3P conference provider. Optional. |
| 2008 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 2009 | # All of them must belong to the same conference. |
| 2010 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 2011 | { |
| 2012 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 2013 | # 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. |
| 2014 | # Optional. |
| 2015 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 2016 | # 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. |
| 2017 | "meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters. |
| 2018 | # 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. |
| 2019 | # Optional. |
| 2020 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 2021 | # 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. |
| 2022 | # Optional. |
| 2023 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 2024 | # Examples: |
| 2025 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 2026 | # - for phone: +1 123 268 2601 |
| 2027 | # - for sip: 12345678@altostrat.com |
| 2028 | # - for more: should not be filled |
| 2029 | # Optional. |
| 2030 | "entryPointType": "A String", # The type of the conference entry point. |
| 2031 | # Possible values are: |
| 2032 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 2033 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 2034 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 2035 | # - "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. |
| 2036 | "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. |
| 2037 | "A String", |
| 2038 | ], |
| 2039 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 2040 | # 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. |
| 2041 | # Optional. |
| 2042 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 2043 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 2044 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 2045 | # Format: |
| 2046 | # - for video, http: or https: schema is required. |
| 2047 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 2048 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 2049 | # - for more, http: or https: schema is required. |
| 2050 | }, |
| 2051 | ], |
| 2052 | "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. |
| 2053 | }, |
| 2054 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 2055 | # - "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. |
| 2056 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| 2057 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| 2058 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| 2059 | "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. |
| 2060 | "displayName": "A String", # The organizer's name, if available. |
| 2061 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 2062 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 2063 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 2064 | }, |
| 2065 | "etag": "A String", # ETag of the resource. |
| 2066 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 2067 | "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. |
| 2068 | "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. |
| 2069 | # 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. |
| 2070 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 2071 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 2072 | "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. |
| 2073 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 2074 | "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. |
| 2075 | "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. |
| 2076 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 2077 | "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. |
| 2078 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 2079 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 2080 | }, |
| 2081 | "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. |
| 2082 | "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: |
| 2083 | # - 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 |
| 2084 | # - the length of the ID must be between 5 and 1024 characters |
| 2085 | # - 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. |
| 2086 | # If you do not specify an ID, it will be automatically generated by the server. |
| 2087 | # 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. |
| 2088 | }, |
| 2089 | ], |
| 2090 | "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. |
| 2091 | "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. |
| 2092 | "etag": "A String", # ETag of the collection. |
| 2093 | "description": "A String", # Description of the calendar. Read-only. |
| 2094 | "timeZone": "A String", # The time zone of the calendar. Read-only. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2095 | }</pre> |
| 2096 | </div> |
| 2097 | |
| 2098 | <div class="method"> |
| 2099 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 2100 | <pre>Retrieves the next page of results. |
| 2101 | |
| 2102 | Args: |
| 2103 | previous_request: The request for the previous page. (required) |
| 2104 | previous_response: The response from the request for the previous page. (required) |
| 2105 | |
| 2106 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2107 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2108 | page. Returns None if there are no more items in the collection. |
| 2109 | </pre> |
| 2110 | </div> |
| 2111 | |
| 2112 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2113 | <code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2114 | <pre>Moves an event to another calendar, i.e. changes an event's organizer. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2115 | |
| 2116 | Args: |
| 2117 | calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required) |
| 2118 | eventId: string, Event identifier. (required) |
| 2119 | destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required) |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2120 | sendNotifications: boolean, Deprecated. Please use sendUpdates instead. |
| 2121 | |
| 2122 | Whether 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2123 | sendUpdates: string, Guests who should receive notifications about the change of the event's organizer. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2124 | Allowed values |
| 2125 | all - Notifications are sent to all guests. |
| 2126 | externalOnly - Notifications are sent to non-Google Calendar guests only. |
| 2127 | 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 Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2128 | |
| 2129 | Returns: |
| 2130 | An object of the form: |
| 2131 | |
| 2132 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2133 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 2134 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 2135 | # There can be at most 25 attachments per event, |
| 2136 | { |
| 2137 | "title": "A String", # Attachment title. |
| 2138 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| 2139 | "fileUrl": "A String", # URL link to the attachment. |
| 2140 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 2141 | # Required when adding an attachment. |
| 2142 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 2143 | "fileId": "A String", # ID of the attached file. Read-only. |
| 2144 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| 2145 | }, |
| 2146 | ], |
| 2147 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 2148 | "title": "A String", # The gadget's title. Deprecated. |
| 2149 | "preferences": { # Preferences. |
| 2150 | "a_key": "A String", # The preference name and corresponding value. |
| 2151 | }, |
| 2152 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 2153 | "type": "A String", # The gadget's type. Deprecated. |
| 2154 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 2155 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 2156 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 2157 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 2158 | # - "chip" - The gadget displays when the event is clicked. |
| 2159 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 2160 | }, |
| 2161 | "summary": "A String", # Title of the event. |
| 2162 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 2163 | { |
| 2164 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 2165 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 2166 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 2167 | "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. |
| 2168 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 2169 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 2170 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 2171 | "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. |
| 2172 | # Required when adding an attendee. |
| 2173 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 2174 | # - "needsAction" - The attendee has not responded to the invitation. |
| 2175 | # - "declined" - The attendee has declined the invitation. |
| 2176 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 2177 | # - "accepted" - The attendee has accepted the invitation. |
| 2178 | "comment": "A String", # The attendee's response comment. Optional. |
| 2179 | }, |
| 2180 | ], |
| 2181 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 2182 | "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. |
| 2183 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 2184 | "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. |
| 2185 | }, |
| 2186 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 2187 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 2188 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 2189 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2190 | "method": "A String", # The method used by this reminder. Possible values are: |
| 2191 | # - "email" - Reminders are sent via email. |
| 2192 | # - "popup" - Reminders are sent via a UI popup. |
| 2193 | # Required when adding a reminder. |
| 2194 | "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). |
| 2195 | # Required when adding a reminder. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 2196 | }, |
| 2197 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2198 | }, |
| 2199 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| 2200 | "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. |
| 2201 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 2202 | "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. |
| 2203 | }, |
| 2204 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 2205 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 2206 | "extendedProperties": { # Extended properties of the event. |
| 2207 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 2208 | "a_key": "A String", # The name of the private property and the corresponding value. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2209 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2210 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 2211 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 2212 | }, |
| 2213 | }, |
| 2214 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 2215 | # - "confirmed" - The event is confirmed. This is the default status. |
| 2216 | # - "tentative" - The event is tentatively confirmed. |
| 2217 | # - "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. |
| 2218 | # A cancelled status represents two different states depending on the event type: |
| 2219 | # - 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. |
| 2220 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 2221 | # - 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. |
| 2222 | # 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. |
| 2223 | # 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. |
| 2224 | "creator": { # The creator of the event. Read-only. |
| 2225 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 2226 | "email": "A String", # The creator's email address, if available. |
| 2227 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 2228 | "displayName": "A String", # The creator's name, if available. |
| 2229 | }, |
| 2230 | "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. |
| 2231 | "A String", |
| 2232 | ], |
| 2233 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 2234 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 2235 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 2236 | # - "private" - The event is private and only event attendees may view event details. |
| 2237 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 2238 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 2239 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 2240 | "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. |
| 2241 | "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. |
| 2242 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 2243 | "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. |
| 2244 | }, |
| 2245 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 2246 | "sequence": 42, # Sequence number as per iCalendar. |
| 2247 | "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. |
| 2248 | "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. |
| 2249 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 2250 | "status": { # The status of the conference create request. |
| 2251 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 2252 | # The possible values are: |
| 2253 | # - "pending": the conference create request is still being processed. |
| 2254 | # - "success": the conference create request succeeded, the entry points are populated. |
| 2255 | # - "failure": the conference create request failed, there are no entry points. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2256 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2257 | "requestId": "A String", # The client-generated unique ID for this request. |
| 2258 | # 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. |
| 2259 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 2260 | "type": "A String", # The conference solution type. |
| 2261 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 2262 | # The possible values are: |
| 2263 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 2264 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 2265 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 2266 | # - "addOn" for 3P conference providers |
| 2267 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2268 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2269 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 2270 | "addOnParameters": { # Additional add-on specific data. |
| 2271 | "parameters": { |
| 2272 | "a_key": "A String", |
| 2273 | }, |
| 2274 | }, |
| 2275 | }, |
| 2276 | "signature": "A String", # The signature of the conference data. |
| 2277 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 2278 | # Unset for a conference with a failed create request. |
| 2279 | # Optional for a conference with a pending create request. |
| 2280 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 2281 | # Unset for a conference with a failed create request. |
| 2282 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 2283 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 2284 | "iconUri": "A String", # The user-visible icon for this solution. |
| 2285 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 2286 | "type": "A String", # The conference solution type. |
| 2287 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 2288 | # The possible values are: |
| 2289 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 2290 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 2291 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 2292 | # - "addOn" for 3P conference providers |
| 2293 | }, |
| 2294 | }, |
| 2295 | "conferenceId": "A String", # The ID of the conference. |
| 2296 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 2297 | # Values for solution types: |
| 2298 | # - "eventHangout": unset. |
| 2299 | # - "eventNamedHangout": the name of the Hangout. |
| 2300 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 2301 | # - "addOn": defined by 3P conference provider. Optional. |
| 2302 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 2303 | # All of them must belong to the same conference. |
| 2304 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 2305 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2306 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 2307 | # 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. |
| 2308 | # Optional. |
| 2309 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 2310 | # 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. |
| 2311 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 2314 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 2315 | # 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. |
| 2316 | # Optional. |
| 2317 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 2318 | # Examples: |
| 2319 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 2320 | # - for phone: +1 123 268 2601 |
| 2321 | # - for sip: 12345678@altostrat.com |
| 2322 | # - for more: should not be filled |
| 2323 | # Optional. |
| 2324 | "entryPointType": "A String", # The type of the conference entry point. |
| 2325 | # Possible values are: |
| 2326 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 2327 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 2328 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 2329 | # - "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. |
| 2330 | "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. |
| 2331 | "A String", |
| 2332 | ], |
| 2333 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 2334 | # 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. |
| 2335 | # Optional. |
| 2336 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 2337 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 2338 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 2339 | # Format: |
| 2340 | # - for video, http: or https: schema is required. |
| 2341 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 2342 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 2343 | # - for more, http: or https: schema is required. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 2344 | }, |
| 2345 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2346 | "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. |
| 2347 | }, |
| 2348 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 2349 | # - "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. |
| 2350 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| 2351 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| 2352 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| 2353 | "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. |
| 2354 | "displayName": "A String", # The organizer's name, if available. |
| 2355 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 2356 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 2357 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 2358 | }, |
| 2359 | "etag": "A String", # ETag of the resource. |
| 2360 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 2361 | "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. |
| 2362 | "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. |
| 2363 | # 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. |
| 2364 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 2365 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 2366 | "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. |
| 2367 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 2368 | "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. |
| 2369 | "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. |
| 2370 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 2371 | "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. |
| 2372 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 2373 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 2374 | }, |
| 2375 | "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. |
| 2376 | "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: |
| 2377 | # - 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 |
| 2378 | # - the length of the ID must be between 5 and 1024 characters |
| 2379 | # - 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. |
| 2380 | # If you do not specify an ID, it will be automatically generated by the server. |
| 2381 | # 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. |
| 2382 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2383 | </div> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2384 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2385 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2386 | <code class="details" id="patch">patch(calendarId, eventId, body=None, maxAttendees=None, supportsAttachments=None, alwaysIncludeEmail=None, sendUpdates=None, sendNotifications=None, conferenceDataVersion=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2387 | <pre>Updates an event. This method supports patch semantics. |
| 2388 | |
| 2389 | Args: |
| 2390 | 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) |
| 2391 | eventId: string, Event identifier. (required) |
| 2392 | body: object, The request body. |
| 2393 | The object takes the form of: |
| 2394 | |
| 2395 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2396 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 2397 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 2398 | # There can be at most 25 attachments per event, |
| 2399 | { |
| 2400 | "title": "A String", # Attachment title. |
| 2401 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| 2402 | "fileUrl": "A String", # URL link to the attachment. |
| 2403 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 2404 | # Required when adding an attachment. |
| 2405 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 2406 | "fileId": "A String", # ID of the attached file. Read-only. |
| 2407 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| 2408 | }, |
| 2409 | ], |
| 2410 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 2411 | "title": "A String", # The gadget's title. Deprecated. |
| 2412 | "preferences": { # Preferences. |
| 2413 | "a_key": "A String", # The preference name and corresponding value. |
| 2414 | }, |
| 2415 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 2416 | "type": "A String", # The gadget's type. Deprecated. |
| 2417 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 2418 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 2419 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 2420 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 2421 | # - "chip" - The gadget displays when the event is clicked. |
| 2422 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 2423 | }, |
| 2424 | "summary": "A String", # Title of the event. |
| 2425 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 2426 | { |
| 2427 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 2428 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 2429 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 2430 | "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. |
| 2431 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 2432 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 2433 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 2434 | "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. |
| 2435 | # Required when adding an attendee. |
| 2436 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 2437 | # - "needsAction" - The attendee has not responded to the invitation. |
| 2438 | # - "declined" - The attendee has declined the invitation. |
| 2439 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 2440 | # - "accepted" - The attendee has accepted the invitation. |
| 2441 | "comment": "A String", # The attendee's response comment. Optional. |
| 2442 | }, |
| 2443 | ], |
| 2444 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 2445 | "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. |
| 2446 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 2447 | "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. |
| 2448 | }, |
| 2449 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 2450 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 2451 | "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. |
| 2452 | { |
| 2453 | "method": "A String", # The method used by this reminder. Possible values are: |
| 2454 | # - "email" - Reminders are sent via email. |
| 2455 | # - "popup" - Reminders are sent via a UI popup. |
| 2456 | # Required when adding a reminder. |
| 2457 | "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). |
| 2458 | # Required when adding a reminder. |
| 2459 | }, |
| 2460 | ], |
| 2461 | }, |
| 2462 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| 2463 | "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. |
| 2464 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 2465 | "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. |
| 2466 | }, |
| 2467 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 2468 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 2469 | "extendedProperties": { # Extended properties of the event. |
| 2470 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 2471 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 2472 | }, |
| 2473 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 2474 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 2475 | }, |
| 2476 | }, |
| 2477 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 2478 | # - "confirmed" - The event is confirmed. This is the default status. |
| 2479 | # - "tentative" - The event is tentatively confirmed. |
| 2480 | # - "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. |
| 2481 | # A cancelled status represents two different states depending on the event type: |
| 2482 | # - 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. |
| 2483 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 2484 | # - 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. |
| 2485 | # 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. |
| 2486 | # 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. |
| 2487 | "creator": { # The creator of the event. Read-only. |
| 2488 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 2489 | "email": "A String", # The creator's email address, if available. |
| 2490 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 2491 | "displayName": "A String", # The creator's name, if available. |
| 2492 | }, |
| 2493 | "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. |
| 2494 | "A String", |
| 2495 | ], |
| 2496 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 2497 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 2498 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 2499 | # - "private" - The event is private and only event attendees may view event details. |
| 2500 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 2501 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 2502 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 2503 | "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. |
| 2504 | "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. |
| 2505 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 2506 | "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. |
| 2507 | }, |
| 2508 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 2509 | "sequence": 42, # Sequence number as per iCalendar. |
| 2510 | "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. |
| 2511 | "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. |
| 2512 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 2513 | "status": { # The status of the conference create request. |
| 2514 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 2515 | # The possible values are: |
| 2516 | # - "pending": the conference create request is still being processed. |
| 2517 | # - "success": the conference create request succeeded, the entry points are populated. |
| 2518 | # - "failure": the conference create request failed, there are no entry points. |
| 2519 | }, |
| 2520 | "requestId": "A String", # The client-generated unique ID for this request. |
| 2521 | # 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. |
| 2522 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 2523 | "type": "A String", # The conference solution type. |
| 2524 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 2525 | # The possible values are: |
| 2526 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 2527 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 2528 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 2529 | # - "addOn" for 3P conference providers |
| 2530 | }, |
| 2531 | }, |
| 2532 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 2533 | "addOnParameters": { # Additional add-on specific data. |
| 2534 | "parameters": { |
| 2535 | "a_key": "A String", |
| 2536 | }, |
| 2537 | }, |
| 2538 | }, |
| 2539 | "signature": "A String", # The signature of the conference data. |
| 2540 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 2541 | # Unset for a conference with a failed create request. |
| 2542 | # Optional for a conference with a pending create request. |
| 2543 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 2544 | # Unset for a conference with a failed create request. |
| 2545 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 2546 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 2547 | "iconUri": "A String", # The user-visible icon for this solution. |
| 2548 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 2549 | "type": "A String", # The conference solution type. |
| 2550 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 2551 | # The possible values are: |
| 2552 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 2553 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 2554 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 2555 | # - "addOn" for 3P conference providers |
| 2556 | }, |
| 2557 | }, |
| 2558 | "conferenceId": "A String", # The ID of the conference. |
| 2559 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 2560 | # Values for solution types: |
| 2561 | # - "eventHangout": unset. |
| 2562 | # - "eventNamedHangout": the name of the Hangout. |
| 2563 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 2564 | # - "addOn": defined by 3P conference provider. Optional. |
| 2565 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 2566 | # All of them must belong to the same conference. |
| 2567 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 2568 | { |
| 2569 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 2570 | # 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. |
| 2571 | # Optional. |
| 2572 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 2573 | # 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. |
| 2574 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 2577 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 2578 | # 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. |
| 2579 | # Optional. |
| 2580 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 2581 | # Examples: |
| 2582 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 2583 | # - for phone: +1 123 268 2601 |
| 2584 | # - for sip: 12345678@altostrat.com |
| 2585 | # - for more: should not be filled |
| 2586 | # Optional. |
| 2587 | "entryPointType": "A String", # The type of the conference entry point. |
| 2588 | # Possible values are: |
| 2589 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 2590 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 2591 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 2592 | # - "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. |
| 2593 | "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. |
| 2594 | "A String", |
| 2595 | ], |
| 2596 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 2597 | # 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. |
| 2598 | # Optional. |
| 2599 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 2600 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 2601 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 2602 | # Format: |
| 2603 | # - for video, http: or https: schema is required. |
| 2604 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 2605 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 2606 | # - for more, http: or https: schema is required. |
| 2607 | }, |
| 2608 | ], |
| 2609 | "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. |
| 2610 | }, |
| 2611 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 2612 | # - "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. |
| 2613 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| 2614 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| 2615 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| 2616 | "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. |
| 2617 | "displayName": "A String", # The organizer's name, if available. |
| 2618 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 2619 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 2620 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 2621 | }, |
| 2622 | "etag": "A String", # ETag of the resource. |
| 2623 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 2624 | "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. |
| 2625 | "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. |
| 2626 | # 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. |
| 2627 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 2628 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 2629 | "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. |
| 2630 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 2631 | "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. |
| 2632 | "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. |
| 2633 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 2634 | "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. |
| 2635 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 2636 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 2637 | }, |
| 2638 | "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. |
| 2639 | "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: |
| 2640 | # - 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 |
| 2641 | # - the length of the ID must be between 5 and 1024 characters |
| 2642 | # - 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. |
| 2643 | # If you do not specify an ID, it will be automatically generated by the server. |
| 2644 | # 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. |
| 2645 | } |
| 2646 | |
| 2647 | 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. |
| 2648 | supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. |
| 2649 | 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). |
| 2650 | sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.). |
| 2651 | Allowed values |
| 2652 | all - Notifications are sent to all guests. |
| 2653 | externalOnly - Notifications are sent to non-Google Calendar guests only. |
| 2654 | 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). |
| 2655 | sendNotifications: boolean, Deprecated. Please use sendUpdates instead. |
| 2656 | |
| 2657 | Whether 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. |
| 2658 | 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. |
| 2659 | |
| 2660 | Returns: |
| 2661 | An object of the form: |
| 2662 | |
| 2663 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2664 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 2665 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 2666 | # There can be at most 25 attachments per event, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2667 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2668 | "title": "A String", # Attachment title. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2669 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2670 | "fileUrl": "A String", # URL link to the attachment. |
| 2671 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 2672 | # Required when adding an attachment. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2673 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 2674 | "fileId": "A String", # ID of the attached file. Read-only. |
| 2675 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2676 | }, |
| 2677 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2678 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 2679 | "title": "A String", # The gadget's title. Deprecated. |
| 2680 | "preferences": { # Preferences. |
| 2681 | "a_key": "A String", # The preference name and corresponding value. |
| 2682 | }, |
| 2683 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 2684 | "type": "A String", # The gadget's type. Deprecated. |
| 2685 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 2686 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 2687 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 2688 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 2689 | # - "chip" - The gadget displays when the event is clicked. |
| 2690 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 2691 | }, |
| 2692 | "summary": "A String", # Title of the event. |
| 2693 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 2694 | { |
| 2695 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 2696 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 2697 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 2698 | "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. |
| 2699 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 2700 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 2701 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 2702 | "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. |
| 2703 | # Required when adding an attendee. |
| 2704 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 2705 | # - "needsAction" - The attendee has not responded to the invitation. |
| 2706 | # - "declined" - The attendee has declined the invitation. |
| 2707 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 2708 | # - "accepted" - The attendee has accepted the invitation. |
| 2709 | "comment": "A String", # The attendee's response comment. Optional. |
| 2710 | }, |
| 2711 | ], |
| 2712 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 2713 | "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. |
| 2714 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 2715 | "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. |
| 2716 | }, |
| 2717 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 2718 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 2719 | "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. |
| 2720 | { |
| 2721 | "method": "A String", # The method used by this reminder. Possible values are: |
| 2722 | # - "email" - Reminders are sent via email. |
| 2723 | # - "popup" - Reminders are sent via a UI popup. |
| 2724 | # Required when adding a reminder. |
| 2725 | "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). |
| 2726 | # Required when adding a reminder. |
| 2727 | }, |
| 2728 | ], |
| 2729 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2730 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| 2731 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2732 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2733 | "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. |
| 2734 | }, |
| 2735 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 2736 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 2737 | "extendedProperties": { # Extended properties of the event. |
| 2738 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 2739 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 2740 | }, |
| 2741 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 2742 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 2743 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2744 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2745 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 2746 | # - "confirmed" - The event is confirmed. This is the default status. |
| 2747 | # - "tentative" - The event is tentatively confirmed. |
| 2748 | # - "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. |
| 2749 | # A cancelled status represents two different states depending on the event type: |
| 2750 | # - 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. |
| 2751 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 2752 | # - 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. |
| 2753 | # 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. |
| 2754 | # 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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2755 | "creator": { # The creator of the event. Read-only. |
| 2756 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2757 | "email": "A String", # The creator's email address, if available. |
| 2758 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2759 | "displayName": "A String", # The creator's name, if available. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2760 | }, |
| 2761 | "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. |
| 2762 | "A String", |
| 2763 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2764 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 2765 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 2766 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 2767 | # - "private" - The event is private and only event attendees may view event details. |
| 2768 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 2769 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 2770 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 2771 | "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. |
| 2772 | "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. |
| 2773 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 2774 | "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. |
| 2775 | }, |
| 2776 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 2777 | "sequence": 42, # Sequence number as per iCalendar. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2778 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2779 | "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. |
| 2780 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2781 | "status": { # The status of the conference create request. |
| 2782 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 2783 | # The possible values are: |
| 2784 | # - "pending": the conference create request is still being processed. |
| 2785 | # - "success": the conference create request succeeded, the entry points are populated. |
| 2786 | # - "failure": the conference create request failed, there are no entry points. |
| 2787 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2788 | "requestId": "A String", # The client-generated unique ID for this request. |
| 2789 | # 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. |
| 2790 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 2791 | "type": "A String", # The conference solution type. |
| 2792 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 2793 | # The possible values are: |
| 2794 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 2795 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 2796 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 2797 | # - "addOn" for 3P conference providers |
| 2798 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2799 | }, |
| 2800 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 2801 | "addOnParameters": { # Additional add-on specific data. |
| 2802 | "parameters": { |
| 2803 | "a_key": "A String", |
| 2804 | }, |
| 2805 | }, |
| 2806 | }, |
| 2807 | "signature": "A String", # The signature of the conference data. |
| 2808 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 2809 | # Unset for a conference with a failed create request. |
| 2810 | # Optional for a conference with a pending create request. |
| 2811 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 2812 | # Unset for a conference with a failed create request. |
| 2813 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 2814 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 2815 | "iconUri": "A String", # The user-visible icon for this solution. |
| 2816 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 2817 | "type": "A String", # The conference solution type. |
| 2818 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 2819 | # The possible values are: |
| 2820 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 2821 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 2822 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 2823 | # - "addOn" for 3P conference providers |
| 2824 | }, |
| 2825 | }, |
| 2826 | "conferenceId": "A String", # The ID of the conference. |
| 2827 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 2828 | # Values for solution types: |
| 2829 | # - "eventHangout": unset. |
| 2830 | # - "eventNamedHangout": the name of the Hangout. |
| 2831 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 2832 | # - "addOn": defined by 3P conference provider. Optional. |
| 2833 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 2834 | # All of them must belong to the same conference. |
| 2835 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 2836 | { |
| 2837 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 2838 | # 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. |
| 2839 | # Optional. |
| 2840 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 2841 | # 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. |
| 2842 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 2845 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 2846 | # 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. |
| 2847 | # Optional. |
| 2848 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 2849 | # Examples: |
| 2850 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 2851 | # - for phone: +1 123 268 2601 |
| 2852 | # - for sip: 12345678@altostrat.com |
| 2853 | # - for more: should not be filled |
| 2854 | # Optional. |
| 2855 | "entryPointType": "A String", # The type of the conference entry point. |
| 2856 | # Possible values are: |
| 2857 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 2858 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 2859 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 2860 | # - "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. |
| 2861 | "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. |
| 2862 | "A String", |
| 2863 | ], |
| 2864 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 2865 | # 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. |
| 2866 | # Optional. |
| 2867 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 2868 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 2869 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 2870 | # Format: |
| 2871 | # - for video, http: or https: schema is required. |
| 2872 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 2873 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 2874 | # - for more, http: or https: schema is required. |
| 2875 | }, |
| 2876 | ], |
| 2877 | "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. |
| 2878 | }, |
| 2879 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 2880 | # - "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. |
| 2881 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| 2882 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| 2883 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| 2884 | "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. |
| 2885 | "displayName": "A String", # The organizer's name, if available. |
| 2886 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 2887 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 2888 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 2889 | }, |
| 2890 | "etag": "A String", # ETag of the resource. |
| 2891 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 2892 | "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. |
| 2893 | "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. |
| 2894 | # 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. |
| 2895 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 2896 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 2897 | "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. |
| 2898 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 2899 | "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. |
| 2900 | "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. |
| 2901 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 2902 | "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. |
| 2903 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 2904 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 2905 | }, |
| 2906 | "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. |
| 2907 | "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: |
| 2908 | # - 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 |
| 2909 | # - the length of the ID must be between 5 and 1024 characters |
| 2910 | # - 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. |
| 2911 | # If you do not specify an ID, it will be automatically generated by the server. |
| 2912 | # 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. |
| 2913 | }</pre> |
| 2914 | </div> |
| 2915 | |
| 2916 | <div class="method"> |
| 2917 | <code class="details" id="quickAdd">quickAdd(calendarId, text, sendUpdates=None, sendNotifications=None)</code> |
| 2918 | <pre>Creates an event based on a simple text string. |
| 2919 | |
| 2920 | Args: |
| 2921 | 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) |
| 2922 | text: string, The text describing the event to be created. (required) |
| 2923 | sendUpdates: string, Guests who should receive notifications about the creation of the new event. |
| 2924 | Allowed values |
| 2925 | all - Notifications are sent to all guests. |
| 2926 | externalOnly - Notifications are sent to non-Google Calendar guests only. |
| 2927 | 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). |
| 2928 | sendNotifications: boolean, Deprecated. Please use sendUpdates instead. |
| 2929 | |
| 2930 | Whether 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. |
| 2931 | |
| 2932 | Returns: |
| 2933 | An object of the form: |
| 2934 | |
| 2935 | { |
| 2936 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 2937 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 2938 | # There can be at most 25 attachments per event, |
| 2939 | { |
| 2940 | "title": "A String", # Attachment title. |
| 2941 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| 2942 | "fileUrl": "A String", # URL link to the attachment. |
| 2943 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 2944 | # Required when adding an attachment. |
| 2945 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 2946 | "fileId": "A String", # ID of the attached file. Read-only. |
| 2947 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| 2948 | }, |
| 2949 | ], |
| 2950 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 2951 | "title": "A String", # The gadget's title. Deprecated. |
| 2952 | "preferences": { # Preferences. |
| 2953 | "a_key": "A String", # The preference name and corresponding value. |
| 2954 | }, |
| 2955 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 2956 | "type": "A String", # The gadget's type. Deprecated. |
| 2957 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 2958 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 2959 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 2960 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 2961 | # - "chip" - The gadget displays when the event is clicked. |
| 2962 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 2963 | }, |
| 2964 | "summary": "A String", # Title of the event. |
| 2965 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 2966 | { |
| 2967 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 2968 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 2969 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 2970 | "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. |
| 2971 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 2972 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 2973 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 2974 | "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. |
| 2975 | # Required when adding an attendee. |
| 2976 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 2977 | # - "needsAction" - The attendee has not responded to the invitation. |
| 2978 | # - "declined" - The attendee has declined the invitation. |
| 2979 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 2980 | # - "accepted" - The attendee has accepted the invitation. |
| 2981 | "comment": "A String", # The attendee's response comment. Optional. |
| 2982 | }, |
| 2983 | ], |
| 2984 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 2985 | "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. |
| 2986 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 2987 | "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. |
| 2988 | }, |
| 2989 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 2990 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 2991 | "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. |
| 2992 | { |
| 2993 | "method": "A String", # The method used by this reminder. Possible values are: |
| 2994 | # - "email" - Reminders are sent via email. |
| 2995 | # - "popup" - Reminders are sent via a UI popup. |
| 2996 | # Required when adding a reminder. |
| 2997 | "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). |
| 2998 | # Required when adding a reminder. |
| 2999 | }, |
| 3000 | ], |
| 3001 | }, |
| 3002 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| 3003 | "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. |
| 3004 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 3005 | "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. |
| 3006 | }, |
| 3007 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 3008 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 3009 | "extendedProperties": { # Extended properties of the event. |
| 3010 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 3011 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 3012 | }, |
| 3013 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 3014 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 3015 | }, |
| 3016 | }, |
| 3017 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 3018 | # - "confirmed" - The event is confirmed. This is the default status. |
| 3019 | # - "tentative" - The event is tentatively confirmed. |
| 3020 | # - "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. |
| 3021 | # A cancelled status represents two different states depending on the event type: |
| 3022 | # - 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. |
| 3023 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 3024 | # - 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. |
| 3025 | # 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. |
| 3026 | # 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. |
| 3027 | "creator": { # The creator of the event. Read-only. |
| 3028 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 3029 | "email": "A String", # The creator's email address, if available. |
| 3030 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 3031 | "displayName": "A String", # The creator's name, if available. |
| 3032 | }, |
| 3033 | "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. |
| 3034 | "A String", |
| 3035 | ], |
| 3036 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 3037 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 3038 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 3039 | # - "private" - The event is private and only event attendees may view event details. |
| 3040 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 3041 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 3042 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 3043 | "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. |
| 3044 | "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. |
| 3045 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 3046 | "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. |
| 3047 | }, |
| 3048 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 3049 | "sequence": 42, # Sequence number as per iCalendar. |
| 3050 | "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. |
| 3051 | "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. |
| 3052 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3053 | "status": { # The status of the conference create request. |
| 3054 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 3055 | # The possible values are: |
| 3056 | # - "pending": the conference create request is still being processed. |
| 3057 | # - "success": the conference create request succeeded, the entry points are populated. |
| 3058 | # - "failure": the conference create request failed, there are no entry points. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3059 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3060 | "requestId": "A String", # The client-generated unique ID for this request. |
| 3061 | # 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. |
| 3062 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 3063 | "type": "A String", # The conference solution type. |
| 3064 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 3065 | # The possible values are: |
| 3066 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 3067 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 3068 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 3069 | # - "addOn" for 3P conference providers |
| 3070 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3071 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3072 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 3073 | "addOnParameters": { # Additional add-on specific data. |
| 3074 | "parameters": { |
| 3075 | "a_key": "A String", |
| 3076 | }, |
| 3077 | }, |
| 3078 | }, |
| 3079 | "signature": "A String", # The signature of the conference data. |
| 3080 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 3081 | # Unset for a conference with a failed create request. |
| 3082 | # Optional for a conference with a pending create request. |
| 3083 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 3084 | # Unset for a conference with a failed create request. |
| 3085 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 3086 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 3087 | "iconUri": "A String", # The user-visible icon for this solution. |
| 3088 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 3089 | "type": "A String", # The conference solution type. |
| 3090 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 3091 | # The possible values are: |
| 3092 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 3093 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 3094 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 3095 | # - "addOn" for 3P conference providers |
| 3096 | }, |
| 3097 | }, |
| 3098 | "conferenceId": "A String", # The ID of the conference. |
| 3099 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 3100 | # Values for solution types: |
| 3101 | # - "eventHangout": unset. |
| 3102 | # - "eventNamedHangout": the name of the Hangout. |
| 3103 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 3104 | # - "addOn": defined by 3P conference provider. Optional. |
| 3105 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 3106 | # All of them must belong to the same conference. |
| 3107 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3108 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3109 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 3110 | # 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. |
| 3111 | # Optional. |
| 3112 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 3113 | # 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. |
| 3114 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 3117 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 3118 | # 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. |
| 3119 | # Optional. |
| 3120 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 3121 | # Examples: |
| 3122 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 3123 | # - for phone: +1 123 268 2601 |
| 3124 | # - for sip: 12345678@altostrat.com |
| 3125 | # - for more: should not be filled |
| 3126 | # Optional. |
| 3127 | "entryPointType": "A String", # The type of the conference entry point. |
| 3128 | # Possible values are: |
| 3129 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 3130 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 3131 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 3132 | # - "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. |
| 3133 | "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. |
| 3134 | "A String", |
| 3135 | ], |
| 3136 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 3137 | # 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. |
| 3138 | # Optional. |
| 3139 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 3140 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 3141 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 3142 | # Format: |
| 3143 | # - for video, http: or https: schema is required. |
| 3144 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 3145 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 3146 | # - for more, http: or https: schema is required. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3147 | }, |
| 3148 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3149 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3150 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3151 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 3152 | # - "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. |
| 3153 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3154 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3155 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3156 | "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. |
| 3157 | "displayName": "A String", # The organizer's name, if available. |
| 3158 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 3159 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 3160 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 3161 | }, |
| 3162 | "etag": "A String", # ETag of the resource. |
| 3163 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 3164 | "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. |
| 3165 | "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. |
| 3166 | # 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. |
| 3167 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 3168 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 3169 | "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. |
| 3170 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 3171 | "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. |
| 3172 | "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. |
| 3173 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 3174 | "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. |
| 3175 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 3176 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 3177 | }, |
| 3178 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3179 | "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: |
| 3180 | # - 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 |
| 3181 | # - the length of the ID must be between 5 and 1024 characters |
| 3182 | # - 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. |
| 3183 | # If you do not specify an ID, it will be automatically generated by the server. |
| 3184 | # 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3185 | }</pre> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3186 | </div> |
| 3187 | |
| 3188 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3189 | <code class="details" id="update">update(calendarId, eventId, body=None, supportsAttachments=None, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None, sendUpdates=None, conferenceDataVersion=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3190 | <pre>Updates an event. |
| 3191 | |
| 3192 | Args: |
| 3193 | 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) |
| 3194 | eventId: string, Event identifier. (required) |
| 3195 | body: object, The request body. |
| 3196 | The object takes the form of: |
| 3197 | |
| 3198 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3199 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 3200 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 3201 | # There can be at most 25 attachments per event, |
| 3202 | { |
| 3203 | "title": "A String", # Attachment title. |
| 3204 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| 3205 | "fileUrl": "A String", # URL link to the attachment. |
| 3206 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 3207 | # Required when adding an attachment. |
| 3208 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 3209 | "fileId": "A String", # ID of the attached file. Read-only. |
| 3210 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| 3211 | }, |
| 3212 | ], |
| 3213 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 3214 | "title": "A String", # The gadget's title. Deprecated. |
| 3215 | "preferences": { # Preferences. |
| 3216 | "a_key": "A String", # The preference name and corresponding value. |
| 3217 | }, |
| 3218 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 3219 | "type": "A String", # The gadget's type. Deprecated. |
| 3220 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 3221 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 3222 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 3223 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 3224 | # - "chip" - The gadget displays when the event is clicked. |
| 3225 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 3226 | }, |
| 3227 | "summary": "A String", # Title of the event. |
| 3228 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 3229 | { |
| 3230 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 3231 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 3232 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 3233 | "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. |
| 3234 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 3235 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 3236 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 3237 | "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. |
| 3238 | # Required when adding an attendee. |
| 3239 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 3240 | # - "needsAction" - The attendee has not responded to the invitation. |
| 3241 | # - "declined" - The attendee has declined the invitation. |
| 3242 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 3243 | # - "accepted" - The attendee has accepted the invitation. |
| 3244 | "comment": "A String", # The attendee's response comment. Optional. |
| 3245 | }, |
| 3246 | ], |
| 3247 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 3248 | "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. |
| 3249 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 3250 | "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. |
| 3251 | }, |
| 3252 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 3253 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 3254 | "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. |
| 3255 | { |
| 3256 | "method": "A String", # The method used by this reminder. Possible values are: |
| 3257 | # - "email" - Reminders are sent via email. |
| 3258 | # - "popup" - Reminders are sent via a UI popup. |
| 3259 | # Required when adding a reminder. |
| 3260 | "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). |
| 3261 | # Required when adding a reminder. |
| 3262 | }, |
| 3263 | ], |
| 3264 | }, |
| 3265 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| 3266 | "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. |
| 3267 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 3268 | "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. |
| 3269 | }, |
| 3270 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 3271 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 3272 | "extendedProperties": { # Extended properties of the event. |
| 3273 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 3274 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 3275 | }, |
| 3276 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 3277 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 3278 | }, |
| 3279 | }, |
| 3280 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 3281 | # - "confirmed" - The event is confirmed. This is the default status. |
| 3282 | # - "tentative" - The event is tentatively confirmed. |
| 3283 | # - "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. |
| 3284 | # A cancelled status represents two different states depending on the event type: |
| 3285 | # - 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. |
| 3286 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 3287 | # - 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. |
| 3288 | # 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. |
| 3289 | # 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. |
| 3290 | "creator": { # The creator of the event. Read-only. |
| 3291 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 3292 | "email": "A String", # The creator's email address, if available. |
| 3293 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 3294 | "displayName": "A String", # The creator's name, if available. |
| 3295 | }, |
| 3296 | "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. |
| 3297 | "A String", |
| 3298 | ], |
| 3299 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 3300 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 3301 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 3302 | # - "private" - The event is private and only event attendees may view event details. |
| 3303 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 3304 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 3305 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 3306 | "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. |
| 3307 | "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. |
| 3308 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 3309 | "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. |
| 3310 | }, |
| 3311 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 3312 | "sequence": 42, # Sequence number as per iCalendar. |
| 3313 | "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. |
| 3314 | "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. |
| 3315 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 3316 | "status": { # The status of the conference create request. |
| 3317 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 3318 | # The possible values are: |
| 3319 | # - "pending": the conference create request is still being processed. |
| 3320 | # - "success": the conference create request succeeded, the entry points are populated. |
| 3321 | # - "failure": the conference create request failed, there are no entry points. |
| 3322 | }, |
| 3323 | "requestId": "A String", # The client-generated unique ID for this request. |
| 3324 | # 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. |
| 3325 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 3326 | "type": "A String", # The conference solution type. |
| 3327 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 3328 | # The possible values are: |
| 3329 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 3330 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 3331 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 3332 | # - "addOn" for 3P conference providers |
| 3333 | }, |
| 3334 | }, |
| 3335 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 3336 | "addOnParameters": { # Additional add-on specific data. |
| 3337 | "parameters": { |
| 3338 | "a_key": "A String", |
| 3339 | }, |
| 3340 | }, |
| 3341 | }, |
| 3342 | "signature": "A String", # The signature of the conference data. |
| 3343 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 3344 | # Unset for a conference with a failed create request. |
| 3345 | # Optional for a conference with a pending create request. |
| 3346 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 3347 | # Unset for a conference with a failed create request. |
| 3348 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 3349 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 3350 | "iconUri": "A String", # The user-visible icon for this solution. |
| 3351 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 3352 | "type": "A String", # The conference solution type. |
| 3353 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 3354 | # The possible values are: |
| 3355 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 3356 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 3357 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 3358 | # - "addOn" for 3P conference providers |
| 3359 | }, |
| 3360 | }, |
| 3361 | "conferenceId": "A String", # The ID of the conference. |
| 3362 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 3363 | # Values for solution types: |
| 3364 | # - "eventHangout": unset. |
| 3365 | # - "eventNamedHangout": the name of the Hangout. |
| 3366 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 3367 | # - "addOn": defined by 3P conference provider. Optional. |
| 3368 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 3369 | # All of them must belong to the same conference. |
| 3370 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 3371 | { |
| 3372 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 3373 | # 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. |
| 3374 | # Optional. |
| 3375 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 3376 | # 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. |
| 3377 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 3380 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 3381 | # 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. |
| 3382 | # Optional. |
| 3383 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 3384 | # Examples: |
| 3385 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 3386 | # - for phone: +1 123 268 2601 |
| 3387 | # - for sip: 12345678@altostrat.com |
| 3388 | # - for more: should not be filled |
| 3389 | # Optional. |
| 3390 | "entryPointType": "A String", # The type of the conference entry point. |
| 3391 | # Possible values are: |
| 3392 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 3393 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 3394 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 3395 | # - "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. |
| 3396 | "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. |
| 3397 | "A String", |
| 3398 | ], |
| 3399 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 3400 | # 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. |
| 3401 | # Optional. |
| 3402 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 3403 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 3404 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 3405 | # Format: |
| 3406 | # - for video, http: or https: schema is required. |
| 3407 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 3408 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 3409 | # - for more, http: or https: schema is required. |
| 3410 | }, |
| 3411 | ], |
| 3412 | "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. |
| 3413 | }, |
| 3414 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 3415 | # - "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. |
| 3416 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| 3417 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| 3418 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| 3419 | "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. |
| 3420 | "displayName": "A String", # The organizer's name, if available. |
| 3421 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 3422 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 3423 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 3424 | }, |
| 3425 | "etag": "A String", # ETag of the resource. |
| 3426 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 3427 | "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. |
| 3428 | "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. |
| 3429 | # 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. |
| 3430 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 3431 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 3432 | "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. |
| 3433 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 3434 | "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. |
| 3435 | "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. |
| 3436 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 3437 | "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. |
| 3438 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 3439 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 3440 | }, |
| 3441 | "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. |
| 3442 | "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: |
| 3443 | # - 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 |
| 3444 | # - the length of the ID must be between 5 and 1024 characters |
| 3445 | # - 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. |
| 3446 | # If you do not specify an ID, it will be automatically generated by the server. |
| 3447 | # 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. |
| 3448 | } |
| 3449 | |
| 3450 | supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. |
| 3451 | sendNotifications: boolean, Deprecated. Please use sendUpdates instead. |
| 3452 | |
| 3453 | Whether 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. |
| 3454 | 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). |
| 3455 | 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. |
| 3456 | sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.). |
| 3457 | Allowed values |
| 3458 | all - Notifications are sent to all guests. |
| 3459 | externalOnly - Notifications are sent to non-Google Calendar guests only. |
| 3460 | 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). |
| 3461 | 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. |
| 3462 | |
| 3463 | Returns: |
| 3464 | An object of the form: |
| 3465 | |
| 3466 | { |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3467 | "attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported. |
| 3468 | # In order to modify attachments the supportsAttachments request parameter should be set to true. |
| 3469 | # There can be at most 25 attachments per event, |
| 3470 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3471 | "title": "A String", # Attachment title. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3472 | "iconLink": "A String", # URL link to the attachment's icon. Read-only. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3473 | "fileUrl": "A String", # URL link to the attachment. |
| 3474 | # For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. |
| 3475 | # Required when adding an attachment. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3476 | "mimeType": "A String", # Internet media type (MIME type) of the attachment. |
| 3477 | "fileId": "A String", # ID of the attached file. Read-only. |
| 3478 | # For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3479 | }, |
| 3480 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3481 | "gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
| 3482 | "title": "A String", # The gadget's title. Deprecated. |
| 3483 | "preferences": { # Preferences. |
| 3484 | "a_key": "A String", # The preference name and corresponding value. |
| 3485 | }, |
| 3486 | "width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. |
| 3487 | "type": "A String", # The gadget's type. Deprecated. |
| 3488 | "iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. |
| 3489 | "height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. |
| 3490 | "display": "A String", # The gadget's display mode. Deprecated. Possible values are: |
| 3491 | # - "icon" - The gadget displays next to the event's title in the calendar view. |
| 3492 | # - "chip" - The gadget displays when the event is clicked. |
| 3493 | "link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated. |
| 3494 | }, |
| 3495 | "summary": "A String", # Title of the event. |
| 3496 | "attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. |
| 3497 | { |
| 3498 | "optional": false, # Whether this is an optional attendee. Optional. The default is False. |
| 3499 | "self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. |
| 3500 | "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False. |
| 3501 | "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. |
| 3502 | "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. |
| 3503 | "displayName": "A String", # The attendee's name, if available. Optional. |
| 3504 | "id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 3505 | "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. |
| 3506 | # Required when adding an attendee. |
| 3507 | "responseStatus": "A String", # The attendee's response status. Possible values are: |
| 3508 | # - "needsAction" - The attendee has not responded to the invitation. |
| 3509 | # - "declined" - The attendee has declined the invitation. |
| 3510 | # - "tentative" - The attendee has tentatively accepted the invitation. |
| 3511 | # - "accepted" - The attendee has accepted the invitation. |
| 3512 | "comment": "A String", # The attendee's response comment. Optional. |
| 3513 | }, |
| 3514 | ], |
| 3515 | "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
| 3516 | "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. |
| 3517 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 3518 | "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. |
| 3519 | }, |
| 3520 | "reminders": { # Information about the event's reminders for the authenticated user. |
| 3521 | "useDefault": True or False, # Whether the default reminders of the calendar apply to the event. |
| 3522 | "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. |
| 3523 | { |
| 3524 | "method": "A String", # The method used by this reminder. Possible values are: |
| 3525 | # - "email" - Reminders are sent via email. |
| 3526 | # - "popup" - Reminders are sent via a UI popup. |
| 3527 | # Required when adding a reminder. |
| 3528 | "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). |
| 3529 | # Required when adding a reminder. |
| 3530 | }, |
| 3531 | ], |
| 3532 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3533 | "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3534 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3535 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3536 | "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. |
| 3537 | }, |
| 3538 | "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. |
| 3539 | "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. |
| 3540 | "extendedProperties": { # Extended properties of the event. |
| 3541 | "private": { # Properties that are private to the copy of the event that appears on this calendar. |
| 3542 | "a_key": "A String", # The name of the private property and the corresponding value. |
| 3543 | }, |
| 3544 | "shared": { # Properties that are shared between copies of the event on other attendees' calendars. |
| 3545 | "a_key": "A String", # The name of the shared property and the corresponding value. |
| 3546 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3547 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3548 | "status": "A String", # Status of the event. Optional. Possible values are: |
| 3549 | # - "confirmed" - The event is confirmed. This is the default status. |
| 3550 | # - "tentative" - The event is tentatively confirmed. |
| 3551 | # - "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. |
| 3552 | # A cancelled status represents two different states depending on the event type: |
| 3553 | # - 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. |
| 3554 | # Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. |
| 3555 | # - 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. |
| 3556 | # 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. |
| 3557 | # 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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3558 | "creator": { # The creator of the event. Read-only. |
| 3559 | "id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3560 | "email": "A String", # The creator's email address, if available. |
| 3561 | "self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3562 | "displayName": "A String", # The creator's name, if available. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3563 | }, |
| 3564 | "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. |
| 3565 | "A String", |
| 3566 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3567 | "visibility": "default", # Visibility of the event. Optional. Possible values are: |
| 3568 | # - "default" - Uses the default visibility for events on the calendar. This is the default value. |
| 3569 | # - "public" - The event is public and event details are visible to all readers of the calendar. |
| 3570 | # - "private" - The event is private and only event attendees may view event details. |
| 3571 | # - "confidential" - The event is private. This value is provided for compatibility reasons. |
| 3572 | "location": "A String", # Geographic location of the event as free-form text. Optional. |
| 3573 | "guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. |
| 3574 | "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. |
| 3575 | "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. |
| 3576 | "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event. |
| 3577 | "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. |
| 3578 | }, |
| 3579 | "kind": "calendar#event", # Type of the resource ("calendar#event"). |
| 3580 | "sequence": 42, # Sequence number as per iCalendar. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3581 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3582 | "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. |
| 3583 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3584 | "status": { # The status of the conference create request. |
| 3585 | "statusCode": "A String", # The current status of the conference create request. Read-only. |
| 3586 | # The possible values are: |
| 3587 | # - "pending": the conference create request is still being processed. |
| 3588 | # - "success": the conference create request succeeded, the entry points are populated. |
| 3589 | # - "failure": the conference create request failed, there are no entry points. |
| 3590 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3591 | "requestId": "A String", # The client-generated unique ID for this request. |
| 3592 | # 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. |
| 3593 | "conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet. |
| 3594 | "type": "A String", # The conference solution type. |
| 3595 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 3596 | # The possible values are: |
| 3597 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 3598 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 3599 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 3600 | # - "addOn" for 3P conference providers |
| 3601 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3602 | }, |
| 3603 | "parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. |
| 3604 | "addOnParameters": { # Additional add-on specific data. |
| 3605 | "parameters": { |
| 3606 | "a_key": "A String", |
| 3607 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3608 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3609 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3610 | "signature": "A String", # The signature of the conference data. |
| 3611 | # Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| 3612 | # Unset for a conference with a failed create request. |
| 3613 | # Optional for a conference with a pending create request. |
| 3614 | "conferenceSolution": { # The conference solution, such as Hangouts or Google Meet. |
| 3615 | # Unset for a conference with a failed create request. |
| 3616 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| 3617 | "name": "A String", # The user-visible name of this solution. Not localized. |
| 3618 | "iconUri": "A String", # The user-visible icon for this solution. |
| 3619 | "key": { # The key which can uniquely identify the conference solution for this event. |
| 3620 | "type": "A String", # The conference solution type. |
| 3621 | # If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. |
| 3622 | # The possible values are: |
| 3623 | # - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) |
| 3624 | # - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com) |
| 3625 | # - "hangoutsMeet" for Google Meet (http://meet.google.com) |
| 3626 | # - "addOn" for 3P conference providers |
| 3627 | }, |
| 3628 | }, |
| 3629 | "conferenceId": "A String", # The ID of the conference. |
| 3630 | # Can be used by developers to keep track of conferences, should not be displayed to users. |
| 3631 | # Values for solution types: |
| 3632 | # - "eventHangout": unset. |
| 3633 | # - "eventNamedHangout": the name of the Hangout. |
| 3634 | # - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". |
| 3635 | # - "addOn": defined by 3P conference provider. Optional. |
| 3636 | "entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers. |
| 3637 | # All of them must belong to the same conference. |
| 3638 | # Either conferenceSolution and at least one entryPoint, or createRequest is required. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3639 | { |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3640 | "password": "A String", # The password to access the conference. The maximum length is 128 characters. |
| 3641 | # 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. |
| 3642 | # Optional. |
| 3643 | "passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters. |
| 3644 | # 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. |
| 3645 | "meetingCode": "A String", # The meeting code 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 | # Optional. |
| 3648 | "pin": "A String", # The PIN to access the conference. The maximum length is 128 characters. |
| 3649 | # 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. |
| 3650 | # Optional. |
| 3651 | "label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. |
| 3652 | # Examples: |
| 3653 | # - for video: meet.google.com/aaa-bbbb-ccc |
| 3654 | # - for phone: +1 123 268 2601 |
| 3655 | # - for sip: 12345678@altostrat.com |
| 3656 | # - for more: should not be filled |
| 3657 | # Optional. |
| 3658 | "entryPointType": "A String", # The type of the conference entry point. |
| 3659 | # Possible values are: |
| 3660 | # - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. |
| 3661 | # - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. |
| 3662 | # - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. |
| 3663 | # - "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. |
| 3664 | "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. |
| 3665 | "A String", |
| 3666 | ], |
| 3667 | "accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters. |
| 3668 | # 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. |
| 3669 | # Optional. |
| 3670 | "regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. |
| 3671 | # Calendar backend will populate this field only for EntryPointType.PHONE. |
| 3672 | "uri": "A String", # The URI of the entry point. The maximum length is 1300 characters. |
| 3673 | # Format: |
| 3674 | # - for video, http: or https: schema is required. |
| 3675 | # - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). |
| 3676 | # - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. |
| 3677 | # - for more, http: or https: schema is required. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3678 | }, |
| 3679 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3680 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3681 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3682 | "transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: |
| 3683 | # - "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. |
| 3684 | # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3685 | "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3686 | "description": "A String", # Description of the event. Can contain HTML. Optional. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3687 | "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. |
| 3688 | "displayName": "A String", # The organizer's name, if available. |
| 3689 | "self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. |
| 3690 | "email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322. |
| 3691 | "id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API |
| 3692 | }, |
| 3693 | "etag": "A String", # ETag of the resource. |
| 3694 | "guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
| 3695 | "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. |
| 3696 | "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. |
| 3697 | # 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. |
| 3698 | "guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False. |
| 3699 | "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only. |
| 3700 | "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. |
| 3701 | "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. |
| 3702 | "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. |
| 3703 | "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. |
| 3704 | "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. |
| 3705 | "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. |
| 3706 | "url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| 3707 | "title": "A String", # Title of the source; for example a title of a web page or an email subject. |
| 3708 | }, |
| 3709 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3710 | "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: |
| 3711 | # - 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 |
| 3712 | # - the length of the ID must be between 5 and 1024 characters |
| 3713 | # - 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. |
| 3714 | # If you do not specify an ID, it will be automatically generated by the server. |
| 3715 | # 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3716 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3717 | </div> |
| 3718 | |
| 3719 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3720 | <code class="details" id="watch">watch(calendarId, body=None, sharedExtendedProperty=None, q=None, timeMin=None, showDeleted=None, privateExtendedProperty=None, iCalUID=None, timeMax=None, updatedMin=None, singleEvents=None, syncToken=None, alwaysIncludeEmail=None, timeZone=None, pageToken=None, showHiddenInvitations=None, orderBy=None, maxResults=None, maxAttendees=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3721 | <pre>Watch for changes to Events resources. |
| 3722 | |
| 3723 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3724 | 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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3725 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3726 | The object takes the form of: |
| 3727 | |
| 3728 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3729 | "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
| 3730 | "address": "A String", # The address where notifications are delivered for this channel. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3731 | "id": "A String", # A UUID or similar unique string that identifies this channel. |
| 3732 | "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 3733 | "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 3734 | "resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 3735 | "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 3736 | "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3737 | "type": "A String", # The type of delivery mechanism used for this channel. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3738 | "params": { # Additional parameters controlling delivery channel behavior. Optional. |
| 3739 | "a_key": "A String", # Declares a new parameter by name. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3740 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3741 | } |
| 3742 | |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3743 | 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) |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3744 | q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3745 | 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. |
| 3746 | 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. |
| 3747 | 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) |
| 3748 | iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional. |
| 3749 | 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. |
| 3750 | 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. |
| 3751 | singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 3752 | 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. |
| 3753 | There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. |
| 3754 | |
| 3755 | These are: |
| 3756 | - iCalUID |
| 3757 | - orderBy |
| 3758 | - privateExtendedProperty |
| 3759 | - q |
| 3760 | - sharedExtendedProperty |
| 3761 | - timeMin |
| 3762 | - timeMax |
| 3763 | - 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. |
| 3764 | Learn more about incremental synchronization. |
| 3765 | Optional. The default is to return all entries. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3766 | 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). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3767 | timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar. |
| 3768 | pageToken: string, Token specifying which result page to return. Optional. |
| 3769 | showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 3770 | orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order. |
| 3771 | Allowed values |
| 3772 | startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True) |
| 3773 | updated - Order by last modification time (ascending). |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3774 | 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. |
| 3775 | 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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3776 | |
| 3777 | Returns: |
| 3778 | An object of the form: |
| 3779 | |
| 3780 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3781 | "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
| 3782 | "address": "A String", # The address where notifications are delivered for this channel. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 3783 | "id": "A String", # A UUID or similar unique string that identifies this channel. |
| 3784 | "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 3785 | "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 3786 | "resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 3787 | "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 3788 | "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3789 | "type": "A String", # The type of delivery mechanism used for this channel. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3790 | "params": { # Additional parameters controlling delivery channel behavior. Optional. |
| 3791 | "a_key": "A String", # Declares a new parameter by name. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3792 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3793 | }</pre> |
| 3794 | </div> |
| 3795 | |
| 3796 | </body></html> |