Blame - docs/dyn/calendar_v3.events.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

88

<p class="firstline">Creates an event.</p>

89

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

90

<code><a href="#instances">instances(calendarId, eventId, maxResults=None, timeZone=None, alwaysIncludeEmail=None, originalStart=None, timeMin=None, timeMax=None, maxAttendees=None, pageToken=None, showDeleted=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

91

<p class="firstline">Returns instances of the specified recurring event.</p>

92

93

<code><a href="#instances_next">instances_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

96

<code><a href="#list">list(calendarId, sharedExtendedProperty=None, maxResults=None, timeZone=None, pageToken=None, orderBy=None, timeMax=None, timeMin=None, syncToken=None, alwaysIncludeEmail=None, singleEvents=None, updatedMin=None, q=None, privateExtendedProperty=None, maxAttendees=None, showDeleted=None, showHiddenInvitations=None, iCalUID=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

97

<p class="firstline">Returns events on the specified calendar.</p>

98

99

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

100

<p class="firstline">Retrieves the next page of results.</p>

101

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

102

<code><a href="#move">move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

103

<p class="firstline">Moves an event to another calendar, i.e. changes an event's organizer.</p>

104

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

105

<code><a href="#patch">patch(calendarId, eventId, body=None, conferenceDataVersion=None, maxAttendees=None, supportsAttachments=None, sendUpdates=None, alwaysIncludeEmail=None, sendNotifications=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

106

<p class="firstline">Updates an event. This method supports patch semantics.</p>

107

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

108

<code><a href="#quickAdd">quickAdd(calendarId, text, sendUpdates=None, sendNotifications=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

109

<p class="firstline">Creates an event based on a simple text string.</p>

110

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

111

<code><a href="#update">update(calendarId, eventId, body=None, alwaysIncludeEmail=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None, maxAttendees=None, conferenceDataVersion=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

112

<p class="firstline">Updates an event.</p>

113

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

114

<code><a href="#watch">watch(calendarId, body=None, maxAttendees=None, privateExtendedProperty=None, q=None, updatedMin=None, maxResults=None, timeMin=None, orderBy=None, singleEvents=None, timeMax=None, syncToken=None, timeZone=None, pageToken=None, sharedExtendedProperty=None, showHiddenInvitations=None, alwaysIncludeEmail=None, iCalUID=None, showDeleted=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

115

<p class="firstline">Watch for changes to Events resources.</p>

116

<h3>Method Details</h3>

117

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

118

<code class="details" id="delete">delete(calendarId, eventId, sendUpdates=None, sendNotifications=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

119

<pre>Deletes an event.

120

121

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

122

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

2014-04-24 15:46:26 -0400

[diff] [blame]

123

eventId: string, Event identifier. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

124

sendUpdates: string, Guests who should receive notifications about the deletion of the event.

125

Allowed values

126

all - Notifications are sent to all guests.

127

externalOnly - Notifications are sent to non-Google Calendar guests only.

128

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).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

129

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

130

131

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

2014-04-24 15:46:26 -0400

[diff] [blame]

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

136

<code class="details" id="get">get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

137

<pre>Returns an event.

138

139

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

140

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

2014-04-24 15:46:26 -0400

[diff] [blame]

141

eventId: string, Event identifier. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

142

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).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

143

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

144

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

145

146

Returns:

147

An object of the form:

148

149

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

150

"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.

151

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

152

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

153

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

154

"displayName": "A String", # The organizer's name, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

155

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

156

"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.

157

"summary": "A String", # Title of the event.

158

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

159

"location": "A String", # Geographic location of the event as free-form text. Optional.

160

"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.

161

"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.

162

"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.

163

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

164

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

165

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

166

"gadget": { # A gadget that extends this event.

167

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

168

"display": "A String", # The gadget's display mode. Optional. Possible values are:

169

# - "icon" - The gadget displays next to the event's title in the calendar view.

170

# - "chip" - The gadget displays when the event is clicked.

171

"title": "A String", # The gadget's title.

172

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

173

"preferences": { # Preferences.

174

"a_key": "A String", # The preference name and corresponding value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

175

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

176

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

177

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

178

"type": "A String", # The gadget's type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

179

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

180

"sequence": 42, # Sequence number as per iCalendar.

181

"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.

182

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

183

"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.

184

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

185

"etag": "A String", # ETag of the resource.

186

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

187

"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:

188

# - 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

189

# - the length of the ID must be between 5 and 1024 characters

190

# - 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.

191

# If you do not specify an ID, it will be automatically generated by the server.

192

# 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.

193

"visibility": "default", # Visibility of the event. Optional. Possible values are:

194

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

195

# - "public" - The event is public and event details are visible to all readers of the calendar.

196

# - "private" - The event is private and only event attendees may view event details.

197

# - "confidential" - The event is private. This value is provided for compatibility reasons.

198

"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.

199

"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.

200

"A String",

201

],

202

"description": "A String", # Description of the event. Can contain HTML. Optional.

203

"reminders": { # Information about the event's reminders for the authenticated user.

204

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

205

"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.

206

{

207

"method": "A String", # The method used by this reminder. Possible values are:

208

# - "email" - Reminders are sent via email.

209

# - "popup" - Reminders are sent via a UI popup.

210

# Required when adding a reminder.

211

"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).

212

# Required when adding a reminder.

213

},

214

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

215

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

216

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

217

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

218

"displayName": "A String", # The attendee's name, if available. Optional.

219

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

220

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

221

"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.

222

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

223

"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.

224

# Required when adding an attendee.

225

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

226

"responseStatus": "A String", # The attendee's response status. Possible values are:

227

# - "needsAction" - The attendee has not responded to the invitation.

228

# - "declined" - The attendee has declined the invitation.

229

# - "tentative" - The attendee has tentatively accepted the invitation.

230

# - "accepted" - The attendee has accepted the invitation.

231

"comment": "A String", # The attendee's response comment. Optional.

232

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

233

},

234

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

235

"kind": "calendar#event", # Type of the resource ("calendar#event").

236

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

237

"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.

238

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

239

"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.

240

},

241

"creator": { # The creator of the event. Read-only.

242

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

243

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

244

"displayName": "A String", # The creator's name, if available.

245

"email": "A String", # The creator's email address, if available.

246

},

247

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

248

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

249

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

250

"status": "A String", # Status of the event. Optional. Possible values are:

251

# - "confirmed" - The event is confirmed. This is the default status.

252

# - "tentative" - The event is tentatively confirmed.

253

# - "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.

254

# A cancelled status represents two different states depending on the event type:

255

# - 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.

256

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

257

# - 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.

258

# 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.

259

# 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.

260

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

261

# In order to modify attachments the supportsAttachments request parameter should be set to true.

262

# There can be at most 25 attachments per event,

263

{

264

"fileId": "A String", # ID of the attached file. Read-only.

265

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

266

"title": "A String", # Attachment title.

267

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

268

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

269

"fileUrl": "A String", # URL link to the attachment.

270

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

271

# Required when adding an attachment.

272

},

273

],

274

"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.

275

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

276

"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.

277

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

278

"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.

279

},

280

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

281

# - "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.

282

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

283

"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.

284

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

285

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

286

},

287

"extendedProperties": { # Extended properties of the event.

288

"private": { # Properties that are private to the copy of the event that appears on this calendar.

289

"a_key": "A String", # The name of the private property and the corresponding value.

290

},

291

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

292

"a_key": "A String", # The name of the shared property and the corresponding value.

293

},

294

},

295

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

296

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

297

"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.

298

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

299

# Unset for a conference with a failed create request.

300

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

301

"key": { # The key which can uniquely identify the conference solution for this event.

302

"type": "A String", # The conference solution type.

303

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

304

# The possible values are:

305

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

306

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

307

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

308

# - "addOn" for 3P conference providers

309

},

310

"iconUri": "A String", # The user-visible icon for this solution.

311

"name": "A String", # The user-visible name of this solution. Not localized.

312

},

313

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

314

"addOnParameters": { # Additional add-on specific data.

315

"parameters": {

316

"a_key": "A String",

317

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

318

},

319

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

320

"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.

321

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

322

"status": { # The status of the conference create request.

323

"statusCode": "A String", # The current status of the conference create request. Read-only.

324

# The possible values are:

325

# - "pending": the conference create request is still being processed.

326

# - "success": the conference create request succeeded, the entry points are populated.

327

# - "failure": the conference create request failed, there are no entry points.

328

},

329

"requestId": "A String", # The client-generated unique ID for this request.

330

# 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.

331

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

332

"type": "A String", # The conference solution type.

333

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

334

# The possible values are:

335

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

336

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

337

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

338

# - "addOn" for 3P conference providers

339

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

340

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

341

"conferenceId": "A String", # The ID of the conference.

342

# Can be used by developers to keep track of conferences, should not be displayed to users.

343

# Values for solution types:

344

# - "eventHangout": unset.

345

# - "eventNamedHangout": the name of the Hangout.

346

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

347

# - "addOn": defined by 3P conference provider. Optional.

348

"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.

349

"signature": "A String", # The signature of the conference data.

350

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

351

# Unset for a conference with a failed create request.

352

# Optional for a conference with a pending create request.

353

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

354

# All of them must belong to the same conference.

355

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

356

{

357

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

358

# Format:

359

# - for video, http: or https: schema is required.

360

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

361

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

362

# - for more, http: or https: schema is required.

363

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

364

# 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.

365

# Optional.

366

"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.

367

"A String",

368

],

369

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

370

# 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.

371

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

372

# 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.

373

# Optional.

374

"entryPointType": "A String", # The type of the conference entry point.

375

# Possible values are:

376

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

377

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

378

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

379

# - "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.

380

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

381

# 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.

382

# Optional.

383

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

384

# Calendar backend will populate this field only for EntryPointType.PHONE.

385

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

386

# Examples:

387

# - for video: meet.google.com/aaa-bbbb-ccc

388

# - for phone: +1 123 268 2601

389

# - for sip: 12345678@altostrat.com

390

# - for more: should not be filled

391

# Optional.

392

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

393

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

399

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

403

<code class="details" id="import_">import_(calendarId, body=None, supportsAttachments=None, conferenceDataVersion=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

404

<pre>Imports an event. This operation is used to add a private copy of an existing event to a calendar.

405

406

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

407

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]

408

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

409

The object takes the form of:

410

411

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

412

"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.

413

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

414

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

415

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

416

"displayName": "A String", # The organizer's name, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

417

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

418

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

419

"summary": "A String", # Title of the event.

420

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

421

"location": "A String", # Geographic location of the event as free-form text. Optional.

422

"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.

423

"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.

424

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

425

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

426

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

427

},

428

"gadget": { # A gadget that extends this event.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

429

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

430

"display": "A String", # The gadget's display mode. Optional. Possible values are:

431

# - "icon" - The gadget displays next to the event's title in the calendar view.

432

# - "chip" - The gadget displays when the event is clicked.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

433

"title": "A String", # The gadget's title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

434

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

435

"preferences": { # Preferences.

436

"a_key": "A String", # The preference name and corresponding value.

437

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

438

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

439

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

440

"type": "A String", # The gadget's type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

441

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

442

"sequence": 42, # Sequence number as per iCalendar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

443

"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.

444

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

445

"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.

446

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

447

"etag": "A String", # ETag of the resource.

448

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

449

"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:

450

# - 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

451

# - the length of the ID must be between 5 and 1024 characters

452

# - 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.

453

# If you do not specify an ID, it will be automatically generated by the server.

454

# 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

455

"visibility": "default", # Visibility of the event. Optional. Possible values are:

456

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

457

# - "public" - The event is public and event details are visible to all readers of the calendar.

458

# - "private" - The event is private and only event attendees may view event details.

459

# - "confidential" - The event is private. This value is provided for compatibility reasons.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

460

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

461

"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.

462

"A String",

463

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

464

"description": "A String", # Description of the event. Can contain HTML. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

465

"reminders": { # Information about the event's reminders for the authenticated user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

466

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

467

"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.

468

{

469

"method": "A String", # The method used by this reminder. Possible values are:

470

# - "email" - Reminders are sent via email.

471

# - "popup" - Reminders are sent via a UI popup.

472

# Required when adding a reminder.

473

"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).

474

# Required when adding a reminder.

475

},

476

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

477

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

478

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

479

{

480

"displayName": "A String", # The attendee's name, if available. Optional.

481

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

482

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

483

"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.

484

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

485

"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.

486

# Required when adding an attendee.

487

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

488

"responseStatus": "A String", # The attendee's response status. Possible values are:

489

# - "needsAction" - The attendee has not responded to the invitation.

490

# - "declined" - The attendee has declined the invitation.

491

# - "tentative" - The attendee has tentatively accepted the invitation.

492

# - "accepted" - The attendee has accepted the invitation.

493

"comment": "A String", # The attendee's response comment. Optional.

494

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

495

},

496

],

497

"kind": "calendar#event", # Type of the resource ("calendar#event").

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

498

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

499

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

500

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

501

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

502

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

503

"creator": { # The creator of the event. Read-only.

504

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

505

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

506

"displayName": "A String", # The creator's name, if available.

507

"email": "A String", # The creator's email address, if available.

508

},

509

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

510

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

511

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

512

"status": "A String", # Status of the event. Optional. Possible values are:

513

# - "confirmed" - The event is confirmed. This is the default status.

514

# - "tentative" - The event is tentatively confirmed.

515

# - "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.

516

# A cancelled status represents two different states depending on the event type:

517

# - 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.

518

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

519

# - 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.

520

# 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.

521

# 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

522

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

523

# In order to modify attachments the supportsAttachments request parameter should be set to true.

524

# There can be at most 25 attachments per event,

525

{

526

"fileId": "A String", # ID of the attached file. Read-only.

527

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

528

"title": "A String", # Attachment title.

529

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

530

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

531

"fileUrl": "A String", # URL link to the attachment.

532

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

533

# Required when adding an attachment.

534

},

535

],

536

"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.

537

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

538

"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.

539

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

540

"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.

541

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

542

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

543

# - "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.

544

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

545

"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.

546

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

547

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

548

},

549

"extendedProperties": { # Extended properties of the event.

550

"private": { # Properties that are private to the copy of the event that appears on this calendar.

551

"a_key": "A String", # The name of the private property and the corresponding value.

552

},

553

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

554

"a_key": "A String", # The name of the shared property and the corresponding value.

555

},

556

},

557

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

558

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

559

"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.

560

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

561

# Unset for a conference with a failed create request.

562

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

563

"key": { # The key which can uniquely identify the conference solution for this event.

564

"type": "A String", # The conference solution type.

565

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

566

# The possible values are:

567

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

568

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

569

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

570

# - "addOn" for 3P conference providers

571

},

572

"iconUri": "A String", # The user-visible icon for this solution.

573

"name": "A String", # The user-visible name of this solution. Not localized.

574

},

575

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

576

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

583

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

584

"status": { # The status of the conference create request.

585

"statusCode": "A String", # The current status of the conference create request. Read-only.

586

# The possible values are:

587

# - "pending": the conference create request is still being processed.

588

# - "success": the conference create request succeeded, the entry points are populated.

589

# - "failure": the conference create request failed, there are no entry points.

590

},

591

"requestId": "A String", # The client-generated unique ID for this request.

592

# 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.

593

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

594

"type": "A String", # The conference solution type.

595

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

596

# The possible values are:

597

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

598

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

599

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

600

# - "addOn" for 3P conference providers

601

},

602

},

603

"conferenceId": "A String", # The ID of the conference.

604

# Can be used by developers to keep track of conferences, should not be displayed to users.

605

# Values for solution types:

606

# - "eventHangout": unset.

607

# - "eventNamedHangout": the name of the Hangout.

608

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

609

# - "addOn": defined by 3P conference provider. Optional.

610

"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.

611

"signature": "A String", # The signature of the conference data.

612

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

613

# Unset for a conference with a failed create request.

614

# Optional for a conference with a pending create request.

615

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

616

# All of them must belong to the same conference.

617

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

618

{

619

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

620

# Format:

621

# - for video, http: or https: schema is required.

622

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

623

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

624

# - for more, http: or https: schema is required.

625

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

626

# 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.

627

# Optional.

628

"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.

629

"A String",

630

],

631

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

632

# 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.

633

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

634

# 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.

635

# Optional.

636

"entryPointType": "A String", # The type of the conference entry point.

637

# Possible values are:

638

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

639

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

640

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

641

# - "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.

642

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

643

# 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.

644

# Optional.

645

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

646

# Calendar backend will populate this field only for EntryPointType.PHONE.

647

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

648

# Examples:

649

# - for video: meet.google.com/aaa-bbbb-ccc

650

# - for phone: +1 123 268 2601

651

# - for sip: 12345678@altostrat.com

652

# - for more: should not be filled

653

# Optional.

654

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

655

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

661

}

662

663

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

664

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.

665

666

Returns:

667

An object of the form:

668

669

{

670

"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.

671

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

672

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

673

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

674

"displayName": "A String", # The organizer's name, if available.

675

},

676

"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.

677

"summary": "A String", # Title of the event.

678

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

679

"location": "A String", # Geographic location of the event as free-form text. Optional.

680

"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.

681

"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.

682

"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.

683

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

684

"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.

685

},

686

"gadget": { # A gadget that extends this event.

687

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

688

"display": "A String", # The gadget's display mode. Optional. Possible values are:

689

# - "icon" - The gadget displays next to the event's title in the calendar view.

690

# - "chip" - The gadget displays when the event is clicked.

691

"title": "A String", # The gadget's title.

692

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

693

"preferences": { # Preferences.

694

"a_key": "A String", # The preference name and corresponding value.

695

},

696

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

697

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

698

"type": "A String", # The gadget's type.

699

},

700

"sequence": 42, # Sequence number as per iCalendar.

701

"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.

702

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

703

"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.

704

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

705

"etag": "A String", # ETag of the resource.

706

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

707

"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:

708

# - 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

709

# - the length of the ID must be between 5 and 1024 characters

710

# - 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.

711

# If you do not specify an ID, it will be automatically generated by the server.

712

# 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.

713

"visibility": "default", # Visibility of the event. Optional. Possible values are:

714

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

715

# - "public" - The event is public and event details are visible to all readers of the calendar.

716

# - "private" - The event is private and only event attendees may view event details.

717

# - "confidential" - The event is private. This value is provided for compatibility reasons.

718

"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.

719

"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.

720

"A String",

721

],

722

"description": "A String", # Description of the event. Can contain HTML. Optional.

723

"reminders": { # Information about the event's reminders for the authenticated user.

724

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

725

"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.

726

{

727

"method": "A String", # The method used by this reminder. Possible values are:

728

# - "email" - Reminders are sent via email.

729

# - "popup" - Reminders are sent via a UI popup.

730

# Required when adding a reminder.

731

"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).

732

# Required when adding a reminder.

},

],

},

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

737

{

738

"displayName": "A String", # The attendee's name, if available. Optional.

739

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

740

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

741

"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.

742

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

743

"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.

744

# Required when adding an attendee.

745

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

746

"responseStatus": "A String", # The attendee's response status. Possible values are:

747

# - "needsAction" - The attendee has not responded to the invitation.

748

# - "declined" - The attendee has declined the invitation.

749

# - "tentative" - The attendee has tentatively accepted the invitation.

750

# - "accepted" - The attendee has accepted the invitation.

751

"comment": "A String", # The attendee's response comment. Optional.

752

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

753

},

754

],

755

"kind": "calendar#event", # Type of the resource ("calendar#event").

756

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

757

"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.

758

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

759

"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.

760

},

761

"creator": { # The creator of the event. Read-only.

762

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

763

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

764

"displayName": "A String", # The creator's name, if available.

765

"email": "A String", # The creator's email address, if available.

766

},

767

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

768

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

769

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

770

"status": "A String", # Status of the event. Optional. Possible values are:

771

# - "confirmed" - The event is confirmed. This is the default status.

772

# - "tentative" - The event is tentatively confirmed.

773

# - "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.

774

# A cancelled status represents two different states depending on the event type:

775

# - 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.

776

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

777

# - 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.

778

# 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.

779

# 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.

780

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

781

# In order to modify attachments the supportsAttachments request parameter should be set to true.

782

# There can be at most 25 attachments per event,

783

{

784

"fileId": "A String", # ID of the attached file. Read-only.

785

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

786

"title": "A String", # Attachment title.

787

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

788

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

789

"fileUrl": "A String", # URL link to the attachment.

790

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

791

# Required when adding an attachment.

792

},

793

],

794

"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.

795

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

796

"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.

797

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

798

"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.

799

},

800

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

801

# - "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.

802

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

803

"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.

804

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

805

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

806

},

807

"extendedProperties": { # Extended properties of the event.

808

"private": { # Properties that are private to the copy of the event that appears on this calendar.

809

"a_key": "A String", # The name of the private property and the corresponding value.

810

},

811

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

812

"a_key": "A String", # The name of the shared property and the corresponding value.

813

},

814

},

815

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

816

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

817

"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.

818

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

819

# Unset for a conference with a failed create request.

820

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

821

"key": { # The key which can uniquely identify the conference solution for this event.

822

"type": "A String", # The conference solution type.

823

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

824

# The possible values are:

825

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

826

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

827

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

828

# - "addOn" for 3P conference providers

829

},

830

"iconUri": "A String", # The user-visible icon for this solution.

831

"name": "A String", # The user-visible name of this solution. Not localized.

832

},

833

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

834

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

841

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

842

"status": { # The status of the conference create request.

843

"statusCode": "A String", # The current status of the conference create request. Read-only.

844

# The possible values are:

845

# - "pending": the conference create request is still being processed.

846

# - "success": the conference create request succeeded, the entry points are populated.

847

# - "failure": the conference create request failed, there are no entry points.

848

},

849

"requestId": "A String", # The client-generated unique ID for this request.

850

# 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.

851

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

852

"type": "A String", # The conference solution type.

853

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

854

# The possible values are:

855

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

856

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

857

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

858

# - "addOn" for 3P conference providers

859

},

860

},

861

"conferenceId": "A String", # The ID of the conference.

862

# Can be used by developers to keep track of conferences, should not be displayed to users.

863

# Values for solution types:

864

# - "eventHangout": unset.

865

# - "eventNamedHangout": the name of the Hangout.

866

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

867

# - "addOn": defined by 3P conference provider. Optional.

868

"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.

869

"signature": "A String", # The signature of the conference data.

870

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

871

# Unset for a conference with a failed create request.

872

# Optional for a conference with a pending create request.

873

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

874

# All of them must belong to the same conference.

875

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

876

{

877

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

878

# Format:

879

# - for video, http: or https: schema is required.

880

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

881

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

882

# - for more, http: or https: schema is required.

883

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

884

# 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.

885

# Optional.

886

"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.

887

"A String",

888

],

889

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

890

# 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.

891

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

892

# 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.

893

# Optional.

894

"entryPointType": "A String", # The type of the conference entry point.

895

# Possible values are:

896

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

897

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

898

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

899

# - "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.

900

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

901

# 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.

902

# Optional.

903

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

904

# Calendar backend will populate this field only for EntryPointType.PHONE.

905

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

906

# Examples:

907

# - for video: meet.google.com/aaa-bbbb-ccc

908

# - for phone: +1 123 268 2601

909

# - for sip: 12345678@altostrat.com

910

# - for more: should not be filled

911

# Optional.

912

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

913

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

919

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

920

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

921

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

922

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

923

<code class="details" id="insert">insert(calendarId, body=None, sendNotifications=None, maxAttendees=None, sendUpdates=None, supportsAttachments=None, conferenceDataVersion=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

924

<pre>Creates an event.

925

926

Args:

927

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)

928

body: object, The request body.

929

The object takes the form of:

930

931

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

932

"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.

933

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

934

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

935

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

936

"displayName": "A String", # The organizer's name, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

937

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

938

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

939

"summary": "A String", # Title of the event.

940

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

941

"location": "A String", # Geographic location of the event as free-form text. Optional.

942

"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.

943

"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.

944

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

945

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

946

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

947

},

948

"gadget": { # A gadget that extends this event.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

949

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

950

"display": "A String", # The gadget's display mode. Optional. Possible values are:

951

# - "icon" - The gadget displays next to the event's title in the calendar view.

952

# - "chip" - The gadget displays when the event is clicked.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

953

"title": "A String", # The gadget's title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

954

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

955

"preferences": { # Preferences.

956

"a_key": "A String", # The preference name and corresponding value.

957

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

958

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

959

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

960

"type": "A String", # The gadget's type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

961

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

962

"sequence": 42, # Sequence number as per iCalendar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

963

"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.

964

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

965

"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.

966

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

967

"etag": "A String", # ETag of the resource.

968

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

969

"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:

970

# - 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

971

# - the length of the ID must be between 5 and 1024 characters

972

# - 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.

973

# If you do not specify an ID, it will be automatically generated by the server.

974

# 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

975

"visibility": "default", # Visibility of the event. Optional. Possible values are:

976

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

977

# - "public" - The event is public and event details are visible to all readers of the calendar.

978

# - "private" - The event is private and only event attendees may view event details.

979

# - "confidential" - The event is private. This value is provided for compatibility reasons.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

980

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

981

"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.

982

"A String",

983

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

984

"description": "A String", # Description of the event. Can contain HTML. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

985

"reminders": { # Information about the event's reminders for the authenticated user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

986

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

987

"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

988

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

989

"method": "A String", # The method used by this reminder. Possible values are:

990

# - "email" - Reminders are sent via email.

991

# - "popup" - Reminders are sent via a UI popup.

992

# Required when adding a reminder.

993

"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).

994

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

995

},

996

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

997

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

998

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

999

{

1000

"displayName": "A String", # The attendee's name, if available. Optional.

1001

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1002

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1003

"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.

1004

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1005

"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.

1006

# Required when adding an attendee.

1007

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1008

"responseStatus": "A String", # The attendee's response status. Possible values are:

1009

# - "needsAction" - The attendee has not responded to the invitation.

1010

# - "declined" - The attendee has declined the invitation.

1011

# - "tentative" - The attendee has tentatively accepted the invitation.

1012

# - "accepted" - The attendee has accepted the invitation.

1013

"comment": "A String", # The attendee's response comment. Optional.

1014

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1015

},

1016

],

1017

"kind": "calendar#event", # Type of the resource ("calendar#event").

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1018

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1019

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1020

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1021

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1022

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1023

"creator": { # The creator of the event. Read-only.

1024

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1025

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1026

"displayName": "A String", # The creator's name, if available.

1027

"email": "A String", # The creator's email address, if available.

1028

},

1029

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1030

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1031

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1032

"status": "A String", # Status of the event. Optional. Possible values are:

1033

# - "confirmed" - The event is confirmed. This is the default status.

1034

# - "tentative" - The event is tentatively confirmed.

1035

# - "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.

1036

# A cancelled status represents two different states depending on the event type:

1037

# - 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.

1038

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1039

# - 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.

1040

# 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.

1041

# 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1042

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1043

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1044

# There can be at most 25 attachments per event,

1045

{

1046

"fileId": "A String", # ID of the attached file. Read-only.

1047

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1048

"title": "A String", # Attachment title.

1049

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1050

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1051

"fileUrl": "A String", # URL link to the attachment.

1052

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1053

# Required when adding an attachment.

1054

},

1055

],

1056

"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.

1057

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1058

"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.

1059

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1060

"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.

1061

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1062

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1063

# - "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.

1064

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1065

"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.

1066

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1067

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1068

},

1069

"extendedProperties": { # Extended properties of the event.

1070

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1071

"a_key": "A String", # The name of the private property and the corresponding value.

1072

},

1073

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1074

"a_key": "A String", # The name of the shared property and the corresponding value.

1075

},

1076

},

1077

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1078

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1079

"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.

1080

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1081

# Unset for a conference with a failed create request.

1082

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1083

"key": { # The key which can uniquely identify the conference solution for this event.

1084

"type": "A String", # The conference solution type.

1085

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1086

# The possible values are:

1087

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1088

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

1089

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1090

# - "addOn" for 3P conference providers

1091

},

1092

"iconUri": "A String", # The user-visible icon for this solution.

1093

"name": "A String", # The user-visible name of this solution. Not localized.

1094

},

1095

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1096

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

1103

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1104

"status": { # The status of the conference create request.

1105

"statusCode": "A String", # The current status of the conference create request. Read-only.

1106

# The possible values are:

1107

# - "pending": the conference create request is still being processed.

1108

# - "success": the conference create request succeeded, the entry points are populated.

1109

# - "failure": the conference create request failed, there are no entry points.

1110

},

1111

"requestId": "A String", # The client-generated unique ID for this request.

1112

# 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.

1113

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1114

"type": "A String", # The conference solution type.

1115

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1116

# The possible values are:

1117

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1118

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

1119

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1120

# - "addOn" for 3P conference providers

1121

},

1122

},

1123

"conferenceId": "A String", # The ID of the conference.

1124

# Can be used by developers to keep track of conferences, should not be displayed to users.

1125

# Values for solution types:

1126

# - "eventHangout": unset.

1127

# - "eventNamedHangout": the name of the Hangout.

1128

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1129

# - "addOn": defined by 3P conference provider. Optional.

1130

"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.

1131

"signature": "A String", # The signature of the conference data.

1132

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1133

# Unset for a conference with a failed create request.

1134

# Optional for a conference with a pending create request.

1135

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1136

# All of them must belong to the same conference.

1137

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1138

{

1139

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1140

# Format:

1141

# - for video, http: or https: schema is required.

1142

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1143

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1144

# - for more, http: or https: schema is required.

1145

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1146

# 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.

1147

# Optional.

1148

"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.

1149

"A String",

1150

],

1151

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1152

# 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.

1153

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1154

# 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.

1155

# Optional.

1156

"entryPointType": "A String", # The type of the conference entry point.

1157

# Possible values are:

1158

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1159

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1160

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1161

# - "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.

1162

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1163

# 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.

1164

# Optional.

1165

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1166

# Calendar backend will populate this field only for EntryPointType.PHONE.

1167

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1168

# Examples:

1169

# - for video: meet.google.com/aaa-bbbb-ccc

1170

# - for phone: +1 123 268 2601

1171

# - for sip: 12345678@altostrat.com

1172

# - for more: should not be filled

1173

# Optional.

1174

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1175

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1181

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1182

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1183

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1184

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1185

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1186

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1187

sendUpdates: string, Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.

1188

Allowed values

1189

all - Notifications are sent to all guests.

1190

externalOnly - Notifications are sent to non-Google Calendar guests only.

1191

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

1192

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

1193

conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1194

1195

Returns:

1196

An object of the form:

1197

1198

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1199

"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.

1200

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1201

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1202

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1203

"displayName": "A String", # The organizer's name, if available.

1204

},

1205

"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.

1206

"summary": "A String", # Title of the event.

1207

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1208

"location": "A String", # Geographic location of the event as free-form text. Optional.

1209

"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.

1210

"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.

1211

"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.

1212

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1213

"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.

1214

},

1215

"gadget": { # A gadget that extends this event.

1216

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

1217

"display": "A String", # The gadget's display mode. Optional. Possible values are:

1218

# - "icon" - The gadget displays next to the event's title in the calendar view.

1219

# - "chip" - The gadget displays when the event is clicked.

1220

"title": "A String", # The gadget's title.

1221

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

1222

"preferences": { # Preferences.

1223

"a_key": "A String", # The preference name and corresponding value.

1224

},

1225

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

1226

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

1227

"type": "A String", # The gadget's type.

1228

},

1229

"sequence": 42, # Sequence number as per iCalendar.

1230

"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.

1231

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

1232

"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.

1233

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1234

"etag": "A String", # ETag of the resource.

1235

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1236

"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:

1237

# - 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

1238

# - the length of the ID must be between 5 and 1024 characters

1239

# - 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.

1240

# If you do not specify an ID, it will be automatically generated by the server.

1241

# 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.

1242

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1243

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1244

# - "public" - The event is public and event details are visible to all readers of the calendar.

1245

# - "private" - The event is private and only event attendees may view event details.

1246

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1247

"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.

1248

"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.

1249

"A String",

1250

],

1251

"description": "A String", # Description of the event. Can contain HTML. Optional.

1252

"reminders": { # Information about the event's reminders for the authenticated user.

1253

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1254

"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.

1255

{

1256

"method": "A String", # The method used by this reminder. Possible values are:

1257

# - "email" - Reminders are sent via email.

1258

# - "popup" - Reminders are sent via a UI popup.

1259

# Required when adding a reminder.

1260

"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).

1261

# Required when adding a reminder.

},

],

},

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

1266

{

1267

"displayName": "A String", # The attendee's name, if available. Optional.

1268

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1269

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1270

"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.

1271

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1272

"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.

1273

# Required when adding an attendee.

1274

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1275

"responseStatus": "A String", # The attendee's response status. Possible values are:

1276

# - "needsAction" - The attendee has not responded to the invitation.

1277

# - "declined" - The attendee has declined the invitation.

1278

# - "tentative" - The attendee has tentatively accepted the invitation.

1279

# - "accepted" - The attendee has accepted the invitation.

1280

"comment": "A String", # The attendee's response comment. Optional.

1281

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1282

},

1283

],

1284

"kind": "calendar#event", # Type of the resource ("calendar#event").

1285

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1286

"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.

1287

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1288

"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.

1289

},

1290

"creator": { # The creator of the event. Read-only.

1291

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1292

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1293

"displayName": "A String", # The creator's name, if available.

1294

"email": "A String", # The creator's email address, if available.

1295

},

1296

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1297

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1298

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1299

"status": "A String", # Status of the event. Optional. Possible values are:

1300

# - "confirmed" - The event is confirmed. This is the default status.

1301

# - "tentative" - The event is tentatively confirmed.

1302

# - "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.

1303

# A cancelled status represents two different states depending on the event type:

1304

# - 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.

1305

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1306

# - 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.

1307

# 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.

1308

# 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.

1309

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1310

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1311

# There can be at most 25 attachments per event,

1312

{

1313

"fileId": "A String", # ID of the attached file. Read-only.

1314

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1315

"title": "A String", # Attachment title.

1316

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1317

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1318

"fileUrl": "A String", # URL link to the attachment.

1319

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1320

# Required when adding an attachment.

1321

},

1322

],

1323

"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.

1324

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1325

"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.

1326

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1327

"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.

1328

},

1329

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1330

# - "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.

1331

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1332

"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.

1333

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1334

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1335

},

1336

"extendedProperties": { # Extended properties of the event.

1337

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1338

"a_key": "A String", # The name of the private property and the corresponding value.

1339

},

1340

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1341

"a_key": "A String", # The name of the shared property and the corresponding value.

1342

},

1343

},

1344

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1345

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1346

"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.

1347

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1348

# Unset for a conference with a failed create request.

1349

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1350

"key": { # The key which can uniquely identify the conference solution for this event.

1351

"type": "A String", # The conference solution type.

1352

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1353

# The possible values are:

1354

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1355

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

1356

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1357

# - "addOn" for 3P conference providers

1358

},

1359

"iconUri": "A String", # The user-visible icon for this solution.

1360

"name": "A String", # The user-visible name of this solution. Not localized.

1361

},

1362

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1363

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

1370

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1371

"status": { # The status of the conference create request.

1372

"statusCode": "A String", # The current status of the conference create request. Read-only.

1373

# The possible values are:

1374

# - "pending": the conference create request is still being processed.

1375

# - "success": the conference create request succeeded, the entry points are populated.

1376

# - "failure": the conference create request failed, there are no entry points.

1377

},

1378

"requestId": "A String", # The client-generated unique ID for this request.

1379

# 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.

1380

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1381

"type": "A String", # The conference solution type.

1382

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1383

# The possible values are:

1384

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1385

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

1386

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1387

# - "addOn" for 3P conference providers

1388

},

1389

},

1390

"conferenceId": "A String", # The ID of the conference.

1391

# Can be used by developers to keep track of conferences, should not be displayed to users.

1392

# Values for solution types:

1393

# - "eventHangout": unset.

1394

# - "eventNamedHangout": the name of the Hangout.

1395

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1396

# - "addOn": defined by 3P conference provider. Optional.

1397

"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.

1398

"signature": "A String", # The signature of the conference data.

1399

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1400

# Unset for a conference with a failed create request.

1401

# Optional for a conference with a pending create request.

1402

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1403

# All of them must belong to the same conference.

1404

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1405

{

1406

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1407

# Format:

1408

# - for video, http: or https: schema is required.

1409

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1410

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1411

# - for more, http: or https: schema is required.

1412

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1413

# 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.

1414

# Optional.

1415

"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.

1416

"A String",

1417

],

1418

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1419

# 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.

1420

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1421

# 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.

1422

# Optional.

1423

"entryPointType": "A String", # The type of the conference entry point.

1424

# Possible values are:

1425

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1426

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1427

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1428

# - "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.

1429

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1430

# 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.

1431

# Optional.

1432

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1433

# Calendar backend will populate this field only for EntryPointType.PHONE.

1434

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1435

# Examples:

1436

# - for video: meet.google.com/aaa-bbbb-ccc

1437

# - for phone: +1 123 268 2601

1438

# - for sip: 12345678@altostrat.com

1439

# - for more: should not be filled

1440

# Optional.

1441

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1442

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

}</pre>

</div>

<code class="details" id="instances">instances(calendarId, eventId, maxResults=None, timeZone=None, alwaysIncludeEmail=None, originalStart=None, timeMin=None, timeMax=None, maxAttendees=None, pageToken=None, showDeleted=None)</code>

1453

<pre>Returns instances of the specified recurring event.

1454

1455

Args:

1456

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)

1457

eventId: string, Recurring event identifier. (required)

1458

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.

1459

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

1460

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).

1461

originalStart: string, The original start time of the instance in the result. Optional.

1462

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.

1463

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.

1464

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.

1465

pageToken: string, Token specifying which result page to return. Optional.

1466

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.

1467

1468

Returns:

1469

An object of the form:

1470

1471

{

1472

"timeZone": "A String", # The time zone of the calendar. Read-only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1473

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1474

# - "none" - The user has no access.

1475

# - "freeBusyReader" - The user has read access to free/busy information.

1476

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1477

# - "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.

1478

# - "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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1479

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

1480

"etag": "A String", # ETag of the collection.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1481

"defaultReminders": [ # The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1482

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1483

"method": "A String", # The method used by this reminder. Possible values are:

1484

# - "email" - Reminders are sent via email.

1485

# - "popup" - Reminders are sent via a UI popup.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1486

# Required when adding a reminder.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1487

"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1488

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1489

},

1490

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1491

"kind": "calendar#events", # Type of the collection ("calendar#events").

1492

"summary": "A String", # Title of the calendar. Read-only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1493

"description": "A String", # Description of the calendar. Read-only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1494

"items": [ # List of events on the calendar.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1495

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1496

"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.

1497

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1498

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1499

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1500

"displayName": "A String", # The organizer's name, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1501

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1502

"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.

1503

"summary": "A String", # Title of the event.

1504

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1505

"location": "A String", # Geographic location of the event as free-form text. Optional.

1506

"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.

1507

"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.

1508

"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.

1509

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1510

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1511

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1512

"gadget": { # A gadget that extends this event.

1513

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

1514

"display": "A String", # The gadget's display mode. Optional. Possible values are:

1515

# - "icon" - The gadget displays next to the event's title in the calendar view.

1516

# - "chip" - The gadget displays when the event is clicked.

1517

"title": "A String", # The gadget's title.

1518

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

1519

"preferences": { # Preferences.

1520

"a_key": "A String", # The preference name and corresponding value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1521

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1522

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

1523

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

1524

"type": "A String", # The gadget's type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1525

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1526

"sequence": 42, # Sequence number as per iCalendar.

1527

"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.

1528

# 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.

1529

"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.

1530

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1531

"etag": "A String", # ETag of the resource.

1532

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1533

"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:

1534

# - 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

1535

# - the length of the ID must be between 5 and 1024 characters

1536

# - 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.

1537

# If you do not specify an ID, it will be automatically generated by the server.

1538

# 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.

1539

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1540

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1541

# - "public" - The event is public and event details are visible to all readers of the calendar.

1542

# - "private" - The event is private and only event attendees may view event details.

1543

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1544

"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.

1545

"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.

1546

"A String",

1547

],

1548

"description": "A String", # Description of the event. Can contain HTML. Optional.

1549

"reminders": { # Information about the event's reminders for the authenticated user.

1550

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1551

"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.

1552

{

1553

"method": "A String", # The method used by this reminder. Possible values are:

1554

# - "email" - Reminders are sent via email.

1555

# - "popup" - Reminders are sent via a UI popup.

1556

# Required when adding a reminder.

1557

"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).

1558

# Required when adding a reminder.

1559

},

1560

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1561

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1562

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1563

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1564

"displayName": "A String", # The attendee's name, if available. Optional.

1565

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1566

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1567

"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.

1568

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1569

"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.

1570

# Required when adding an attendee.

1571

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1572

"responseStatus": "A String", # The attendee's response status. Possible values are:

1573

# - "needsAction" - The attendee has not responded to the invitation.

1574

# - "declined" - The attendee has declined the invitation.

1575

# - "tentative" - The attendee has tentatively accepted the invitation.

1576

# - "accepted" - The attendee has accepted the invitation.

1577

"comment": "A String", # The attendee's response comment. Optional.

1578

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1579

},

1580

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1581

"kind": "calendar#event", # Type of the resource ("calendar#event").

1582

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1583

"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.

1584

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1585

"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.

1586

},

1587

"creator": { # The creator of the event. Read-only.

1588

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1589

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1590

"displayName": "A String", # The creator's name, if available.

1591

"email": "A String", # The creator's email address, if available.

1592

},

1593

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1594

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1595

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1596

"status": "A String", # Status of the event. Optional. Possible values are:

1597

# - "confirmed" - The event is confirmed. This is the default status.

1598

# - "tentative" - The event is tentatively confirmed.

1599

# - "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.

1600

# A cancelled status represents two different states depending on the event type:

1601

# - 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.

1602

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1603

# - 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.

1604

# 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.

1605

# 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.

1606

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1607

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1608

# There can be at most 25 attachments per event,

1609

{

1610

"fileId": "A String", # ID of the attached file. Read-only.

1611

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1612

"title": "A String", # Attachment title.

1613

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1614

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1615

"fileUrl": "A String", # URL link to the attachment.

1616

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1617

# Required when adding an attachment.

1618

},

1619

],

1620

"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.

1621

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1622

"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.

1623

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1624

"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.

1625

},

1626

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1627

# - "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.

1628

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1629

"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.

1630

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1631

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1632

},

1633

"extendedProperties": { # Extended properties of the event.

1634

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1635

"a_key": "A String", # The name of the private property and the corresponding value.

1636

},

1637

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1638

"a_key": "A String", # The name of the shared property and the corresponding value.

1639

},

1640

},

1641

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1642

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1643

"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.

1644

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1645

# Unset for a conference with a failed create request.

1646

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1647

"key": { # The key which can uniquely identify the conference solution for this event.

1648

"type": "A String", # The conference solution type.

1649

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1650

# The possible values are:

1651

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1652

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

1653

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1654

# - "addOn" for 3P conference providers

1655

},

1656

"iconUri": "A String", # The user-visible icon for this solution.

1657

"name": "A String", # The user-visible name of this solution. Not localized.

1658

},

1659

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1660

"addOnParameters": { # Additional add-on specific data.

1661

"parameters": {

1662

"a_key": "A String",

1663

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1664

},

1665

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1666

"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.

1667

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1668

"status": { # The status of the conference create request.

1669

"statusCode": "A String", # The current status of the conference create request. Read-only.

1670

# The possible values are:

1671

# - "pending": the conference create request is still being processed.

1672

# - "success": the conference create request succeeded, the entry points are populated.

1673

# - "failure": the conference create request failed, there are no entry points.

1674

},

1675

"requestId": "A String", # The client-generated unique ID for this request.

1676

# 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.

1677

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1678

"type": "A String", # The conference solution type.

1679

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1680

# The possible values are:

1681

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1682

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

1683

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1684

# - "addOn" for 3P conference providers

1685

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1686

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1687

"conferenceId": "A String", # The ID of the conference.

1688

# Can be used by developers to keep track of conferences, should not be displayed to users.

1689

# Values for solution types:

1690

# - "eventHangout": unset.

1691

# - "eventNamedHangout": the name of the Hangout.

1692

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1693

# - "addOn": defined by 3P conference provider. Optional.

1694

"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.

1695

"signature": "A String", # The signature of the conference data.

1696

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1697

# Unset for a conference with a failed create request.

1698

# Optional for a conference with a pending create request.

1699

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1700

# All of them must belong to the same conference.

1701

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1702

{

1703

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1704

# Format:

1705

# - for video, http: or https: schema is required.

1706

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1707

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1708

# - for more, http: or https: schema is required.

1709

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1710

# 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.

1711

# Optional.

1712

"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.

1713

"A String",

1714

],

1715

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1716

# 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.

1717

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1718

# 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.

1719

# Optional.

1720

"entryPointType": "A String", # The type of the conference entry point.

1721

# Possible values are:

1722

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1723

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1724

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1725

# - "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.

1726

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1727

# 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.

1728

# Optional.

1729

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1730

# Calendar backend will populate this field only for EntryPointType.PHONE.

1731

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1732

# Examples:

1733

# - for video: meet.google.com/aaa-bbbb-ccc

1734

# - for phone: +1 123 268 2601

1735

# - for sip: 12345678@altostrat.com

1736

# - for more: should not be filled

1737

# Optional.

1738

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1739

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1745

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1746

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1747

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1748

"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="instances_next">instances_next(previous_request, previous_response)</code>

1754

<pre>Retrieves the next page of results.

1755

1756

Args:

1757

previous_request: The request for the previous page. (required)

1758

previous_response: The response from the request for the previous page. (required)

1759

1760

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1761

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1762

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1767

<code class="details" id="list">list(calendarId, sharedExtendedProperty=None, maxResults=None, timeZone=None, pageToken=None, orderBy=None, timeMax=None, timeMin=None, syncToken=None, alwaysIncludeEmail=None, singleEvents=None, updatedMin=None, q=None, privateExtendedProperty=None, maxAttendees=None, showDeleted=None, showHiddenInvitations=None, iCalUID=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1768

<pre>Returns events on the specified calendar.

1769

1770

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1771

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)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1772

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)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1773

maxResults: integer, Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1774

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

1775

pageToken: string, Token specifying which result page to return. Optional.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1776

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

1777

Allowed values

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1778

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1779

updated - Order by last modification time (ascending).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1780

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.

1781

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.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1782

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.

1783

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

1789

- q

1790

- sharedExtendedProperty

1791

- timeMin

1792

- timeMax

1793

- 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.

1794

Learn more about incremental synchronization.

1795

Optional. The default is to return all entries.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1796

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).

1797

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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1798

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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1799

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

1800

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)

1801

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.

1802

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.

1803

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

1804

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1805

1806

Returns:

1807

An object of the form:

1808

1809

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1810

"timeZone": "A String", # The time zone of the calendar. Read-only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1811

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1812

# - "none" - The user has no access.

1813

# - "freeBusyReader" - The user has read access to free/busy information.

1814

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1815

# - "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.

1816

# - "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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1817

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

1818

"etag": "A String", # ETag of the collection.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1819

"defaultReminders": [ # The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1820

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1821

"method": "A String", # The method used by this reminder. Possible values are:

1822

# - "email" - Reminders are sent via email.

1823

# - "popup" - Reminders are sent via a UI popup.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1824

# Required when adding a reminder.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1825

"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1826

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1827

},

1828

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1829

"kind": "calendar#events", # Type of the collection ("calendar#events").

1830

"summary": "A String", # Title of the calendar. Read-only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1831

"description": "A String", # Description of the calendar. Read-only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1832

"items": [ # List of events on the calendar.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1833

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1834

"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.

1835

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1836

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1837

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1838

"displayName": "A String", # The organizer's name, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1839

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1840

"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.

1841

"summary": "A String", # Title of the event.

1842

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1843

"location": "A String", # Geographic location of the event as free-form text. Optional.

1844

"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.

1845

"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.

1846

"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.

1847

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1848

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1849

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1850

"gadget": { # A gadget that extends this event.

1851

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

1852

"display": "A String", # The gadget's display mode. Optional. Possible values are:

1853

# - "icon" - The gadget displays next to the event's title in the calendar view.

1854

# - "chip" - The gadget displays when the event is clicked.

1855

"title": "A String", # The gadget's title.

1856

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

1857

"preferences": { # Preferences.

1858

"a_key": "A String", # The preference name and corresponding value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1859

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1860

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

1861

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

1862

"type": "A String", # The gadget's type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1863

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1864

"sequence": 42, # Sequence number as per iCalendar.

1865

"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.

1866

# 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.

1867

"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.

1868

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1869

"etag": "A String", # ETag of the resource.

1870

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1871

"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:

1872

# - 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

1873

# - the length of the ID must be between 5 and 1024 characters

1874

# - 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.

1875

# If you do not specify an ID, it will be automatically generated by the server.

1876

# 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.

1877

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1878

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1879

# - "public" - The event is public and event details are visible to all readers of the calendar.

1880

# - "private" - The event is private and only event attendees may view event details.

1881

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1882

"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.

1883

"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.

1884

"A String",

1885

],

1886

"description": "A String", # Description of the event. Can contain HTML. Optional.

1887

"reminders": { # Information about the event's reminders for the authenticated user.

1888

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1889

"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.

1890

{

1891

"method": "A String", # The method used by this reminder. Possible values are:

1892

# - "email" - Reminders are sent via email.

1893

# - "popup" - Reminders are sent via a UI popup.

1894

# Required when adding a reminder.

1895

"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).

1896

# Required when adding a reminder.

1897

},

1898

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1899

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1900

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1901

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1902

"displayName": "A String", # The attendee's name, if available. Optional.

1903

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1904

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1905

"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.

1906

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1907

"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.

1908

# Required when adding an attendee.

1909

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1910

"responseStatus": "A String", # The attendee's response status. Possible values are:

1911

# - "needsAction" - The attendee has not responded to the invitation.

1912

# - "declined" - The attendee has declined the invitation.

1913

# - "tentative" - The attendee has tentatively accepted the invitation.

1914

# - "accepted" - The attendee has accepted the invitation.

1915

"comment": "A String", # The attendee's response comment. Optional.

1916

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1917

},

1918

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1919

"kind": "calendar#event", # Type of the resource ("calendar#event").

1920

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1921

"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.

1922

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1923

"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.

1924

},

1925

"creator": { # The creator of the event. Read-only.

1926

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1927

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1928

"displayName": "A String", # The creator's name, if available.

1929

"email": "A String", # The creator's email address, if available.

1930

},

1931

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1932

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1933

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1934

"status": "A String", # Status of the event. Optional. Possible values are:

1935

# - "confirmed" - The event is confirmed. This is the default status.

1936

# - "tentative" - The event is tentatively confirmed.

1937

# - "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.

1938

# A cancelled status represents two different states depending on the event type:

1939

# - 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.

1940

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1941

# - 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.

1942

# 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.

1943

# 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.

1944

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1945

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1946

# There can be at most 25 attachments per event,

1947

{

1948

"fileId": "A String", # ID of the attached file. Read-only.

1949

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1950

"title": "A String", # Attachment title.

1951

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1952

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1953

"fileUrl": "A String", # URL link to the attachment.

1954

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1955

# Required when adding an attachment.

1956

},

1957

],

1958

"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.

1959

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1960

"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.

1961

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1962

"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.

1963

},

1964

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1965

# - "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.

1966

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1967

"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.

1968

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1969

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1970

},

1971

"extendedProperties": { # Extended properties of the event.

1972

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1973

"a_key": "A String", # The name of the private property and the corresponding value.

1974

},

1975

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1976

"a_key": "A String", # The name of the shared property and the corresponding value.

1977

},

1978

},

1979

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1980

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1981

"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.

1982

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1983

# Unset for a conference with a failed create request.

1984

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1985

"key": { # The key which can uniquely identify the conference solution for this event.

1986

"type": "A String", # The conference solution type.

1987

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1988

# The possible values are:

1989

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1990

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

1991

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1992

# - "addOn" for 3P conference providers

1993

},

1994

"iconUri": "A String", # The user-visible icon for this solution.

1995

"name": "A String", # The user-visible name of this solution. Not localized.

1996

},

1997

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1998

"addOnParameters": { # Additional add-on specific data.

1999

"parameters": {

2000

"a_key": "A String",

2001

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2002

},

2003

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2004

"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.

2005

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2006

"status": { # The status of the conference create request.

2007

"statusCode": "A String", # The current status of the conference create request. Read-only.

2008

# The possible values are:

2009

# - "pending": the conference create request is still being processed.

2010

# - "success": the conference create request succeeded, the entry points are populated.

2011

# - "failure": the conference create request failed, there are no entry points.

2012

},

2013

"requestId": "A String", # The client-generated unique ID for this request.

2014

# 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.

2015

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2016

"type": "A String", # The conference solution type.

2017

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2018

# The possible values are:

2019

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2020

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

2021

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2022

# - "addOn" for 3P conference providers

2023

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2024

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2025

"conferenceId": "A String", # The ID of the conference.

2026

# Can be used by developers to keep track of conferences, should not be displayed to users.

2027

# Values for solution types:

2028

# - "eventHangout": unset.

2029

# - "eventNamedHangout": the name of the Hangout.

2030

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2031

# - "addOn": defined by 3P conference provider. Optional.

2032

"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.

2033

"signature": "A String", # The signature of the conference data.

2034

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2035

# Unset for a conference with a failed create request.

2036

# Optional for a conference with a pending create request.

2037

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2038

# All of them must belong to the same conference.

2039

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2040

{

2041

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2042

# Format:

2043

# - for video, http: or https: schema is required.

2044

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2045

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2046

# - for more, http: or https: schema is required.

2047

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2048

# 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.

2049

# Optional.

2050

"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.

2051

"A String",

2052

],

2053

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2054

# 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.

2055

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2056

# 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.

2057

# Optional.

2058

"entryPointType": "A String", # The type of the conference entry point.

2059

# Possible values are:

2060

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2061

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2062

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2063

# - "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.

2064

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2065

# 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.

2066

# Optional.

2067

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2068

# Calendar backend will populate this field only for EntryPointType.PHONE.

2069

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2070

# Examples:

2071

# - for video: meet.google.com/aaa-bbbb-ccc

2072

# - for phone: +1 123 268 2601

2073

# - for sip: 12345678@altostrat.com

2074

# - for more: should not be filled

2075

# Optional.

2076

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2077

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2083

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2084

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2085

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2086

"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2092

<pre>Retrieves the next page of results.

2093

2094

Args:

2095

previous_request: The request for the previous page. (required)

2096

previous_response: The response from the request for the previous page. (required)

2097

2098

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2099

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2100

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2105

<code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2106

<pre>Moves an event to another calendar, i.e. changes an event's organizer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2107

2108

Args:

2109

calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)

2110

eventId: string, Event identifier. (required)

2111

destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2112

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2113

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2114

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.

2115

sendUpdates: string, Guests who should receive notifications about the change of the event's organizer.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2116

Allowed values

2117

all - Notifications are sent to all guests.

2118

externalOnly - Notifications are sent to non-Google Calendar guests only.

2119

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2120

2121

Returns:

2122

An object of the form:

2123

2124

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2125

"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.

2126

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2127

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2128

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2129

"displayName": "A String", # The organizer's name, if available.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2130

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2131

"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.

2132

"summary": "A String", # Title of the event.

2133

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2134

"location": "A String", # Geographic location of the event as free-form text. Optional.

2135

"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.

2136

"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.

2137

"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.

2138

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2139

"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2140

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2141

"gadget": { # A gadget that extends this event.

2142

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

2143

"display": "A String", # The gadget's display mode. Optional. Possible values are:

2144

# - "icon" - The gadget displays next to the event's title in the calendar view.

2145

# - "chip" - The gadget displays when the event is clicked.

2146

"title": "A String", # The gadget's title.

2147

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

2148

"preferences": { # Preferences.

2149

"a_key": "A String", # The preference name and corresponding value.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2150

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2151

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

2152

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

2153

"type": "A String", # The gadget's type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2154

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2155

"sequence": 42, # Sequence number as per iCalendar.

2156

"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.

2157

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

2158

"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.

2159

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2160

"etag": "A String", # ETag of the resource.

2161

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2162

"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:

2163

# - 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

2164

# - the length of the ID must be between 5 and 1024 characters

2165

# - 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.

2166

# If you do not specify an ID, it will be automatically generated by the server.

2167

# 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.

2168

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2169

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2170

# - "public" - The event is public and event details are visible to all readers of the calendar.

2171

# - "private" - The event is private and only event attendees may view event details.

2172

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2173

"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.

2174

"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.

2175

"A String",

2176

],

2177

"description": "A String", # Description of the event. Can contain HTML. Optional.

2178

"reminders": { # Information about the event's reminders for the authenticated user.

2179

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2180

"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.

2181

{

2182

"method": "A String", # The method used by this reminder. Possible values are:

2183

# - "email" - Reminders are sent via email.

2184

# - "popup" - Reminders are sent via a UI popup.

2185

# Required when adding a reminder.

2186

"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).

2187

# Required when adding a reminder.

2188

},

2189

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2190

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2191

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2192

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2193

"displayName": "A String", # The attendee's name, if available. Optional.

2194

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2195

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2196

"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.

2197

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2198

"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.

2199

# Required when adding an attendee.

2200

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2201

"responseStatus": "A String", # The attendee's response status. Possible values are:

2202

# - "needsAction" - The attendee has not responded to the invitation.

2203

# - "declined" - The attendee has declined the invitation.

2204

# - "tentative" - The attendee has tentatively accepted the invitation.

2205

# - "accepted" - The attendee has accepted the invitation.

2206

"comment": "A String", # The attendee's response comment. Optional.

2207

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2208

},

2209

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2210

"kind": "calendar#event", # Type of the resource ("calendar#event").

2211

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2212

"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.

2213

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2214

"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.

2215

},

2216

"creator": { # The creator of the event. Read-only.

2217

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2218

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2219

"displayName": "A String", # The creator's name, if available.

2220

"email": "A String", # The creator's email address, if available.

2221

},

2222

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2223

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2224

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2225

"status": "A String", # Status of the event. Optional. Possible values are:

2226

# - "confirmed" - The event is confirmed. This is the default status.

2227

# - "tentative" - The event is tentatively confirmed.

2228

# - "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.

2229

# A cancelled status represents two different states depending on the event type:

2230

# - 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.

2231

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2232

# - 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.

2233

# 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.

2234

# 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.

2235

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2236

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2237

# There can be at most 25 attachments per event,

2238

{

2239

"fileId": "A String", # ID of the attached file. Read-only.

2240

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2241

"title": "A String", # Attachment title.

2242

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2243

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2244

"fileUrl": "A String", # URL link to the attachment.

2245

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2246

# Required when adding an attachment.

2247

},

2248

],

2249

"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.

2250

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2251

"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.

2252

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2253

"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.

2254

},

2255

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2256

# - "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.

2257

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2258

"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.

2259

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2260

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2261

},

2262

"extendedProperties": { # Extended properties of the event.

2263

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2264

"a_key": "A String", # The name of the private property and the corresponding value.

2265

},

2266

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2267

"a_key": "A String", # The name of the shared property and the corresponding value.

2268

},

2269

},

2270

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2271

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2272

"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.

2273

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2274

# Unset for a conference with a failed create request.

2275

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2276

"key": { # The key which can uniquely identify the conference solution for this event.

2277

"type": "A String", # The conference solution type.

2278

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2279

# The possible values are:

2280

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2281

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

2282

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2283

# - "addOn" for 3P conference providers

2284

},

2285

"iconUri": "A String", # The user-visible icon for this solution.

2286

"name": "A String", # The user-visible name of this solution. Not localized.

2287

},

2288

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2289

"addOnParameters": { # Additional add-on specific data.

2290

"parameters": {

2291

"a_key": "A String",

2292

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2293

},

2294

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2295

"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.

2296

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2297

"status": { # The status of the conference create request.

2298

"statusCode": "A String", # The current status of the conference create request. Read-only.

2299

# The possible values are:

2300

# - "pending": the conference create request is still being processed.

2301

# - "success": the conference create request succeeded, the entry points are populated.

2302

# - "failure": the conference create request failed, there are no entry points.

2303

},

2304

"requestId": "A String", # The client-generated unique ID for this request.

2305

# 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.

2306

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2307

"type": "A String", # The conference solution type.

2308

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2309

# The possible values are:

2310

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2311

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

2312

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2313

# - "addOn" for 3P conference providers

2314

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2315

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2316

"conferenceId": "A String", # The ID of the conference.

2317

# Can be used by developers to keep track of conferences, should not be displayed to users.

2318

# Values for solution types:

2319

# - "eventHangout": unset.

2320

# - "eventNamedHangout": the name of the Hangout.

2321

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2322

# - "addOn": defined by 3P conference provider. Optional.

2323

"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.

2324

"signature": "A String", # The signature of the conference data.

2325

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2326

# Unset for a conference with a failed create request.

2327

# Optional for a conference with a pending create request.

2328

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2329

# All of them must belong to the same conference.

2330

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2331

{

2332

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2333

# Format:

2334

# - for video, http: or https: schema is required.

2335

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2336

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2337

# - for more, http: or https: schema is required.

2338

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2339

# 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.

2340

# Optional.

2341

"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.

2342

"A String",

2343

],

2344

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2345

# 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.

2346

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2347

# 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.

2348

# Optional.

2349

"entryPointType": "A String", # The type of the conference entry point.

2350

# Possible values are:

2351

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2352

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2353

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2354

# - "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.

2355

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2356

# 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.

2357

# Optional.

2358

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2359

# Calendar backend will populate this field only for EntryPointType.PHONE.

2360

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2361

# Examples:

2362

# - for video: meet.google.com/aaa-bbbb-ccc

2363

# - for phone: +1 123 268 2601

2364

# - for sip: 12345678@altostrat.com

2365

# - for more: should not be filled

2366

# Optional.

2367

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2368

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2374

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2375

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2376

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2377

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2378

<code class="details" id="patch">patch(calendarId, eventId, body=None, conferenceDataVersion=None, maxAttendees=None, supportsAttachments=None, sendUpdates=None, alwaysIncludeEmail=None, sendNotifications=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2379

<pre>Updates an event. This method supports patch semantics.

2380

2381

Args:

2382

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)

2383

eventId: string, Event identifier. (required)

2384

body: object, The request body.

2385

The object takes the form of:

2386

2387

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2388

"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.

2389

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2390

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2391

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2392

"displayName": "A String", # The organizer's name, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2393

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2394

"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.

2395

"summary": "A String", # Title of the event.

2396

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2397

"location": "A String", # Geographic location of the event as free-form text. Optional.

2398

"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.

2399

"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.

2400

"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.

2401

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2402

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2403

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2404

"gadget": { # A gadget that extends this event.

2405

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

2406

"display": "A String", # The gadget's display mode. Optional. Possible values are:

2407

# - "icon" - The gadget displays next to the event's title in the calendar view.

2408

# - "chip" - The gadget displays when the event is clicked.

2409

"title": "A String", # The gadget's title.

2410

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

2411

"preferences": { # Preferences.

2412

"a_key": "A String", # The preference name and corresponding value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2413

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2414

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

2415

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

2416

"type": "A String", # The gadget's type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2417

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2418

"sequence": 42, # Sequence number as per iCalendar.

2419

"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.

2420

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

2421

"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.

2422

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2423

"etag": "A String", # ETag of the resource.

2424

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2425

"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:

2426

# - 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

2427

# - the length of the ID must be between 5 and 1024 characters

2428

# - 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.

2429

# If you do not specify an ID, it will be automatically generated by the server.

2430

# 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.

2431

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2432

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2433

# - "public" - The event is public and event details are visible to all readers of the calendar.

2434

# - "private" - The event is private and only event attendees may view event details.

2435

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2436

"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.

2437

"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.

2438

"A String",

2439

],

2440

"description": "A String", # Description of the event. Can contain HTML. Optional.

2441

"reminders": { # Information about the event's reminders for the authenticated user.

2442

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2443

"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.

2444

{

2445

"method": "A String", # The method used by this reminder. Possible values are:

2446

# - "email" - Reminders are sent via email.

2447

# - "popup" - Reminders are sent via a UI popup.

2448

# Required when adding a reminder.

2449

"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).

2450

# Required when adding a reminder.

2451

},

2452

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2453

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2454

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2455

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2456

"displayName": "A String", # The attendee's name, if available. Optional.

2457

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2458

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2459

"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.

2460

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2461

"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.

2462

# Required when adding an attendee.

2463

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2464

"responseStatus": "A String", # The attendee's response status. Possible values are:

2465

# - "needsAction" - The attendee has not responded to the invitation.

2466

# - "declined" - The attendee has declined the invitation.

2467

# - "tentative" - The attendee has tentatively accepted the invitation.

2468

# - "accepted" - The attendee has accepted the invitation.

2469

"comment": "A String", # The attendee's response comment. Optional.

2470

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2471

},

2472

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2473

"kind": "calendar#event", # Type of the resource ("calendar#event").

2474

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2475

"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.

2476

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2477

"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.

2478

},

2479

"creator": { # The creator of the event. Read-only.

2480

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2481

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2482

"displayName": "A String", # The creator's name, if available.

2483

"email": "A String", # The creator's email address, if available.

2484

},

2485

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2486

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2487

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2488

"status": "A String", # Status of the event. Optional. Possible values are:

2489

# - "confirmed" - The event is confirmed. This is the default status.

2490

# - "tentative" - The event is tentatively confirmed.

2491

# - "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.

2492

# A cancelled status represents two different states depending on the event type:

2493

# - 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.

2494

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2495

# - 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.

2496

# 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.

2497

# 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.

2498

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2499

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2500

# There can be at most 25 attachments per event,

2501

{

2502

"fileId": "A String", # ID of the attached file. Read-only.

2503

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2504

"title": "A String", # Attachment title.

2505

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2506

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2507

"fileUrl": "A String", # URL link to the attachment.

2508

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2509

# Required when adding an attachment.

2510

},

2511

],

2512

"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.

2513

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2514

"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.

2515

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2516

"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.

2517

},

2518

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2519

# - "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.

2520

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2521

"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.

2522

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2523

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2524

},

2525

"extendedProperties": { # Extended properties of the event.

2526

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2527

"a_key": "A String", # The name of the private property and the corresponding value.

2528

},

2529

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2530

"a_key": "A String", # The name of the shared property and the corresponding value.

2531

},

2532

},

2533

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2534

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2535

"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.

2536

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2537

# Unset for a conference with a failed create request.

2538

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2539

"key": { # The key which can uniquely identify the conference solution for this event.

2540

"type": "A String", # The conference solution type.

2541

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2542

# The possible values are:

2543

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2544

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

2545

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2546

# - "addOn" for 3P conference providers

2547

},

2548

"iconUri": "A String", # The user-visible icon for this solution.

2549

"name": "A String", # The user-visible name of this solution. Not localized.

2550

},

2551

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2552

"addOnParameters": { # Additional add-on specific data.

2553

"parameters": {

2554

"a_key": "A String",

2555

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2556

},

2557

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2558

"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.

2559

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2560

"status": { # The status of the conference create request.

2561

"statusCode": "A String", # The current status of the conference create request. Read-only.

2562

# The possible values are:

2563

# - "pending": the conference create request is still being processed.

2564

# - "success": the conference create request succeeded, the entry points are populated.

2565

# - "failure": the conference create request failed, there are no entry points.

2566

},

2567

"requestId": "A String", # The client-generated unique ID for this request.

2568

# 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.

2569

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2570

"type": "A String", # The conference solution type.

2571

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2572

# The possible values are:

2573

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2574

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

2575

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2576

# - "addOn" for 3P conference providers

2577

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2578

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2579

"conferenceId": "A String", # The ID of the conference.

2580

# Can be used by developers to keep track of conferences, should not be displayed to users.

2581

# Values for solution types:

2582

# - "eventHangout": unset.

2583

# - "eventNamedHangout": the name of the Hangout.

2584

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2585

# - "addOn": defined by 3P conference provider. Optional.

2586

"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.

2587

"signature": "A String", # The signature of the conference data.

2588

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2589

# Unset for a conference with a failed create request.

2590

# Optional for a conference with a pending create request.

2591

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2592

# All of them must belong to the same conference.

2593

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2594

{

2595

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2596

# Format:

2597

# - for video, http: or https: schema is required.

2598

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2599

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2600

# - for more, http: or https: schema is required.

2601

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2602

# 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.

2603

# Optional.

2604

"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.

2605

"A String",

2606

],

2607

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2608

# 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.

2609

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2610

# 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.

2611

# Optional.

2612

"entryPointType": "A String", # The type of the conference entry point.

2613

# Possible values are:

2614

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2615

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2616

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2617

# - "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.

2618

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2619

# 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.

2620

# Optional.

2621

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2622

# Calendar backend will populate this field only for EntryPointType.PHONE.

2623

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2624

# Examples:

2625

# - for video: meet.google.com/aaa-bbbb-ccc

2626

# - for phone: +1 123 268 2601

2627

# - for sip: 12345678@altostrat.com

2628

# - for more: should not be filled

2629

# Optional.

2630

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2631

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2637

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2638

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2639

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.

2640

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2641

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2642

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

2643

Allowed values

2644

all - Notifications are sent to all guests.

2645

externalOnly - Notifications are sent to non-Google Calendar guests only.

2646

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).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2647

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).

2648

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2649

2650

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2651

2652

Returns:

2653

An object of the form:

2654

2655

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2656

"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.

2657

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2658

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2659

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2660

"displayName": "A String", # The organizer's name, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2661

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2662

"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.

2663

"summary": "A String", # Title of the event.

2664

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2665

"location": "A String", # Geographic location of the event as free-form text. Optional.

2666

"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.

2667

"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.

2668

"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.

2669

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2670

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2671

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2672

"gadget": { # A gadget that extends this event.

2673

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

2674

"display": "A String", # The gadget's display mode. Optional. Possible values are:

2675

# - "icon" - The gadget displays next to the event's title in the calendar view.

2676

# - "chip" - The gadget displays when the event is clicked.

2677

"title": "A String", # The gadget's title.

2678

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

2679

"preferences": { # Preferences.

2680

"a_key": "A String", # The preference name and corresponding value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2681

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2682

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

2683

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

2684

"type": "A String", # The gadget's type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2685

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2686

"sequence": 42, # Sequence number as per iCalendar.

2687

"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.

2688

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

2689

"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.

2690

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2691

"etag": "A String", # ETag of the resource.

2692

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2693

"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:

2694

# - 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

2695

# - the length of the ID must be between 5 and 1024 characters

2696

# - 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.

2697

# If you do not specify an ID, it will be automatically generated by the server.

2698

# 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.

2699

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2700

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2701

# - "public" - The event is public and event details are visible to all readers of the calendar.

2702

# - "private" - The event is private and only event attendees may view event details.

2703

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2704

"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.

2705

"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.

2706

"A String",

2707

],

2708

"description": "A String", # Description of the event. Can contain HTML. Optional.

2709

"reminders": { # Information about the event's reminders for the authenticated user.

2710

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2711

"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.

2712

{

2713

"method": "A String", # The method used by this reminder. Possible values are:

2714

# - "email" - Reminders are sent via email.

2715

# - "popup" - Reminders are sent via a UI popup.

2716

# Required when adding a reminder.

2717

"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).

2718

# Required when adding a reminder.

2719

},

2720

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2721

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2722

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2723

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2724

"displayName": "A String", # The attendee's name, if available. Optional.

2725

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2726

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2727

"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.

2728

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2729

"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.

2730

# Required when adding an attendee.

2731

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2732

"responseStatus": "A String", # The attendee's response status. Possible values are:

2733

# - "needsAction" - The attendee has not responded to the invitation.

2734

# - "declined" - The attendee has declined the invitation.

2735

# - "tentative" - The attendee has tentatively accepted the invitation.

2736

# - "accepted" - The attendee has accepted the invitation.

2737

"comment": "A String", # The attendee's response comment. Optional.

2738

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2739

},

2740

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2741

"kind": "calendar#event", # Type of the resource ("calendar#event").

2742

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2743

"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.

2744

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2745

"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.

2746

},

2747

"creator": { # The creator of the event. Read-only.

2748

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2749

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2750

"displayName": "A String", # The creator's name, if available.

2751

"email": "A String", # The creator's email address, if available.

2752

},

2753

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2754

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2755

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2756

"status": "A String", # Status of the event. Optional. Possible values are:

2757

# - "confirmed" - The event is confirmed. This is the default status.

2758

# - "tentative" - The event is tentatively confirmed.

2759

# - "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.

2760

# A cancelled status represents two different states depending on the event type:

2761

# - 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.

2762

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2763

# - 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.

2764

# 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.

2765

# 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.

2766

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2767

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2768

# There can be at most 25 attachments per event,

2769

{

2770

"fileId": "A String", # ID of the attached file. Read-only.

2771

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2772

"title": "A String", # Attachment title.

2773

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2774

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2775

"fileUrl": "A String", # URL link to the attachment.

2776

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2777

# Required when adding an attachment.

2778

},

2779

],

2780

"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.

2781

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2782

"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.

2783

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2784

"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.

2785

},

2786

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2787

# - "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.

2788

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2789

"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.

2790

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2791

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2792

},

2793

"extendedProperties": { # Extended properties of the event.

2794

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2795

"a_key": "A String", # The name of the private property and the corresponding value.

2796

},

2797

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2798

"a_key": "A String", # The name of the shared property and the corresponding value.

2799

},

2800

},

2801

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2802

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2803

"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.

2804

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2805

# Unset for a conference with a failed create request.

2806

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2807

"key": { # The key which can uniquely identify the conference solution for this event.

2808

"type": "A String", # The conference solution type.

2809

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2810

# The possible values are:

2811

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2812

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

2813

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2814

# - "addOn" for 3P conference providers

2815

},

2816

"iconUri": "A String", # The user-visible icon for this solution.

2817

"name": "A String", # The user-visible name of this solution. Not localized.

2818

},

2819

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2820

"addOnParameters": { # Additional add-on specific data.

2821

"parameters": {

2822

"a_key": "A String",

2823

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2824

},

2825

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2826

"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.

2827

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2828

"status": { # The status of the conference create request.

2829

"statusCode": "A String", # The current status of the conference create request. Read-only.

2830

# The possible values are:

2831

# - "pending": the conference create request is still being processed.

2832

# - "success": the conference create request succeeded, the entry points are populated.

2833

# - "failure": the conference create request failed, there are no entry points.

2834

},

2835

"requestId": "A String", # The client-generated unique ID for this request.

2836

# 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.

2837

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2838

"type": "A String", # The conference solution type.

2839

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2840

# The possible values are:

2841

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2842

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

2843

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2844

# - "addOn" for 3P conference providers

2845

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2846

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2847

"conferenceId": "A String", # The ID of the conference.

2848

# Can be used by developers to keep track of conferences, should not be displayed to users.

2849

# Values for solution types:

2850

# - "eventHangout": unset.

2851

# - "eventNamedHangout": the name of the Hangout.

2852

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2853

# - "addOn": defined by 3P conference provider. Optional.

2854

"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.

2855

"signature": "A String", # The signature of the conference data.

2856

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2857

# Unset for a conference with a failed create request.

2858

# Optional for a conference with a pending create request.

2859

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2860

# All of them must belong to the same conference.

2861

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2862

{

2863

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2864

# Format:

2865

# - for video, http: or https: schema is required.

2866

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2867

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2868

# - for more, http: or https: schema is required.

2869

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2870

# 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.

2871

# Optional.

2872

"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.

2873

"A String",

2874

],

2875

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2876

# 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.

2877

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2878

# 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.

2879

# Optional.

2880

"entryPointType": "A String", # The type of the conference entry point.

2881

# Possible values are:

2882

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2883

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2884

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2885

# - "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.

2886

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2887

# 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.

2888

# Optional.

2889

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2890

# Calendar backend will populate this field only for EntryPointType.PHONE.

2891

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2892

# Examples:

2893

# - for video: meet.google.com/aaa-bbbb-ccc

2894

# - for phone: +1 123 268 2601

2895

# - for sip: 12345678@altostrat.com

2896

# - for more: should not be filled

2897

# Optional.

2898

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2899

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2905

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2909

<code class="details" id="quickAdd">quickAdd(calendarId, text, sendUpdates=None, sendNotifications=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2910

<pre>Creates an event based on a simple text string.

2911

2912

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2913

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

2014-04-24 15:46:26 -0400

[diff] [blame]

2914

text: string, The text describing the event to be created. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2915

sendUpdates: string, Guests who should receive notifications about the creation of the new event.

2916

Allowed values

2917

all - Notifications are sent to all guests.

2918

externalOnly - Notifications are sent to non-Google Calendar guests only.

2919

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).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2920

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2921

2922

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2923

2924

Returns:

2925

An object of the form:

2926

2927

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2928

"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.

2929

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2930

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2931

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2932

"displayName": "A String", # The organizer's name, if available.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2933

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2934

"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.

2935

"summary": "A String", # Title of the event.

2936

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2937

"location": "A String", # Geographic location of the event as free-form text. Optional.

2938

"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.

2939

"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.

2940

"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.

2941

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2942

"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2943

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2944

"gadget": { # A gadget that extends this event.

2945

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

2946

"display": "A String", # The gadget's display mode. Optional. Possible values are:

2947

# - "icon" - The gadget displays next to the event's title in the calendar view.

2948

# - "chip" - The gadget displays when the event is clicked.

2949

"title": "A String", # The gadget's title.

2950

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

2951

"preferences": { # Preferences.

2952

"a_key": "A String", # The preference name and corresponding value.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2953

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2954

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

2955

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

2956

"type": "A String", # The gadget's type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2957

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2958

"sequence": 42, # Sequence number as per iCalendar.

2959

"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.

2960

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

2961

"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.

2962

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2963

"etag": "A String", # ETag of the resource.

2964

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2965

"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:

2966

# - 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

2967

# - the length of the ID must be between 5 and 1024 characters

2968

# - 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.

2969

# If you do not specify an ID, it will be automatically generated by the server.

2970

# 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.

2971

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2972

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2973

# - "public" - The event is public and event details are visible to all readers of the calendar.

2974

# - "private" - The event is private and only event attendees may view event details.

2975

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2976

"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.

2977

"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.

2978

"A String",

2979

],

2980

"description": "A String", # Description of the event. Can contain HTML. Optional.

2981

"reminders": { # Information about the event's reminders for the authenticated user.

2982

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2983

"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.

2984

{

2985

"method": "A String", # The method used by this reminder. Possible values are:

2986

# - "email" - Reminders are sent via email.

2987

# - "popup" - Reminders are sent via a UI popup.

2988

# Required when adding a reminder.

2989

"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).

2990

# Required when adding a reminder.

2991

},

2992

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2993

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2994

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2995

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2996

"displayName": "A String", # The attendee's name, if available. Optional.

2997

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2998

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2999

"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.

3000

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3001

"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.

3002

# Required when adding an attendee.

3003

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3004

"responseStatus": "A String", # The attendee's response status. Possible values are:

3005

# - "needsAction" - The attendee has not responded to the invitation.

3006

# - "declined" - The attendee has declined the invitation.

3007

# - "tentative" - The attendee has tentatively accepted the invitation.

3008

# - "accepted" - The attendee has accepted the invitation.

3009

"comment": "A String", # The attendee's response comment. Optional.

3010

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3011

},

3012

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3013

"kind": "calendar#event", # Type of the resource ("calendar#event").

3014

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3015

"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.

3016

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3017

"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.

3018

},

3019

"creator": { # The creator of the event. Read-only.

3020

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3021

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3022

"displayName": "A String", # The creator's name, if available.

3023

"email": "A String", # The creator's email address, if available.

3024

},

3025

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3026

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3027

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3028

"status": "A String", # Status of the event. Optional. Possible values are:

3029

# - "confirmed" - The event is confirmed. This is the default status.

3030

# - "tentative" - The event is tentatively confirmed.

3031

# - "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.

3032

# A cancelled status represents two different states depending on the event type:

3033

# - 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.

3034

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3035

# - 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.

3036

# 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.

3037

# 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.

3038

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3039

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3040

# There can be at most 25 attachments per event,

3041

{

3042

"fileId": "A String", # ID of the attached file. Read-only.

3043

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3044

"title": "A String", # Attachment title.

3045

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3046

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3047

"fileUrl": "A String", # URL link to the attachment.

3048

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3049

# Required when adding an attachment.

3050

},

3051

],

3052

"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.

3053

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3054

"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.

3055

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3056

"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.

3057

},

3058

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3059

# - "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.

3060

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3061

"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.

3062

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3063

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3064

},

3065

"extendedProperties": { # Extended properties of the event.

3066

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3067

"a_key": "A String", # The name of the private property and the corresponding value.

3068

},

3069

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3070

"a_key": "A String", # The name of the shared property and the corresponding value.

3071

},

3072

},

3073

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3074

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3075

"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.

3076

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3077

# Unset for a conference with a failed create request.

3078

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3079

"key": { # The key which can uniquely identify the conference solution for this event.

3080

"type": "A String", # The conference solution type.

3081

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3082

# The possible values are:

3083

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3084

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

3085

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3086

# - "addOn" for 3P conference providers

3087

},

3088

"iconUri": "A String", # The user-visible icon for this solution.

3089

"name": "A String", # The user-visible name of this solution. Not localized.

3090

},

3091

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3092

"addOnParameters": { # Additional add-on specific data.

3093

"parameters": {

3094

"a_key": "A String",

3095

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3096

},

3097

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3098

"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.

3099

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3100

"status": { # The status of the conference create request.

3101

"statusCode": "A String", # The current status of the conference create request. Read-only.

3102

# The possible values are:

3103

# - "pending": the conference create request is still being processed.

3104

# - "success": the conference create request succeeded, the entry points are populated.

3105

# - "failure": the conference create request failed, there are no entry points.

3106

},

3107

"requestId": "A String", # The client-generated unique ID for this request.

3108

# 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.

3109

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3110

"type": "A String", # The conference solution type.

3111

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3112

# The possible values are:

3113

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3114

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

3115

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3116

# - "addOn" for 3P conference providers

3117

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3118

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3119

"conferenceId": "A String", # The ID of the conference.

3120

# Can be used by developers to keep track of conferences, should not be displayed to users.

3121

# Values for solution types:

3122

# - "eventHangout": unset.

3123

# - "eventNamedHangout": the name of the Hangout.

3124

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3125

# - "addOn": defined by 3P conference provider. Optional.

3126

"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.

3127

"signature": "A String", # The signature of the conference data.

3128

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3129

# Unset for a conference with a failed create request.

3130

# Optional for a conference with a pending create request.

3131

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3132

# All of them must belong to the same conference.

3133

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3134

{

3135

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3136

# Format:

3137

# - for video, http: or https: schema is required.

3138

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3139

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3140

# - for more, http: or https: schema is required.

3141

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3142

# 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.

3143

# Optional.

3144

"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.

3145

"A String",

3146

],

3147

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3148

# 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.

3149

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3150

# 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.

3151

# Optional.

3152

"entryPointType": "A String", # The type of the conference entry point.

3153

# Possible values are:

3154

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3155

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3156

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3157

# - "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.

3158

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3159

# 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.

3160

# Optional.

3161

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3162

# Calendar backend will populate this field only for EntryPointType.PHONE.

3163

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3164

# Examples:

3165

# - for video: meet.google.com/aaa-bbbb-ccc

3166

# - for phone: +1 123 268 2601

3167

# - for sip: 12345678@altostrat.com

3168

# - for more: should not be filled

3169

# Optional.

3170

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3171

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3177

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3178

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3179

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3180

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3181

<code class="details" id="update">update(calendarId, eventId, body=None, alwaysIncludeEmail=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None, maxAttendees=None, conferenceDataVersion=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3182

<pre>Updates an event.

3183

3184

Args:

3185

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)

3186

eventId: string, Event identifier. (required)

3187

body: object, The request body.

3188

The object takes the form of:

3189

3190

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3191

"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.

3192

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3193

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3194

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3195

"displayName": "A String", # The organizer's name, if available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3196

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3197

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3198

"summary": "A String", # Title of the event.

3199

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3200

"location": "A String", # Geographic location of the event as free-form text. Optional.

3201

"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.

3202

"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.

3203

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3204

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3205

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3206

},

3207

"gadget": { # A gadget that extends this event.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3208

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3209

"display": "A String", # The gadget's display mode. Optional. Possible values are:

3210

# - "icon" - The gadget displays next to the event's title in the calendar view.

3211

# - "chip" - The gadget displays when the event is clicked.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3212

"title": "A String", # The gadget's title.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3213

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

3214

"preferences": { # Preferences.

3215

"a_key": "A String", # The preference name and corresponding value.

3216

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3217

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

3218

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3219

"type": "A String", # The gadget's type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3220

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3221

"sequence": 42, # Sequence number as per iCalendar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3222

"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.

3223

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3224

"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.

3225

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3226

"etag": "A String", # ETag of the resource.

3227

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3228

"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:

3229

# - 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

3230

# - the length of the ID must be between 5 and 1024 characters

3231

# - 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.

3232

# If you do not specify an ID, it will be automatically generated by the server.

3233

# 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3234

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3235

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3236

# - "public" - The event is public and event details are visible to all readers of the calendar.

3237

# - "private" - The event is private and only event attendees may view event details.

3238

# - "confidential" - The event is private. This value is provided for compatibility reasons.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3239

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3240

"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.

3241

"A String",

3242

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3243

"description": "A String", # Description of the event. Can contain HTML. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3244

"reminders": { # Information about the event's reminders for the authenticated user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3245

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3246

"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3247

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3248

"method": "A String", # The method used by this reminder. Possible values are:

3249

# - "email" - Reminders are sent via email.

3250

# - "popup" - Reminders are sent via a UI popup.

3251

# Required when adding a reminder.

3252

"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).

3253

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3254

},

3255

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3256

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3257

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

3258

{

3259

"displayName": "A String", # The attendee's name, if available. Optional.

3260

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3261

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3262

"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.

3263

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3264

"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.

3265

# Required when adding an attendee.

3266

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3267

"responseStatus": "A String", # The attendee's response status. Possible values are:

3268

# - "needsAction" - The attendee has not responded to the invitation.

3269

# - "declined" - The attendee has declined the invitation.

3270

# - "tentative" - The attendee has tentatively accepted the invitation.

3271

# - "accepted" - The attendee has accepted the invitation.

3272

"comment": "A String", # The attendee's response comment. Optional.

3273

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3274

},

3275

],

3276

"kind": "calendar#event", # Type of the resource ("calendar#event").

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3277

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3278

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3279

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3280

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3281

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3282

"creator": { # The creator of the event. Read-only.

3283

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3284

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3285

"displayName": "A String", # The creator's name, if available.

3286

"email": "A String", # The creator's email address, if available.

3287

},

3288

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3289

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3290

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3291

"status": "A String", # Status of the event. Optional. Possible values are:

3292

# - "confirmed" - The event is confirmed. This is the default status.

3293

# - "tentative" - The event is tentatively confirmed.

3294

# - "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.

3295

# A cancelled status represents two different states depending on the event type:

3296

# - 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.

3297

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3298

# - 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.

3299

# 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.

3300

# 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3301

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3302

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3303

# There can be at most 25 attachments per event,

3304

{

3305

"fileId": "A String", # ID of the attached file. Read-only.

3306

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3307

"title": "A String", # Attachment title.

3308

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3309

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3310

"fileUrl": "A String", # URL link to the attachment.

3311

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3312

# Required when adding an attachment.

3313

},

3314

],

3315

"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.

3316

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3317

"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.

3318

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3319

"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.

3320

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3321

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3322

# - "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.

3323

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3324

"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.

3325

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3326

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3327

},

3328

"extendedProperties": { # Extended properties of the event.

3329

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3330

"a_key": "A String", # The name of the private property and the corresponding value.

3331

},

3332

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3333

"a_key": "A String", # The name of the shared property and the corresponding value.

3334

},

3335

},

3336

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3337

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3338

"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.

3339

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3340

# Unset for a conference with a failed create request.

3341

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3342

"key": { # The key which can uniquely identify the conference solution for this event.

3343

"type": "A String", # The conference solution type.

3344

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3345

# The possible values are:

3346

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3347

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

3348

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3349

# - "addOn" for 3P conference providers

3350

},

3351

"iconUri": "A String", # The user-visible icon for this solution.

3352

"name": "A String", # The user-visible name of this solution. Not localized.

3353

},

3354

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3355

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

3362

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3363

"status": { # The status of the conference create request.

3364

"statusCode": "A String", # The current status of the conference create request. Read-only.

3365

# The possible values are:

3366

# - "pending": the conference create request is still being processed.

3367

# - "success": the conference create request succeeded, the entry points are populated.

3368

# - "failure": the conference create request failed, there are no entry points.

3369

},

3370

"requestId": "A String", # The client-generated unique ID for this request.

3371

# 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.

3372

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3373

"type": "A String", # The conference solution type.

3374

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3375

# The possible values are:

3376

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3377

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

3378

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3379

# - "addOn" for 3P conference providers

3380

},

3381

},

3382

"conferenceId": "A String", # The ID of the conference.

3383

# Can be used by developers to keep track of conferences, should not be displayed to users.

3384

# Values for solution types:

3385

# - "eventHangout": unset.

3386

# - "eventNamedHangout": the name of the Hangout.

3387

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3388

# - "addOn": defined by 3P conference provider. Optional.

3389

"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.

3390

"signature": "A String", # The signature of the conference data.

3391

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3392

# Unset for a conference with a failed create request.

3393

# Optional for a conference with a pending create request.

3394

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3395

# All of them must belong to the same conference.

3396

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3397

{

3398

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3399

# Format:

3400

# - for video, http: or https: schema is required.

3401

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3402

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3403

# - for more, http: or https: schema is required.

3404

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3405

# 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.

3406

# Optional.

3407

"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.

3408

"A String",

3409

],

3410

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3411

# 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.

3412

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3413

# 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.

3414

# Optional.

3415

"entryPointType": "A String", # The type of the conference entry point.

3416

# Possible values are:

3417

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3418

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3419

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3420

# - "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.

3421

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3422

# 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.

3423

# Optional.

3424

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3425

# Calendar backend will populate this field only for EntryPointType.PHONE.

3426

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3427

# Examples:

3428

# - for video: meet.google.com/aaa-bbbb-ccc

3429

# - for phone: +1 123 268 2601

3430

# - for sip: 12345678@altostrat.com

3431

# - for more: should not be filled

3432

# Optional.

3433

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3434

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3440

}

3441

3442

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).

3443

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

3444

3445

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.

3446

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

3447

Allowed values

3448

all - Notifications are sent to all guests.

3449

externalOnly - Notifications are sent to non-Google Calendar guests only.

3450

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).

3451

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

3452

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.

3453

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.

3454

3455

Returns:

3456

An object of the form:

3457

3458

{

3459

"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.

3460

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3461

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3462

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3463

"displayName": "A String", # The organizer's name, if available.

3464

},

3465

"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.

3466

"summary": "A String", # Title of the event.

3467

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3468

"location": "A String", # Geographic location of the event as free-form text. Optional.

3469

"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.

3470

"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.

3471

"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.

3472

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3473

"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.

3474

},

3475

"gadget": { # A gadget that extends this event.

3476

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

3477

"display": "A String", # The gadget's display mode. Optional. Possible values are:

3478

# - "icon" - The gadget displays next to the event's title in the calendar view.

3479

# - "chip" - The gadget displays when the event is clicked.

3480

"title": "A String", # The gadget's title.

3481

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

3482

"preferences": { # Preferences.

3483

"a_key": "A String", # The preference name and corresponding value.

3484

},

3485

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

3486

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

3487

"type": "A String", # The gadget's type.

3488

},

3489

"sequence": 42, # Sequence number as per iCalendar.

3490

"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.

3491

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

3492

"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.

3493

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3494

"etag": "A String", # ETag of the resource.

3495

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3496

"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:

3497

# - 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

3498

# - the length of the ID must be between 5 and 1024 characters

3499

# - 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.

3500

# If you do not specify an ID, it will be automatically generated by the server.

3501

# 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.

3502

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3503

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3504

# - "public" - The event is public and event details are visible to all readers of the calendar.

3505

# - "private" - The event is private and only event attendees may view event details.

3506

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3507

"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.

3508

"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.

3509

"A String",

3510

],

3511

"description": "A String", # Description of the event. Can contain HTML. Optional.

3512

"reminders": { # Information about the event's reminders for the authenticated user.

3513

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3514

"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.

3515

{

3516

"method": "A String", # The method used by this reminder. Possible values are:

3517

# - "email" - Reminders are sent via email.

3518

# - "popup" - Reminders are sent via a UI popup.

3519

# Required when adding a reminder.

3520

"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).

3521

# Required when adding a reminder.

},

],

},

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

3526

{

3527

"displayName": "A String", # The attendee's name, if available. Optional.

3528

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3529

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3530

"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.

3531

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3532

"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.

3533

# Required when adding an attendee.

3534

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3535

"responseStatus": "A String", # The attendee's response status. Possible values are:

3536

# - "needsAction" - The attendee has not responded to the invitation.

3537

# - "declined" - The attendee has declined the invitation.

3538

# - "tentative" - The attendee has tentatively accepted the invitation.

3539

# - "accepted" - The attendee has accepted the invitation.

3540

"comment": "A String", # The attendee's response comment. Optional.

3541

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3542

},

3543

],

3544

"kind": "calendar#event", # Type of the resource ("calendar#event").

3545

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3546

"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.

3547

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3548

"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.

3549

},

3550

"creator": { # The creator of the event. Read-only.

3551

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3552

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3553

"displayName": "A String", # The creator's name, if available.

3554

"email": "A String", # The creator's email address, if available.

3555

},

3556

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3557

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3558

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3559

"status": "A String", # Status of the event. Optional. Possible values are:

3560

# - "confirmed" - The event is confirmed. This is the default status.

3561

# - "tentative" - The event is tentatively confirmed.

3562

# - "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.

3563

# A cancelled status represents two different states depending on the event type:

3564

# - 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.

3565

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3566

# - 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.

3567

# 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.

3568

# 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.

3569

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3570

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3571

# There can be at most 25 attachments per event,

3572

{

3573

"fileId": "A String", # ID of the attached file. Read-only.

3574

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3575

"title": "A String", # Attachment title.

3576

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3577

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3578

"fileUrl": "A String", # URL link to the attachment.

3579

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3580

# Required when adding an attachment.

3581

},

3582

],

3583

"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.

3584

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3585

"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.

3586

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3587

"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.

3588

},

3589

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3590

# - "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.

3591

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3592

"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.

3593

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3594

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3595

},

3596

"extendedProperties": { # Extended properties of the event.

3597

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3598

"a_key": "A String", # The name of the private property and the corresponding value.

3599

},

3600

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3601

"a_key": "A String", # The name of the shared property and the corresponding value.

3602

},

3603

},

3604

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3605

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3606

"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.

3607

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3608

# Unset for a conference with a failed create request.

3609

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3610

"key": { # The key which can uniquely identify the conference solution for this event.

3611

"type": "A String", # The conference solution type.

3612

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3613

# The possible values are:

3614

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3615

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

3616

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3617

# - "addOn" for 3P conference providers

3618

},

3619

"iconUri": "A String", # The user-visible icon for this solution.

3620

"name": "A String", # The user-visible name of this solution. Not localized.

3621

},

3622

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3623

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

3630

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3631

"status": { # The status of the conference create request.

3632

"statusCode": "A String", # The current status of the conference create request. Read-only.

3633

# The possible values are:

3634

# - "pending": the conference create request is still being processed.

3635

# - "success": the conference create request succeeded, the entry points are populated.

3636

# - "failure": the conference create request failed, there are no entry points.

3637

},

3638

"requestId": "A String", # The client-generated unique ID for this request.

3639

# 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.

3640

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3641

"type": "A String", # The conference solution type.

3642

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3643

# The possible values are:

3644

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3645

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

3646

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3647

# - "addOn" for 3P conference providers

3648

},

3649

},

3650

"conferenceId": "A String", # The ID of the conference.

3651

# Can be used by developers to keep track of conferences, should not be displayed to users.

3652

# Values for solution types:

3653

# - "eventHangout": unset.

3654

# - "eventNamedHangout": the name of the Hangout.

3655

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3656

# - "addOn": defined by 3P conference provider. Optional.

3657

"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.

3658

"signature": "A String", # The signature of the conference data.

3659

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3660

# Unset for a conference with a failed create request.

3661

# Optional for a conference with a pending create request.

3662

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3663

# All of them must belong to the same conference.

3664

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3665

{

3666

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3667

# Format:

3668

# - for video, http: or https: schema is required.

3669

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3670

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3671

# - for more, http: or https: schema is required.

3672

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3673

# 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.

3674

# Optional.

3675

"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.

3676

"A String",

3677

],

3678

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3679

# 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.

3680

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3681

# 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.

3682

# Optional.

3683

"entryPointType": "A String", # The type of the conference entry point.

3684

# Possible values are:

3685

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3686

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3687

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3688

# - "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.

3689

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3690

# 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.

3691

# Optional.

3692

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3693

# Calendar backend will populate this field only for EntryPointType.PHONE.

3694

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3695

# Examples:

3696

# - for video: meet.google.com/aaa-bbbb-ccc

3697

# - for phone: +1 123 268 2601

3698

# - for sip: 12345678@altostrat.com

3699

# - for more: should not be filled

3700

# Optional.

3701

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3702

# 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.

# Optional.

},

],

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3708

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3712

<code class="details" id="watch">watch(calendarId, body=None, maxAttendees=None, privateExtendedProperty=None, q=None, updatedMin=None, maxResults=None, timeMin=None, orderBy=None, singleEvents=None, timeMax=None, syncToken=None, timeZone=None, pageToken=None, sharedExtendedProperty=None, showHiddenInvitations=None, alwaysIncludeEmail=None, iCalUID=None, showDeleted=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3713

<pre>Watch for changes to Events resources.

3714

3715

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3716

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]

3717

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3718

The object takes the form of:

3719

3720

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3721

"resourceUri": "A String", # A version-specific identifier for the watched resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3722

"address": "A String", # The address where notifications are delivered for this channel.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3723

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3724

"params": { # Additional parameters controlling delivery channel behavior. Optional.

3725

"a_key": "A String", # Declares a new parameter by name.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3726

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3727

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3728

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3729

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3730

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

3731

"id": "A String", # A UUID or similar unique string that identifies this channel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3732

"type": "A String", # The type of delivery mechanism used for this channel.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3733

}

3734

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3735

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3736

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)

3737

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

3738

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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3739

maxResults: integer, Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3740

timeMin: string, Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3741

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

3742

Allowed values

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3743

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3744

updated - Order by last modification time (ascending).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3745

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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3746

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.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3747

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.

3748

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

3754

- q

3755

- sharedExtendedProperty

3756

- timeMin

3757

- timeMax

3758

- 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.

3759

Learn more about incremental synchronization.

3760

Optional. The default is to return all entries.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3761

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3762

pageToken: string, Token specifying which result page to return. Optional.

3763

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)

3764

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

3765

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).

3766

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

3767

showDeleted: boolean, Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

John Asmuth