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

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

[diff] [blame]

91

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

92

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

93

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

John Asmuth

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

[diff] [blame]

94

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

95

96

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

97

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

98

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

99

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

John Asmuth

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

[diff] [blame]

100

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

101

102

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

103

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

104

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

105

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

John Asmuth

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

[diff] [blame]

106

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

107

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

108

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

John Asmuth

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

[diff] [blame]

109

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

110

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

111

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

John Asmuth

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

[diff] [blame]

112

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

113

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

114

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

John Asmuth

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

[diff] [blame]

115

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

116

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

117

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

John Asmuth

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

[diff] [blame]

118

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

119

<h3>Method Details</h3>

120

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

121

<code class="details" id="close">close()</code>

122

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

126

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

John Asmuth

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

[diff] [blame]

127

<pre>Deletes an event.

128

129

Args:

Bu Sun Kim

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

[diff] [blame]

130

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

John Asmuth

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

[diff] [blame]

131

eventId: string, Event identifier. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

132

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

133

134

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.

Bu Sun Kim

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

[diff] [blame]

135

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

136

Allowed values

137

all - Notifications are sent to all guests.

138

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

139

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]

</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

144

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

145

<pre>Returns an event.

146

147

Args:

Bu Sun Kim

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

[diff] [blame]

148

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

John Asmuth

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

[diff] [blame]

149

eventId: string, Event identifier. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

150

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-11-16 11:05:03 -0700

[diff] [blame]

151

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]

152

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

John Asmuth

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

[diff] [blame]

153

154

Returns:

155

An object of the form:

156

157

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

158

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

159

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

160

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

161

{

162

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

163

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

164

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

165

# Required when adding a reminder.

166

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

167

# Required when adding a reminder.

168

},

169

],

Bu Sun Kim

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

[diff] [blame]

170

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

171

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

172

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

173

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

174

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

175

{

176

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

177

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

178

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

179

# Required when adding an attendee.

180

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

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

},

192

],

193

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

194

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

195

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

196

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

197

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

# There can be at most 25 attachments per event,

210

{

211

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

212

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

213

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

214

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

215

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

216

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

217

# Required when adding an attachment.

218

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

219

},

220

],

221

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

222

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

223

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

224

},

225

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

226

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

227

},

Bu Sun Kim

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

[diff] [blame]

228

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

229

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

230

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

231

"A String",

232

],

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

},

241

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

242

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

243

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

244

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

245

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

246

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

247

# The possible values are:

248

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

249

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

250

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

251

# - "addOn" for 3P conference providers

252

},

253

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

254

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

255

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

256

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

257

# The possible values are:

258

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

259

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

260

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

261

},

262

},

263

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

264

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

265

# Values for solution types:

266

# - "eventHangout": unset.

267

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

268

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

269

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

270

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

271

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

272

# Unset for a conference with a failed create request.

273

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

274

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

275

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

276

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

277

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

278

# The possible values are:

279

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

280

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

281

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

282

# - "addOn" for 3P conference providers

283

},

284

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

285

},

286

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

287

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

288

# Unset for a conference with a failed create request.

289

# Optional for a conference with a pending create request.

290

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

291

# All of them must belong to the same conference.

292

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

293

{

294

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

295

# Possible values are:

296

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

297

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

298

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

299

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

300

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

301

"A String",

302

],

303

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

304

# Examples:

305

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

306

# - for phone: +1 123 268 2601

307

# - for sip: 12345678@altostrat.com

308

# - for more: should not be filled

309

# Optional.

310

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

311

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

312

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

313

# Format:

314

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

315

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

316

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

317

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

318

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

319

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

320

# Optional.

321

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

322

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

323

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

324

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

325

# Optional.

326

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

327

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

328

# Optional.

329

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

330

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

},

],

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

335

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

336

"parameters": {

337

"a_key": "A String",

338

},

Bu Sun Kim

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

[diff] [blame]

339

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

340

},

Bu Sun Kim

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

[diff] [blame]

341

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

342

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

343

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

344

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

345

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

346

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

360

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

361

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

362

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

363

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

364

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

365

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

366

"preferences": { # Preferences.

367

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

Takashi Matsuo

0669410

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

[diff] [blame]

368

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

369

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

370

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

371

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

Bu Sun Kim

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

[diff] [blame]

372

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

Bu Sun Kim

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

[diff] [blame]

391

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

392

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

393

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

394

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

395

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

396

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

397

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

Bu Sun Kim

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

[diff] [blame]

398

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

399

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

400

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

401

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

402

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

403

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

404

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

405

},

406

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

407

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

411

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

John Asmuth

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

[diff] [blame]

412

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

413

414

Args:

Bu Sun Kim

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

[diff] [blame]

415

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

416

body: object, The request body.

John Asmuth

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

[diff] [blame]

417

The object takes the form of:

418

419

{

Bu Sun Kim

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

[diff] [blame]

420

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

Bu Sun Kim

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

[diff] [blame]

421

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

422

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

423

{

424

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

425

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

426

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

427

# Required when adding a reminder.

428

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

429

# Required when adding a reminder.

430

},

431

],

Bu Sun Kim

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

[diff] [blame]

432

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

433

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

434

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

435

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

436

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

437

{

438

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

439

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

440

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

441

# Required when adding an attendee.

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

},

454

],

455

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

456

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

Bu Sun Kim

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

[diff] [blame]

457

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

458

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

459

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

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

471

# There can be at most 25 attachments per event,

472

{

Bu Sun Kim

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

[diff] [blame]

473

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

474

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

475

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

476

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

Bu Sun Kim

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

[diff] [blame]

477

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

478

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

479

# Required when adding an attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

480

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

Bu Sun Kim

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

[diff] [blame]

481

},

482

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

483

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

484

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

485

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

486

},

487

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

488

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

489

},

490

},

491

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

492

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

493

"A String",

494

],

495

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

496

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

497

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

498

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

499

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

500

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

501

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

502

},

503

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

504

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

505

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

506

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

507

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

508

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

509

# The possible values are:

510

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

511

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

512

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

513

# - "addOn" for 3P conference providers

514

},

515

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

516

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

517

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

518

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

519

# The possible values are:

520

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

521

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

522

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

523

},

524

},

525

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

526

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

527

# Values for solution types:

528

# - "eventHangout": unset.

529

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

530

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

531

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

532

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

533

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

534

# Unset for a conference with a failed create request.

535

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

536

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

537

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

538

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

539

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

540

# The possible values are:

541

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

542

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

543

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

544

# - "addOn" for 3P conference providers

545

},

546

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

547

},

548

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

549

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

550

# Unset for a conference with a failed create request.

551

# Optional for a conference with a pending create request.

552

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

553

# All of them must belong to the same conference.

554

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

555

{

556

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

557

# Possible values are:

558

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

559

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

560

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

561

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

562

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

563

"A String",

564

],

565

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

566

# Examples:

567

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

568

# - for phone: +1 123 268 2601

569

# - for sip: 12345678@altostrat.com

570

# - for more: should not be filled

571

# Optional.

572

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

573

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

574

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

575

# Format:

576

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

577

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

578

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

579

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

580

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

581

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

582

# Optional.

583

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

584

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

585

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

586

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

587

# Optional.

588

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

589

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

590

# Optional.

591

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

592

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

},

],

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

597

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

"parameters": {

"a_key": "A String",

},

},

},

},

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

605

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

606

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

607

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

608

},

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

622

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

623

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

624

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

625

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

626

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

627

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

628

"preferences": { # Preferences.

629

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

630

},

631

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

632

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

633

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

634

},

635

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

636

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

637

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

638

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

639

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

640

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

641

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

642

"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-11-16 11:05:03 -0700

[diff] [blame]

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

},

654

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

655

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

656

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

657

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

658

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

659

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

660

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

661

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

662

# 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-11-16 11:05:03 -0700

[diff] [blame]

663

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

664

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

665

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

666

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

667

},

668

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

669

}

670

671

conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

672

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

673

674

Returns:

675

An object of the form:

676

677

{

678

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

679

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

680

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

681

{

682

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

683

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

684

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

685

# Required when adding a reminder.

686

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

687

# Required when adding a reminder.

688

},

689

],

Bu Sun Kim

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

[diff] [blame]

690

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

691

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

692

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

693

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

694

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

695

{

696

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

697

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

698

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

699

# Required when adding an attendee.

700

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

701

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

702

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

703

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

704

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

705

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

706

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

707

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

708

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

709

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

710

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

711

},

712

],

713

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

714

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

715

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

716

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

717

},

718

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

719

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

720

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

721

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

722

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

723

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

724

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

725

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

726

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

727

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

728

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

729

# There can be at most 25 attachments per event,

730

{

731

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

732

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

733

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

734

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

735

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

736

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

737

# Required when adding an attachment.

738

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

739

},

740

],

741

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

742

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

743

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

744

},

745

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

746

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

747

},

748

},

749

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

750

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

751

"A String",

752

],

753

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

754

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

755

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

756

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

757

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

758

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

759

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

760

},

761

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

762

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

763

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

764

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

765

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

766

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

767

# The possible values are:

768

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

769

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

770

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

771

# - "addOn" for 3P conference providers

772

},

773

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

774

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

775

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

776

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

777

# The possible values are:

778

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

779

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

780

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

781

},

782

},

783

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

784

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

785

# Values for solution types:

786

# - "eventHangout": unset.

787

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

788

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

789

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

790

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

791

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

792

# Unset for a conference with a failed create request.

793

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

794

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

795

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

796

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

797

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

798

# The possible values are:

799

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

800

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

801

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

802

# - "addOn" for 3P conference providers

803

},

804

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

805

},

806

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

807

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

808

# Unset for a conference with a failed create request.

809

# Optional for a conference with a pending create request.

810

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

811

# All of them must belong to the same conference.

812

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

813

{

814

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

815

# Possible values are:

816

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

817

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

818

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

819

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

820

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

821

"A String",

822

],

823

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

824

# Examples:

825

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

826

# - for phone: +1 123 268 2601

827

# - for sip: 12345678@altostrat.com

828

# - for more: should not be filled

829

# Optional.

830

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

831

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

832

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

833

# Format:

834

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

835

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

836

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

837

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

838

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

839

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

840

# Optional.

841

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

842

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

843

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

844

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

845

# Optional.

846

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

847

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

848

# Optional.

849

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

850

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

},

],

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

855

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

"parameters": {

"a_key": "A String",

},

},

},

},

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

863

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

864

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

865

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

866

},

867

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

868

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

869

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

870

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

871

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

872

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

873

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

874

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

875

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

876

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

877

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

878

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

879

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

880

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

881

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

882

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

883

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

884

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

885

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

886

"preferences": { # Preferences.

887

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

888

},

889

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

890

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

891

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

892

},

893

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

894

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

895

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

896

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

897

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

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

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

908

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

909

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

910

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

911

},

912

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

913

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

914

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

915

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

916

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

917

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

918

},

919

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

920

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

921

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

922

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

923

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

924

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

925

},

926

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

927

}</pre>

Bu Sun Kim

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

[diff] [blame]

928

</div>

John Asmuth

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

[diff] [blame]

929

Bu Sun Kim

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

[diff] [blame]

930

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

931

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

Bu Sun Kim

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

[diff] [blame]

932

<pre>Creates an event.

933

934

Args:

935

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

936

body: object, The request body.

937

The object takes the form of:

938

939

{

Bu Sun Kim

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

[diff] [blame]

940

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

Bu Sun Kim

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

[diff] [blame]

941

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

942

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

943

{

Bu Sun Kim

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

[diff] [blame]

944

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

945

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

946

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

947

# Required when adding a reminder.

948

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

949

# Required when adding a reminder.

John Asmuth

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

[diff] [blame]

950

},

951

],

Bu Sun Kim

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

[diff] [blame]

952

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

953

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

954

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

955

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

956

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

957

{

958

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

959

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

960

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

961

# Required when adding an attendee.

962

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

963

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

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

973

},

974

],

975

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

976

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

Bu Sun Kim

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

[diff] [blame]

977

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

978

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

979

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

980

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

981

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

982

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

983

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

984

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

985

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

986

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

987

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

988

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

989

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

990

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

991

# There can be at most 25 attachments per event,

992

{

Bu Sun Kim

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

[diff] [blame]

993

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

994

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

995

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

996

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

Bu Sun Kim

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

[diff] [blame]

997

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

998

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

999

# Required when adding an attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1000

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

Bu Sun Kim

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

[diff] [blame]

1001

},

1002

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1003

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

1004

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

1005

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

1006

},

1007

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

1008

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

1009

},

1010

},

1011

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

1012

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

1013

"A String",

1014

],

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

},

1023

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

1024

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

1025

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

1026

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

1027

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

1028

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

1029

# The possible values are:

1030

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

1031

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

1032

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

1033

# - "addOn" for 3P conference providers

1034

},

1035

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

1036

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

1037

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

1038

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

1039

# The possible values are:

1040

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

1041

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

1042

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

1043

},

1044

},

1045

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

1046

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

1047

# Values for solution types:

1048

# - "eventHangout": unset.

1049

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

1050

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

1051

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

1052

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

1053

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

1054

# Unset for a conference with a failed create request.

1055

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

1056

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

1057

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

1058

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

1059

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

1060

# The possible values are:

1061

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

1062

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

1063

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

1064

# - "addOn" for 3P conference providers

1065

},

1066

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

1067

},

1068

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

1069

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

1070

# Unset for a conference with a failed create request.

1071

# Optional for a conference with a pending create request.

1072

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

1073

# All of them must belong to the same conference.

1074

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

1075

{

1076

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

1077

# Possible values are:

1078

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

1079

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

1080

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

1081

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

1082

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

1083

"A String",

1084

],

1085

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

1086

# Examples:

1087

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

1088

# - for phone: +1 123 268 2601

1089

# - for sip: 12345678@altostrat.com

1090

# - for more: should not be filled

1091

# Optional.

1092

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

1093

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

1094

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

1095

# Format:

1096

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

1097

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

1098

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

1099

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

1100

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

1101

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

1102

# Optional.

1103

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

1104

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

1105

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

1106

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

1107

# Optional.

1108

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

1109

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

1110

# Optional.

1111

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

1112

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

},

],

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

1117

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

"parameters": {

"a_key": "A String",

},

},

},

},

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

1125

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

1126

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

1127

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

1128

},

1129

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

1130

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

1131

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

1132

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

1133

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

1134

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

1135

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

1136

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

1137

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

1138

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

1139

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

1140

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

1141

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

"preferences": { # Preferences.

1149

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

1150

},

1151

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

1152

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

1153

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

1154

},

1155

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

1156

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

1157

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

1158

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

1159

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

1160

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

1161

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1162

"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-11-16 11:05:03 -0700

[diff] [blame]

1163

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

1164

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

1165

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

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

},

1174

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

1175

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

1176

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

1177

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

1178

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

1179

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

1180

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1181

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

1182

# 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-11-16 11:05:03 -0700

[diff] [blame]

1183

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

1184

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

1185

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

1186

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

1187

},

1188

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

1189

}

Bu Sun Kim

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

[diff] [blame]

1190

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1191

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-11-16 11:05:03 -0700

[diff] [blame]

1192

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

1193

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.

1194

Allowed values

1195

all - Notifications are sent to all guests.

1196

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

1197

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

1198

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

1199

1200

Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.

1201

conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

Bu Sun Kim

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

[diff] [blame]

1202

1203

Returns:

1204

An object of the form:

1205

1206

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1207

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

1208

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1209

"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.

1210

{

1211

"method": "A String", # The method used by this reminder. Possible values are:

1212

# - "email" - Reminders are sent via email.

1213

# - "popup" - Reminders are sent via a UI popup.

1214

# Required when adding a reminder.

1215

"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).

1216

# Required when adding a reminder.

},

],

},

"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.

1221

"description": "A String", # Description of the event. Can contain HTML. Optional.

1222

"summary": "A String", # Title of the event.

1223

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

1224

{

1225

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1226

"displayName": "A String", # The attendee's name, if available. Optional.

1227

"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.

1228

# Required when adding an attendee.

1229

"comment": "A String", # The attendee's response comment. Optional.

1230

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1231

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1232

"responseStatus": "A String", # The attendee's response status. Possible values are:

1233

# - "needsAction" - The attendee has not responded to the invitation.

1234

# - "declined" - The attendee has declined the invitation.

1235

# - "tentative" - The attendee has tentatively accepted the invitation.

1236

# - "accepted" - The attendee has accepted the invitation.

1237

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1238

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1239

"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.

1240

},

1241

],

1242

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1243

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1244

"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.

1245

"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.

1246

},

1247

"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:

1248

# - 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

1249

# - the length of the ID must be between 5 and 1024 characters

1250

# - 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.

1251

# If you do not specify an ID, it will be automatically generated by the server.

1252

# 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.

1253

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1254

# - "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.

1255

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1256

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1257

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1258

# There can be at most 25 attachments per event,

1259

{

1260

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1261

"title": "A String", # Attachment title.

1262

"fileId": "A String", # ID of the attached file. Read-only.

1263

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1264

"fileUrl": "A String", # URL link to the attachment.

1265

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1266

# Required when adding an attachment.

1267

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1268

},

1269

],

1270

"extendedProperties": { # Extended properties of the event.

1271

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1272

"a_key": "A String", # The name of the shared property and the corresponding value.

1273

},

1274

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1275

"a_key": "A String", # The name of the private property and the corresponding value.

1276

},

1277

},

1278

"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.

1279

"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.

1280

"A String",

1281

],

1282

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1283

"sequence": 42, # Sequence number as per iCalendar.

1284

"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.

1285

"displayName": "A String", # The organizer's name, if available.

1286

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1287

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1288

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1289

},

1290

"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.

1291

"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.

1292

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1293

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1294

"type": "A String", # The conference solution type.

1295

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1296

# The possible values are:

1297

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1298

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1299

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1300

# - "addOn" for 3P conference providers

1301

},

1302

"requestId": "A String", # The client-generated unique ID for this request.

1303

# 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.

1304

"status": { # The status of the conference create request.

1305

"statusCode": "A String", # The current status of the conference create request. Read-only.

1306

# The possible values are:

1307

# - "pending": the conference create request is still being processed.

1308

# - "success": the conference create request succeeded, the entry points are populated.

1309

# - "failure": the conference create request failed, there are no entry points.

1310

},

1311

},

1312

"conferenceId": "A String", # The ID of the conference.

1313

# Can be used by developers to keep track of conferences, should not be displayed to users.

1314

# Values for solution types:

1315

# - "eventHangout": unset.

1316

# - "eventNamedHangout": the name of the Hangout.

1317

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1318

# - "addOn": defined by 3P conference provider. Optional.

1319

"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.

1320

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1321

# Unset for a conference with a failed create request.

1322

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1323

"name": "A String", # The user-visible name of this solution. Not localized.

1324

"key": { # The key which can uniquely identify the conference solution for this event.

1325

"type": "A String", # The conference solution type.

1326

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1327

# The possible values are:

1328

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1329

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1330

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1331

# - "addOn" for 3P conference providers

1332

},

1333

"iconUri": "A String", # The user-visible icon for this solution.

1334

},

1335

"signature": "A String", # The signature of the conference data.

1336

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1337

# Unset for a conference with a failed create request.

1338

# Optional for a conference with a pending create request.

1339

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1340

# All of them must belong to the same conference.

1341

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1342

{

1343

"entryPointType": "A String", # The type of the conference entry point.

1344

# Possible values are:

1345

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1346

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1347

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1348

# - "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.

1349

"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.

1350

"A String",

1351

],

1352

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1353

# Examples:

1354

# - for video: meet.google.com/aaa-bbbb-ccc

1355

# - for phone: +1 123 268 2601

1356

# - for sip: 12345678@altostrat.com

1357

# - for more: should not be filled

1358

# Optional.

1359

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1360

# 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.

1361

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1362

# Format:

1363

# - for video, http: or https: schema is required.

1364

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1365

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1366

# - for more, http: or https: schema is required.

1367

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1368

# 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.

1369

# Optional.

1370

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1371

# Calendar backend will populate this field only for EntryPointType.PHONE.

1372

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1373

# 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.

1374

# Optional.

1375

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1376

# 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.

1377

# Optional.

1378

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1379

# 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.

},

],

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1384

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

},

"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.

1392

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1393

"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.

1394

"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.

1395

},

1396

"status": "A String", # Status of the event. Optional. Possible values are:

1397

# - "confirmed" - The event is confirmed. This is the default status.

1398

# - "tentative" - The event is tentatively confirmed.

1399

# - "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.

1400

# A cancelled status represents two different states depending on the event type:

1401

# - 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.

1402

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1403

# - 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.

1404

# 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.

1405

# 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.

1406

"etag": "A String", # ETag of the resource.

1407

"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.

1408

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1409

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1410

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1411

"title": "A String", # The gadget's title. Deprecated.

1412

"type": "A String", # The gadget's type. Deprecated.

1413

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1414

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1415

"preferences": { # Preferences.

1416

"a_key": "A String", # The preference name and corresponding value.

1417

},

1418

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1419

# - "icon" - The gadget displays next to the event's title in the calendar view.

1420

# - "chip" - The gadget displays when the event is clicked.

1421

},

1422

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1423

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1424

# - "public" - The event is public and event details are visible to all readers of the calendar.

1425

# - "private" - The event is private and only event attendees may view event details.

1426

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1427

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1428

"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.

1429

"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.

1430

"location": "A String", # Geographic location of the event as free-form text. Optional.

1431

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1432

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1433

"kind": "calendar#event", # Type of the resource ("calendar#event").

1434

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1435

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1436

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1437

"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.

1438

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1439

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1440

},

1441

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1442

"creator": { # The creator of the event. Read-only.

1443

"email": "A String", # The creator's email address, if available.

1444

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1445

"displayName": "A String", # The creator's name, if available.

1446

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1447

},

1448

"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.

1449

# 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.

1450

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1451

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1452

"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.

1453

"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.

1454

},

1455

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

}</pre>

</div>

<code class="details" id="instances">instances(calendarId, eventId, timeMax=None, maxResults=None, timeZone=None, maxAttendees=None, originalStart=None, pageToken=None, showDeleted=None, alwaysIncludeEmail=None, timeMin=None)</code>

1461

<pre>Returns instances of the specified recurring event.

1462

1463

Args:

1464

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

1465

eventId: string, Recurring event identifier. (required)

1466

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.

1467

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.

1468

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

1469

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.

1470

originalStart: string, The original start time of the instance in the result. Optional.

1471

pageToken: string, Token specifying which result page to return. Optional.

1472

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.

1473

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).

1474

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.

1475

1476

Returns:

1477

An object of the form:

1478

1479

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1480

"timeZone": "A String", # The time zone of the calendar. Read-only.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1481

"kind": "calendar#events", # Type of the collection ("calendar#events").

1482

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

1483

"description": "A String", # Description of the calendar. Read-only.

1484

"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-05-20 12:08:20 -0700

[diff] [blame]

1485

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1486

# - "none" - The user has no access.

1487

# - "freeBusyReader" - The user has read access to free/busy information.

1488

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1489

# - "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.

1490

# - "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-11-16 11:05:03 -0700

[diff] [blame]

1491

"summary": "A String", # Title of the calendar. Read-only.

1492

"items": [ # List of events on the calendar.

1493

{

1494

"reminders": { # Information about the event's reminders for the authenticated user.

1495

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1496

"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.

1497

{

1498

"method": "A String", # The method used by this reminder. Possible values are:

1499

# - "email" - Reminders are sent via email.

1500

# - "popup" - Reminders are sent via a UI popup.

1501

# Required when adding a reminder.

1502

"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).

1503

# Required when adding a reminder.

},

],

},

"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.

1508

"description": "A String", # Description of the event. Can contain HTML. Optional.

1509

"summary": "A String", # Title of the event.

1510

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

1511

{

1512

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1513

"displayName": "A String", # The attendee's name, if available. Optional.

1514

"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.

1515

# Required when adding an attendee.

1516

"comment": "A String", # The attendee's response comment. Optional.

1517

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1518

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1519

"responseStatus": "A String", # The attendee's response status. Possible values are:

1520

# - "needsAction" - The attendee has not responded to the invitation.

1521

# - "declined" - The attendee has declined the invitation.

1522

# - "tentative" - The attendee has tentatively accepted the invitation.

1523

# - "accepted" - The attendee has accepted the invitation.

1524

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1525

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1526

"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.

1527

},

1528

],

1529

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1530

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1531

"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.

1532

"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.

1533

},

1534

"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:

1535

# - 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

1536

# - the length of the ID must be between 5 and 1024 characters

1537

# - 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.

1538

# If you do not specify an ID, it will be automatically generated by the server.

1539

# 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.

1540

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1541

# - "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.

1542

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1543

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1544

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1545

# There can be at most 25 attachments per event,

1546

{

1547

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1548

"title": "A String", # Attachment title.

1549

"fileId": "A String", # ID of the attached file. Read-only.

1550

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1551

"fileUrl": "A String", # URL link to the attachment.

1552

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1553

# Required when adding an attachment.

1554

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1555

},

1556

],

1557

"extendedProperties": { # Extended properties of the event.

1558

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1559

"a_key": "A String", # The name of the shared property and the corresponding value.

1560

},

1561

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1562

"a_key": "A String", # The name of the private property and the corresponding value.

1563

},

1564

},

1565

"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.

1566

"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.

1567

"A String",

1568

],

1569

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1570

"sequence": 42, # Sequence number as per iCalendar.

1571

"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.

1572

"displayName": "A String", # The organizer's name, if available.

1573

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1574

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1575

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1576

},

1577

"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.

1578

"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.

1579

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1580

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1581

"type": "A String", # The conference solution type.

1582

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1583

# The possible values are:

1584

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1585

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1586

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1587

# - "addOn" for 3P conference providers

1588

},

1589

"requestId": "A String", # The client-generated unique ID for this request.

1590

# 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.

1591

"status": { # The status of the conference create request.

1592

"statusCode": "A String", # The current status of the conference create request. Read-only.

1593

# The possible values are:

1594

# - "pending": the conference create request is still being processed.

1595

# - "success": the conference create request succeeded, the entry points are populated.

1596

# - "failure": the conference create request failed, there are no entry points.

1597

},

1598

},

1599

"conferenceId": "A String", # The ID of the conference.

1600

# Can be used by developers to keep track of conferences, should not be displayed to users.

1601

# Values for solution types:

1602

# - "eventHangout": unset.

1603

# - "eventNamedHangout": the name of the Hangout.

1604

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1605

# - "addOn": defined by 3P conference provider. Optional.

1606

"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.

1607

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1608

# Unset for a conference with a failed create request.

1609

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1610

"name": "A String", # The user-visible name of this solution. Not localized.

1611

"key": { # The key which can uniquely identify the conference solution for this event.

1612

"type": "A String", # The conference solution type.

1613

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1614

# The possible values are:

1615

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1616

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1617

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1618

# - "addOn" for 3P conference providers

1619

},

1620

"iconUri": "A String", # The user-visible icon for this solution.

1621

},

1622

"signature": "A String", # The signature of the conference data.

1623

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1624

# Unset for a conference with a failed create request.

1625

# Optional for a conference with a pending create request.

1626

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1627

# All of them must belong to the same conference.

1628

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1629

{

1630

"entryPointType": "A String", # The type of the conference entry point.

1631

# Possible values are:

1632

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1633

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1634

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1635

# - "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.

1636

"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.

1637

"A String",

1638

],

1639

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1640

# Examples:

1641

# - for video: meet.google.com/aaa-bbbb-ccc

1642

# - for phone: +1 123 268 2601

1643

# - for sip: 12345678@altostrat.com

1644

# - for more: should not be filled

1645

# Optional.

1646

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1647

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1648

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1649

# Format:

1650

# - for video, http: or https: schema is required.

1651

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1652

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1653

# - for more, http: or https: schema is required.

1654

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1655

# 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.

1656

# Optional.

1657

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1658

# Calendar backend will populate this field only for EntryPointType.PHONE.

1659

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1660

# 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.

1661

# Optional.

1662

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1663

# 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.

1664

# Optional.

1665

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1666

# 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.

},

],

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1671

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

},

"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.

1679

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1680

"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.

1681

"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.

1682

},

1683

"status": "A String", # Status of the event. Optional. Possible values are:

1684

# - "confirmed" - The event is confirmed. This is the default status.

1685

# - "tentative" - The event is tentatively confirmed.

1686

# - "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.

1687

# A cancelled status represents two different states depending on the event type:

1688

# - 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.

1689

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1690

# - 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.

1691

# 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.

1692

# 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.

1693

"etag": "A String", # ETag of the resource.

1694

"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.

1695

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1696

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1697

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1698

"title": "A String", # The gadget's title. Deprecated.

1699

"type": "A String", # The gadget's type. Deprecated.

1700

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1701

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1702

"preferences": { # Preferences.

1703

"a_key": "A String", # The preference name and corresponding value.

1704

},

1705

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1706

# - "icon" - The gadget displays next to the event's title in the calendar view.

1707

# - "chip" - The gadget displays when the event is clicked.

1708

},

1709

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1710

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1711

# - "public" - The event is public and event details are visible to all readers of the calendar.

1712

# - "private" - The event is private and only event attendees may view event details.

1713

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1714

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1715

"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.

1716

"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.

1717

"location": "A String", # Geographic location of the event as free-form text. Optional.

1718

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1719

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1720

"kind": "calendar#event", # Type of the resource ("calendar#event").

1721

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1722

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1723

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1724

"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.

1725

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1726

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1727

},

1728

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1729

"creator": { # The creator of the event. Read-only.

1730

"email": "A String", # The creator's email address, if available.

1731

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1732

"displayName": "A String", # The creator's name, if available.

1733

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1734

},

1735

"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.

1736

# 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.

1737

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1738

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1739

"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.

1740

"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.

1741

},

1742

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1743

},

1744

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1745

"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]

1746

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1747

"method": "A String", # The method used by this reminder. Possible values are:

1748

# - "email" - Reminders are sent via email.

1749

# - "popup" - Reminders are sent via a UI popup.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1750

# Required when adding a reminder.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1751

"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]

1752

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1753

},

1754

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1755

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1756

"etag": "A String", # ETag of the collection.

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>

1762

<pre>Retrieves the next page of results.

1763

1764

Args:

1765

previous_request: The request for the previous page. (required)

1766

previous_response: The response from the request for the previous page. (required)

1767

1768

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1769

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1770

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1775

<code class="details" id="list">list(calendarId, privateExtendedProperty=None, updatedMin=None, showDeleted=None, timeZone=None, q=None, timeMin=None, orderBy=None, maxResults=None, sharedExtendedProperty=None, pageToken=None, maxAttendees=None, showHiddenInvitations=None, iCalUID=None, syncToken=None, timeMax=None, singleEvents=None, alwaysIncludeEmail=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1776

<pre>Returns events on the specified calendar.

1777

1778

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1779

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1780

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)

1781

updatedMin: string, Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1782

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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1783

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1784

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1785

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]

1786

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

1787

Allowed values

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

1788

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]

1789

updated - Order by last modification time (ascending).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1790

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1791

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)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1792

pageToken: string, Token specifying which result page to return. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1793

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.

1794

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

1795

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

1796

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.

1797

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

1803

- q

1804

- sharedExtendedProperty

1805

- timeMin

1806

- timeMax

1807

- 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.

1808

Learn more about incremental synchronization.

1809

Optional. The default is to return all entries.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1810

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.

1811

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.

1812

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1813

1814

Returns:

1815

An object of the form:

1816

1817

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1818

"timeZone": "A String", # The time zone of the calendar. Read-only.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1819

"kind": "calendar#events", # Type of the collection ("calendar#events").

1820

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

1821

"description": "A String", # Description of the calendar. Read-only.

1822

"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-05-20 12:08:20 -0700

[diff] [blame]

1823

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1824

# - "none" - The user has no access.

1825

# - "freeBusyReader" - The user has read access to free/busy information.

1826

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1827

# - "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.

1828

# - "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-11-16 11:05:03 -0700

[diff] [blame]

1829

"summary": "A String", # Title of the calendar. Read-only.

1830

"items": [ # List of events on the calendar.

1831

{

1832

"reminders": { # Information about the event's reminders for the authenticated user.

1833

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1834

"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.

1835

{

1836

"method": "A String", # The method used by this reminder. Possible values are:

1837

# - "email" - Reminders are sent via email.

1838

# - "popup" - Reminders are sent via a UI popup.

1839

# Required when adding a reminder.

1840

"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).

1841

# Required when adding a reminder.

},

],

},

"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.

1846

"description": "A String", # Description of the event. Can contain HTML. Optional.

1847

"summary": "A String", # Title of the event.

1848

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

1849

{

1850

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1851

"displayName": "A String", # The attendee's name, if available. Optional.

1852

"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.

1853

# Required when adding an attendee.

1854

"comment": "A String", # The attendee's response comment. Optional.

1855

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1856

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1857

"responseStatus": "A String", # The attendee's response status. Possible values are:

1858

# - "needsAction" - The attendee has not responded to the invitation.

1859

# - "declined" - The attendee has declined the invitation.

1860

# - "tentative" - The attendee has tentatively accepted the invitation.

1861

# - "accepted" - The attendee has accepted the invitation.

1862

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1863

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1864

"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.

1865

},

1866

],

1867

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1868

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1869

"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.

1870

"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.

1871

},

1872

"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:

1873

# - 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

1874

# - the length of the ID must be between 5 and 1024 characters

1875

# - 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.

1876

# If you do not specify an ID, it will be automatically generated by the server.

1877

# 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.

1878

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1879

# - "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.

1880

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1881

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1882

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1883

# There can be at most 25 attachments per event,

1884

{

1885

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1886

"title": "A String", # Attachment title.

1887

"fileId": "A String", # ID of the attached file. Read-only.

1888

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1889

"fileUrl": "A String", # URL link to the attachment.

1890

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1891

# Required when adding an attachment.

1892

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1893

},

1894

],

1895

"extendedProperties": { # Extended properties of the event.

1896

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1897

"a_key": "A String", # The name of the shared property and the corresponding value.

1898

},

1899

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1900

"a_key": "A String", # The name of the private property and the corresponding value.

1901

},

1902

},

1903

"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.

1904

"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.

1905

"A String",

1906

],

1907

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1908

"sequence": 42, # Sequence number as per iCalendar.

1909

"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.

1910

"displayName": "A String", # The organizer's name, if available.

1911

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1912

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1913

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1914

},

1915

"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.

1916

"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.

1917

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1918

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1919

"type": "A String", # The conference solution type.

1920

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1921

# The possible values are:

1922

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1923

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1924

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1925

# - "addOn" for 3P conference providers

1926

},

1927

"requestId": "A String", # The client-generated unique ID for this request.

1928

# 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.

1929

"status": { # The status of the conference create request.

1930

"statusCode": "A String", # The current status of the conference create request. Read-only.

1931

# The possible values are:

1932

# - "pending": the conference create request is still being processed.

1933

# - "success": the conference create request succeeded, the entry points are populated.

1934

# - "failure": the conference create request failed, there are no entry points.

1935

},

1936

},

1937

"conferenceId": "A String", # The ID of the conference.

1938

# Can be used by developers to keep track of conferences, should not be displayed to users.

1939

# Values for solution types:

1940

# - "eventHangout": unset.

1941

# - "eventNamedHangout": the name of the Hangout.

1942

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1943

# - "addOn": defined by 3P conference provider. Optional.

1944

"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.

1945

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1946

# Unset for a conference with a failed create request.

1947

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1948

"name": "A String", # The user-visible name of this solution. Not localized.

1949

"key": { # The key which can uniquely identify the conference solution for this event.

1950

"type": "A String", # The conference solution type.

1951

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1952

# The possible values are:

1953

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1954

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1955

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1956

# - "addOn" for 3P conference providers

1957

},

1958

"iconUri": "A String", # The user-visible icon for this solution.

1959

},

1960

"signature": "A String", # The signature of the conference data.

1961

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1962

# Unset for a conference with a failed create request.

1963

# Optional for a conference with a pending create request.

1964

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1965

# All of them must belong to the same conference.

1966

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1967

{

1968

"entryPointType": "A String", # The type of the conference entry point.

1969

# Possible values are:

1970

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1971

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1972

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1973

# - "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.

1974

"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.

1975

"A String",

1976

],

1977

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1978

# Examples:

1979

# - for video: meet.google.com/aaa-bbbb-ccc

1980

# - for phone: +1 123 268 2601

1981

# - for sip: 12345678@altostrat.com

1982

# - for more: should not be filled

1983

# Optional.

1984

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1985

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1986

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1987

# Format:

1988

# - for video, http: or https: schema is required.

1989

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1990

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1991

# - for more, http: or https: schema is required.

1992

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1993

# 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.

1994

# Optional.

1995

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1996

# Calendar backend will populate this field only for EntryPointType.PHONE.

1997

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1998

# 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.

1999

# Optional.

2000

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2001

# 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.

2002

# Optional.

2003

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2004

# 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.

},

],

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2009

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

},

"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.

2017

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2018

"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.

2019

"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.

2020

},

2021

"status": "A String", # Status of the event. Optional. Possible values are:

2022

# - "confirmed" - The event is confirmed. This is the default status.

2023

# - "tentative" - The event is tentatively confirmed.

2024

# - "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.

2025

# A cancelled status represents two different states depending on the event type:

2026

# - 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.

2027

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2028

# - 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.

2029

# 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.

2030

# 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.

2031

"etag": "A String", # ETag of the resource.

2032

"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.

2033

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2034

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2035

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2036

"title": "A String", # The gadget's title. Deprecated.

2037

"type": "A String", # The gadget's type. Deprecated.

2038

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2039

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2040

"preferences": { # Preferences.

2041

"a_key": "A String", # The preference name and corresponding value.

2042

},

2043

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2044

# - "icon" - The gadget displays next to the event's title in the calendar view.

2045

# - "chip" - The gadget displays when the event is clicked.

2046

},

2047

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2048

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2049

# - "public" - The event is public and event details are visible to all readers of the calendar.

2050

# - "private" - The event is private and only event attendees may view event details.

2051

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2052

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2053

"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.

2054

"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.

2055

"location": "A String", # Geographic location of the event as free-form text. Optional.

2056

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2057

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2058

"kind": "calendar#event", # Type of the resource ("calendar#event").

2059

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2060

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2061

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2062

"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.

2063

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2064

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2065

},

2066

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2067

"creator": { # The creator of the event. Read-only.

2068

"email": "A String", # The creator's email address, if available.

2069

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2070

"displayName": "A String", # The creator's name, if available.

2071

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2072

},

2073

"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.

2074

# 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.

2075

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2076

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2077

"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.

2078

"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.

2079

},

2080

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2081

},

2082

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2083

"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]

2084

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2085

"method": "A String", # The method used by this reminder. Possible values are:

2086

# - "email" - Reminders are sent via email.

2087

# - "popup" - Reminders are sent via a UI popup.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2088

# Required when adding a reminder.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2089

"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]

2090

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2091

},

2092

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2093

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2094

"etag": "A String", # ETag of the collection.

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>

2100

<pre>Retrieves the next page of results.

2101

2102

Args:

2103

previous_request: The request for the previous page. (required)

2104

previous_response: The response from the request for the previous page. (required)

2105

2106

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2107

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2108

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2113

<code class="details" id="move">move(calendarId, eventId, destination, sendUpdates=None, sendNotifications=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2114

<pre>Moves an event to another calendar, i.e. changes an event's organizer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2115

2116

Args:

2117

calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)

2118

eventId: string, Event identifier. (required)

2119

destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2120

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]

2121

Allowed values

2122

all - Notifications are sent to all guests.

2123

externalOnly - Notifications are sent to non-Google Calendar guests only.

2124

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).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2125

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2126

2127

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2128

2129

Returns:

2130

An object of the form:

2131

2132

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2133

"reminders": { # Information about the event's reminders for the authenticated user.

2134

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2135

"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.

2136

{

2137

"method": "A String", # The method used by this reminder. Possible values are:

2138

# - "email" - Reminders are sent via email.

2139

# - "popup" - Reminders are sent via a UI popup.

2140

# Required when adding a reminder.

2141

"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).

2142

# Required when adding a reminder.

2143

},

2144

],

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

2145

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2146

"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.

2147

"description": "A String", # Description of the event. Can contain HTML. Optional.

2148

"summary": "A String", # Title of the event.

2149

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

2150

{

2151

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2152

"displayName": "A String", # The attendee's name, if available. Optional.

2153

"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.

2154

# Required when adding an attendee.

2155

"comment": "A String", # The attendee's response comment. Optional.

2156

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2157

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2158

"responseStatus": "A String", # The attendee's response status. Possible values are:

2159

# - "needsAction" - The attendee has not responded to the invitation.

2160

# - "declined" - The attendee has declined the invitation.

2161

# - "tentative" - The attendee has tentatively accepted the invitation.

2162

# - "accepted" - The attendee has accepted the invitation.

2163

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2164

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2165

"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.

2166

},

2167

],

2168

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2169

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2170

"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.

2171

"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]

2172

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2173

"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:

2174

# - 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

2175

# - the length of the ID must be between 5 and 1024 characters

2176

# - 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.

2177

# If you do not specify an ID, it will be automatically generated by the server.

2178

# 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.

2179

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2180

# - "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.

2181

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2182

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2183

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2184

# There can be at most 25 attachments per event,

2185

{

2186

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2187

"title": "A String", # Attachment title.

2188

"fileId": "A String", # ID of the attached file. Read-only.

2189

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2190

"fileUrl": "A String", # URL link to the attachment.

2191

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2192

# Required when adding an attachment.

2193

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2194

},

2195

],

2196

"extendedProperties": { # Extended properties of the event.

2197

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2198

"a_key": "A String", # The name of the shared property and the corresponding value.

2199

},

2200

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2201

"a_key": "A String", # The name of the private property and the corresponding value.

2202

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2203

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2204

"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.

2205

"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.

2206

"A String",

2207

],

2208

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2209

"sequence": 42, # Sequence number as per iCalendar.

2210

"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.

2211

"displayName": "A String", # The organizer's name, if available.

2212

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2213

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2214

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2215

},

2216

"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.

2217

"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.

2218

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2219

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2220

"type": "A String", # The conference solution type.

2221

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2222

# The possible values are:

2223

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2224

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2225

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2226

# - "addOn" for 3P conference providers

2227

},

2228

"requestId": "A String", # The client-generated unique ID for this request.

2229

# 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.

2230

"status": { # The status of the conference create request.

2231

"statusCode": "A String", # The current status of the conference create request. Read-only.

2232

# The possible values are:

2233

# - "pending": the conference create request is still being processed.

2234

# - "success": the conference create request succeeded, the entry points are populated.

2235

# - "failure": the conference create request failed, there are no entry points.

2236

},

2237

},

2238

"conferenceId": "A String", # The ID of the conference.

2239

# Can be used by developers to keep track of conferences, should not be displayed to users.

2240

# Values for solution types:

2241

# - "eventHangout": unset.

2242

# - "eventNamedHangout": the name of the Hangout.

2243

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2244

# - "addOn": defined by 3P conference provider. Optional.

2245

"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.

2246

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2247

# Unset for a conference with a failed create request.

2248

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2249

"name": "A String", # The user-visible name of this solution. Not localized.

2250

"key": { # The key which can uniquely identify the conference solution for this event.

2251

"type": "A String", # The conference solution type.

2252

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2253

# The possible values are:

2254

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2255

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2256

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2257

# - "addOn" for 3P conference providers

2258

},

2259

"iconUri": "A String", # The user-visible icon for this solution.

2260

},

2261

"signature": "A String", # The signature of the conference data.

2262

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2263

# Unset for a conference with a failed create request.

2264

# Optional for a conference with a pending create request.

2265

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2266

# All of them must belong to the same conference.

2267

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2268

{

2269

"entryPointType": "A String", # The type of the conference entry point.

2270

# Possible values are:

2271

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2272

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2273

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2274

# - "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.

2275

"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.

2276

"A String",

2277

],

2278

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2279

# Examples:

2280

# - for video: meet.google.com/aaa-bbbb-ccc

2281

# - for phone: +1 123 268 2601

2282

# - for sip: 12345678@altostrat.com

2283

# - for more: should not be filled

2284

# Optional.

2285

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2286

# 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.

2287

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2288

# Format:

2289

# - for video, http: or https: schema is required.

2290

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2291

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2292

# - for more, http: or https: schema is required.

2293

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2294

# 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.

2295

# Optional.

2296

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2297

# Calendar backend will populate this field only for EntryPointType.PHONE.

2298

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2299

# 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.

2300

# Optional.

2301

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2302

# 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.

2303

# Optional.

2304

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2305

# 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.

},

],

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2310

"addOnParameters": { # Additional add-on specific data.

2311

"parameters": {

2312

"a_key": "A String",

2313

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2314

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2315

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2316

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2317

"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.

2318

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2319

"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.

2320

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2321

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2322

"status": "A String", # Status of the event. Optional. Possible values are:

2323

# - "confirmed" - The event is confirmed. This is the default status.

2324

# - "tentative" - The event is tentatively confirmed.

2325

# - "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.

2326

# A cancelled status represents two different states depending on the event type:

2327

# - 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.

2328

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2329

# - 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.

2330

# 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.

2331

# 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.

2332

"etag": "A String", # ETag of the resource.

2333

"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.

2334

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2335

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2336

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2337

"title": "A String", # The gadget's title. Deprecated.

2338

"type": "A String", # The gadget's type. Deprecated.

2339

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2340

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2341

"preferences": { # Preferences.

2342

"a_key": "A String", # The preference name and corresponding value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2343

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2344

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2345

# - "icon" - The gadget displays next to the event's title in the calendar view.

2346

# - "chip" - The gadget displays when the event is clicked.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2347

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2348

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2349

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2350

# - "public" - The event is public and event details are visible to all readers of the calendar.

2351

# - "private" - The event is private and only event attendees may view event details.

2352

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2353

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2354

"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.

2355

"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.

2356

"location": "A String", # Geographic location of the event as free-form text. Optional.

2357

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2358

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2359

"kind": "calendar#event", # Type of the resource ("calendar#event").

2360

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2361

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2362

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2363

"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.

2364

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2365

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2366

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2367

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2368

"creator": { # The creator of the event. Read-only.

2369

"email": "A String", # The creator's email address, if available.

2370

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2371

"displayName": "A String", # The creator's name, if available.

2372

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2373

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2374

"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.

2375

# 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.

2376

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2377

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2378

"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.

2379

"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.

2380

},

2381

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2382

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2383

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2384

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2385

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2386

<code class="details" id="patch">patch(calendarId, eventId, body=None, supportsAttachments=None, conferenceDataVersion=None, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None, sendUpdates=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2387

<pre>Updates an event. This method supports patch semantics.

2388

2389

Args:

2390

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

2391

eventId: string, Event identifier. (required)

2392

body: object, The request body.

2393

The object takes the form of:

2394

2395

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2396

"reminders": { # Information about the event's reminders for the authenticated user.

2397

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2398

"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.

2399

{

2400

"method": "A String", # The method used by this reminder. Possible values are:

2401

# - "email" - Reminders are sent via email.

2402

# - "popup" - Reminders are sent via a UI popup.

2403

# Required when adding a reminder.

2404

"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).

2405

# Required when adding a reminder.

2406

},

2407

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2408

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2409

"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.

2410

"description": "A String", # Description of the event. Can contain HTML. Optional.

2411

"summary": "A String", # Title of the event.

2412

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

2413

{

2414

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2415

"displayName": "A String", # The attendee's name, if available. Optional.

2416

"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.

2417

# Required when adding an attendee.

2418

"comment": "A String", # The attendee's response comment. Optional.

2419

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2420

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2421

"responseStatus": "A String", # The attendee's response status. Possible values are:

2422

# - "needsAction" - The attendee has not responded to the invitation.

2423

# - "declined" - The attendee has declined the invitation.

2424

# - "tentative" - The attendee has tentatively accepted the invitation.

2425

# - "accepted" - The attendee has accepted the invitation.

2426

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2427

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2428

"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.

2429

},

2430

],

2431

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2432

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2433

"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-07-22 17:02:09 -0700

[diff] [blame]

2434

"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.

2435

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2436

"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:

2437

# - 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

2438

# - the length of the ID must be between 5 and 1024 characters

2439

# - 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.

2440

# If you do not specify an ID, it will be automatically generated by the server.

2441

# 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.

2442

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2443

# - "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.

2444

# - "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]

2445

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2446

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2447

# There can be at most 25 attachments per event,

2448

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2449

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2450

"title": "A String", # Attachment title.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2451

"fileId": "A String", # ID of the attached file. Read-only.

2452

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2453

"fileUrl": "A String", # URL link to the attachment.

2454

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2455

# Required when adding an attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2456

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2457

},

2458

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2459

"extendedProperties": { # Extended properties of the event.

2460

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2461

"a_key": "A String", # The name of the shared property and the corresponding value.

2462

},

2463

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2464

"a_key": "A String", # The name of the private property and the corresponding value.

2465

},

2466

},

2467

"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.

2468

"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.

2469

"A String",

2470

],

2471

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2472

"sequence": 42, # Sequence number as per iCalendar.

2473

"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.

2474

"displayName": "A String", # The organizer's name, if available.

2475

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2476

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2477

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2478

},

2479

"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.

2480

"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.

2481

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2482

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2483

"type": "A String", # The conference solution type.

2484

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2485

# The possible values are:

2486

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2487

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2488

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2489

# - "addOn" for 3P conference providers

2490

},

2491

"requestId": "A String", # The client-generated unique ID for this request.

2492

# 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.

2493

"status": { # The status of the conference create request.

2494

"statusCode": "A String", # The current status of the conference create request. Read-only.

2495

# The possible values are:

2496

# - "pending": the conference create request is still being processed.

2497

# - "success": the conference create request succeeded, the entry points are populated.

2498

# - "failure": the conference create request failed, there are no entry points.

2499

},

2500

},

2501

"conferenceId": "A String", # The ID of the conference.

2502

# Can be used by developers to keep track of conferences, should not be displayed to users.

2503

# Values for solution types:

2504

# - "eventHangout": unset.

2505

# - "eventNamedHangout": the name of the Hangout.

2506

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2507

# - "addOn": defined by 3P conference provider. Optional.

2508

"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.

2509

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2510

# Unset for a conference with a failed create request.

2511

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2512

"name": "A String", # The user-visible name of this solution. Not localized.

2513

"key": { # The key which can uniquely identify the conference solution for this event.

2514

"type": "A String", # The conference solution type.

2515

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2516

# The possible values are:

2517

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2518

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2519

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2520

# - "addOn" for 3P conference providers

2521

},

2522

"iconUri": "A String", # The user-visible icon for this solution.

2523

},

2524

"signature": "A String", # The signature of the conference data.

2525

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2526

# Unset for a conference with a failed create request.

2527

# Optional for a conference with a pending create request.

2528

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2529

# All of them must belong to the same conference.

2530

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2531

{

2532

"entryPointType": "A String", # The type of the conference entry point.

2533

# Possible values are:

2534

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2535

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2536

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2537

# - "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.

2538

"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.

2539

"A String",

2540

],

2541

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2542

# Examples:

2543

# - for video: meet.google.com/aaa-bbbb-ccc

2544

# - for phone: +1 123 268 2601

2545

# - for sip: 12345678@altostrat.com

2546

# - for more: should not be filled

2547

# Optional.

2548

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2549

# 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.

2550

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2551

# Format:

2552

# - for video, http: or https: schema is required.

2553

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2554

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2555

# - for more, http: or https: schema is required.

2556

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2557

# 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.

2558

# Optional.

2559

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2560

# Calendar backend will populate this field only for EntryPointType.PHONE.

2561

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2562

# 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.

2563

# Optional.

2564

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2565

# 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.

2566

# Optional.

2567

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2568

# 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.

},

],

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2573

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

},

"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.

2581

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2582

"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.

2583

"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.

2584

},

2585

"status": "A String", # Status of the event. Optional. Possible values are:

2586

# - "confirmed" - The event is confirmed. This is the default status.

2587

# - "tentative" - The event is tentatively confirmed.

2588

# - "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.

2589

# A cancelled status represents two different states depending on the event type:

2590

# - 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.

2591

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2592

# - 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.

2593

# 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.

2594

# 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.

2595

"etag": "A String", # ETag of the resource.

2596

"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.

2597

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2598

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2599

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2600

"title": "A String", # The gadget's title. Deprecated.

2601

"type": "A String", # The gadget's type. Deprecated.

2602

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2603

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2604

"preferences": { # Preferences.

2605

"a_key": "A String", # The preference name and corresponding value.

2606

},

2607

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2608

# - "icon" - The gadget displays next to the event's title in the calendar view.

2609

# - "chip" - The gadget displays when the event is clicked.

2610

},

2611

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2612

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2613

# - "public" - The event is public and event details are visible to all readers of the calendar.

2614

# - "private" - The event is private and only event attendees may view event details.

2615

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2616

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2617

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2618

"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-11-16 11:05:03 -0700

[diff] [blame]

2619

"location": "A String", # Geographic location of the event as free-form text. Optional.

2620

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2621

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2622

"kind": "calendar#event", # Type of the resource ("calendar#event").

2623

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2624

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2625

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2626

"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.

2627

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2628

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2629

},

2630

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2631

"creator": { # The creator of the event. Read-only.

2632

"email": "A String", # The creator's email address, if available.

2633

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2634

"displayName": "A String", # The creator's name, if available.

2635

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2636

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2637

"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.

2638

# 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-11-16 11:05:03 -0700

[diff] [blame]

2639

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2640

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2641

"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.

2642

"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.

2643

},

2644

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2645

}

2646

2647

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

2648

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.

2649

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2650

2651

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.

2652

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).

2653

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.

2654

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

2655

Allowed values

2656

all - Notifications are sent to all guests.

2657

externalOnly - Notifications are sent to non-Google Calendar guests only.

2658

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).

2659

2660

Returns:

2661

An object of the form:

2662

2663

{

2664

"reminders": { # Information about the event's reminders for the authenticated user.

2665

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2666

"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.

2667

{

2668

"method": "A String", # The method used by this reminder. Possible values are:

2669

# - "email" - Reminders are sent via email.

2670

# - "popup" - Reminders are sent via a UI popup.

2671

# Required when adding a reminder.

2672

"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).

2673

# Required when adding a reminder.

2674

},

2675

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2676

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2677

"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.

2678

"description": "A String", # Description of the event. Can contain HTML. Optional.

2679

"summary": "A String", # Title of the event.

2680

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

2681

{

2682

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2683

"displayName": "A String", # The attendee's name, if available. Optional.

2684

"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.

2685

# Required when adding an attendee.

2686

"comment": "A String", # The attendee's response comment. Optional.

2687

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2688

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2689

"responseStatus": "A String", # The attendee's response status. Possible values are:

2690

# - "needsAction" - The attendee has not responded to the invitation.

2691

# - "declined" - The attendee has declined the invitation.

2692

# - "tentative" - The attendee has tentatively accepted the invitation.

2693

# - "accepted" - The attendee has accepted the invitation.

2694

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2695

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2696

"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.

2697

},

2698

],

2699

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2700

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2701

"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.

2702

"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.

2703

},

2704

"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:

2705

# - 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

2706

# - the length of the ID must be between 5 and 1024 characters

2707

# - 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.

2708

# If you do not specify an ID, it will be automatically generated by the server.

2709

# 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.

2710

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2711

# - "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.

2712

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2713

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2714

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2715

# There can be at most 25 attachments per event,

2716

{

2717

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2718

"title": "A String", # Attachment title.

2719

"fileId": "A String", # ID of the attached file. Read-only.

2720

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2721

"fileUrl": "A String", # URL link to the attachment.

2722

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2723

# Required when adding an attachment.

2724

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2725

},

2726

],

2727

"extendedProperties": { # Extended properties of the event.

2728

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2729

"a_key": "A String", # The name of the shared property and the corresponding value.

2730

},

2731

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2732

"a_key": "A String", # The name of the private property and the corresponding value.

2733

},

2734

},

2735

"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.

2736

"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.

2737

"A String",

2738

],

2739

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2740

"sequence": 42, # Sequence number as per iCalendar.

2741

"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.

2742

"displayName": "A String", # The organizer's name, if available.

2743

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2744

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2745

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2746

},

2747

"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.

2748

"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.

2749

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2750

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2751

"type": "A String", # The conference solution type.

2752

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2753

# The possible values are:

2754

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2755

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2756

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2757

# - "addOn" for 3P conference providers

2758

},

2759

"requestId": "A String", # The client-generated unique ID for this request.

2760

# 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.

2761

"status": { # The status of the conference create request.

2762

"statusCode": "A String", # The current status of the conference create request. Read-only.

2763

# The possible values are:

2764

# - "pending": the conference create request is still being processed.

2765

# - "success": the conference create request succeeded, the entry points are populated.

2766

# - "failure": the conference create request failed, there are no entry points.

2767

},

2768

},

2769

"conferenceId": "A String", # The ID of the conference.

2770

# Can be used by developers to keep track of conferences, should not be displayed to users.

2771

# Values for solution types:

2772

# - "eventHangout": unset.

2773

# - "eventNamedHangout": the name of the Hangout.

2774

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2775

# - "addOn": defined by 3P conference provider. Optional.

2776

"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.

2777

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2778

# Unset for a conference with a failed create request.

2779

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2780

"name": "A String", # The user-visible name of this solution. Not localized.

2781

"key": { # The key which can uniquely identify the conference solution for this event.

2782

"type": "A String", # The conference solution type.

2783

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2784

# The possible values are:

2785

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2786

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2787

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2788

# - "addOn" for 3P conference providers

2789

},

2790

"iconUri": "A String", # The user-visible icon for this solution.

2791

},

2792

"signature": "A String", # The signature of the conference data.

2793

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2794

# Unset for a conference with a failed create request.

2795

# Optional for a conference with a pending create request.

2796

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2797

# All of them must belong to the same conference.

2798

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2799

{

2800

"entryPointType": "A String", # The type of the conference entry point.

2801

# Possible values are:

2802

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2803

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2804

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2805

# - "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.

2806

"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.

2807

"A String",

2808

],

2809

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2810

# Examples:

2811

# - for video: meet.google.com/aaa-bbbb-ccc

2812

# - for phone: +1 123 268 2601

2813

# - for sip: 12345678@altostrat.com

2814

# - for more: should not be filled

2815

# Optional.

2816

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2817

# 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.

2818

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2819

# Format:

2820

# - for video, http: or https: schema is required.

2821

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2822

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2823

# - for more, http: or https: schema is required.

2824

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2825

# 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.

2826

# Optional.

2827

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2828

# Calendar backend will populate this field only for EntryPointType.PHONE.

2829

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2830

# 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.

2831

# Optional.

2832

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2833

# 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.

2834

# Optional.

2835

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2836

# 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.

},

],

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2841

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

},

"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.

2849

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2850

"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.

2851

"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.

2852

},

2853

"status": "A String", # Status of the event. Optional. Possible values are:

2854

# - "confirmed" - The event is confirmed. This is the default status.

2855

# - "tentative" - The event is tentatively confirmed.

2856

# - "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.

2857

# A cancelled status represents two different states depending on the event type:

2858

# - 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.

2859

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2860

# - 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.

2861

# 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.

2862

# 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.

2863

"etag": "A String", # ETag of the resource.

2864

"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.

2865

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2866

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2867

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2868

"title": "A String", # The gadget's title. Deprecated.

2869

"type": "A String", # The gadget's type. Deprecated.

2870

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2871

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2872

"preferences": { # Preferences.

2873

"a_key": "A String", # The preference name and corresponding value.

2874

},

2875

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2876

# - "icon" - The gadget displays next to the event's title in the calendar view.

2877

# - "chip" - The gadget displays when the event is clicked.

2878

},

2879

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2880

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2881

# - "public" - The event is public and event details are visible to all readers of the calendar.

2882

# - "private" - The event is private and only event attendees may view event details.

2883

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2884

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2885

"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.

2886

"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.

2887

"location": "A String", # Geographic location of the event as free-form text. Optional.

2888

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2889

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2890

"kind": "calendar#event", # Type of the resource ("calendar#event").

2891

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2892

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2893

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2894

"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.

2895

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2896

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2897

},

2898

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2899

"creator": { # The creator of the event. Read-only.

2900

"email": "A String", # The creator's email address, if available.

2901

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2902

"displayName": "A String", # The creator's name, if available.

2903

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2904

},

2905

"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.

2906

# 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.

2907

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2908

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2909

"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.

2910

"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.

2911

},

2912

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2913

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None, sendUpdates=None)</code>

2918

<pre>Creates an event based on a simple text string.

2919

2920

Args:

2921

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

2922

text: string, The text describing the event to be created. (required)

2923

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2924

2925

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.

2926

sendUpdates: string, Guests who should receive notifications about the creation of the new event.

2927

Allowed values

2928

all - Notifications are sent to all guests.

2929

externalOnly - Notifications are sent to non-Google Calendar guests only.

2930

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).

2931

2932

Returns:

2933

An object of the form:

2934

2935

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2936

"reminders": { # Information about the event's reminders for the authenticated user.

2937

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2938

"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.

2939

{

2940

"method": "A String", # The method used by this reminder. Possible values are:

2941

# - "email" - Reminders are sent via email.

2942

# - "popup" - Reminders are sent via a UI popup.

2943

# Required when adding a reminder.

2944

"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).

2945

# Required when adding a reminder.

2946

},

2947

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2948

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2949

"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.

2950

"description": "A String", # Description of the event. Can contain HTML. Optional.

2951

"summary": "A String", # Title of the event.

2952

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

2953

{

2954

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2955

"displayName": "A String", # The attendee's name, if available. Optional.

2956

"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.

2957

# Required when adding an attendee.

2958

"comment": "A String", # The attendee's response comment. Optional.

2959

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2960

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2961

"responseStatus": "A String", # The attendee's response status. Possible values are:

2962

# - "needsAction" - The attendee has not responded to the invitation.

2963

# - "declined" - The attendee has declined the invitation.

2964

# - "tentative" - The attendee has tentatively accepted the invitation.

2965

# - "accepted" - The attendee has accepted the invitation.

2966

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2967

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2968

"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.

2969

},

2970

],

2971

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2972

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2973

"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.

2974

"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-07-22 17:02:09 -0700

[diff] [blame]

2975

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2976

"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:

2977

# - 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

2978

# - the length of the ID must be between 5 and 1024 characters

2979

# - 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.

2980

# If you do not specify an ID, it will be automatically generated by the server.

2981

# 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.

2982

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2983

# - "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.

2984

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2985

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2986

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2987

# There can be at most 25 attachments per event,

2988

{

2989

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2990

"title": "A String", # Attachment title.

2991

"fileId": "A String", # ID of the attached file. Read-only.

2992

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2993

"fileUrl": "A String", # URL link to the attachment.

2994

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2995

# Required when adding an attachment.

2996

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2997

},

2998

],

2999

"extendedProperties": { # Extended properties of the event.

3000

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3001

"a_key": "A String", # The name of the shared property and the corresponding value.

3002

},

3003

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3004

"a_key": "A String", # The name of the private property and the corresponding value.

3005

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3006

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3007

"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.

3008

"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.

3009

"A String",

3010

],

3011

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3012

"sequence": 42, # Sequence number as per iCalendar.

3013

"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.

3014

"displayName": "A String", # The organizer's name, if available.

3015

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3016

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3017

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3018

},

3019

"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.

3020

"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.

3021

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3022

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3023

"type": "A String", # The conference solution type.

3024

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3025

# The possible values are:

3026

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3027

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3028

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3029

# - "addOn" for 3P conference providers

3030

},

3031

"requestId": "A String", # The client-generated unique ID for this request.

3032

# 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.

3033

"status": { # The status of the conference create request.

3034

"statusCode": "A String", # The current status of the conference create request. Read-only.

3035

# The possible values are:

3036

# - "pending": the conference create request is still being processed.

3037

# - "success": the conference create request succeeded, the entry points are populated.

3038

# - "failure": the conference create request failed, there are no entry points.

3039

},

3040

},

3041

"conferenceId": "A String", # The ID of the conference.

3042

# Can be used by developers to keep track of conferences, should not be displayed to users.

3043

# Values for solution types:

3044

# - "eventHangout": unset.

3045

# - "eventNamedHangout": the name of the Hangout.

3046

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3047

# - "addOn": defined by 3P conference provider. Optional.

3048

"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.

3049

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3050

# Unset for a conference with a failed create request.

3051

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3052

"name": "A String", # The user-visible name of this solution. Not localized.

3053

"key": { # The key which can uniquely identify the conference solution for this event.

3054

"type": "A String", # The conference solution type.

3055

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3056

# The possible values are:

3057

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3058

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3059

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3060

# - "addOn" for 3P conference providers

3061

},

3062

"iconUri": "A String", # The user-visible icon for this solution.

3063

},

3064

"signature": "A String", # The signature of the conference data.

3065

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3066

# Unset for a conference with a failed create request.

3067

# Optional for a conference with a pending create request.

3068

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3069

# All of them must belong to the same conference.

3070

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3071

{

3072

"entryPointType": "A String", # The type of the conference entry point.

3073

# Possible values are:

3074

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3075

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3076

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3077

# - "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.

3078

"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.

3079

"A String",

3080

],

3081

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3082

# Examples:

3083

# - for video: meet.google.com/aaa-bbbb-ccc

3084

# - for phone: +1 123 268 2601

3085

# - for sip: 12345678@altostrat.com

3086

# - for more: should not be filled

3087

# Optional.

3088

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3089

# 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.

3090

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3091

# Format:

3092

# - for video, http: or https: schema is required.

3093

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3094

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3095

# - for more, http: or https: schema is required.

3096

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3097

# 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.

3098

# Optional.

3099

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3100

# Calendar backend will populate this field only for EntryPointType.PHONE.

3101

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3102

# 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.

3103

# Optional.

3104

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3105

# 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.

3106

# Optional.

3107

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3108

# 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.

},

],

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3113

"addOnParameters": { # Additional add-on specific data.

3114

"parameters": {

3115

"a_key": "A String",

3116

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3117

},

3118

},

3119

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3120

"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.

3121

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3122

"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.

3123

"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-07-22 17:02:09 -0700

[diff] [blame]

3124

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3125

"status": "A String", # Status of the event. Optional. Possible values are:

3126

# - "confirmed" - The event is confirmed. This is the default status.

3127

# - "tentative" - The event is tentatively confirmed.

3128

# - "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.

3129

# A cancelled status represents two different states depending on the event type:

3130

# - 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.

3131

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3132

# - 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.

3133

# 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.

3134

# 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.

3135

"etag": "A String", # ETag of the resource.

3136

"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.

3137

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3138

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3139

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3140

"title": "A String", # The gadget's title. Deprecated.

3141

"type": "A String", # The gadget's type. Deprecated.

3142

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3143

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3144

"preferences": { # Preferences.

3145

"a_key": "A String", # The preference name and corresponding value.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3146

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3147

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3148

# - "icon" - The gadget displays next to the event's title in the calendar view.

3149

# - "chip" - The gadget displays when the event is clicked.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3150

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3151

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3152

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3153

# - "public" - The event is public and event details are visible to all readers of the calendar.

3154

# - "private" - The event is private and only event attendees may view event details.

3155

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3156

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3157

"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.

3158

"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.

3159

"location": "A String", # Geographic location of the event as free-form text. Optional.

3160

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3161

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3162

"kind": "calendar#event", # Type of the resource ("calendar#event").

3163

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3164

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3165

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3166

"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.

3167

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3168

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3169

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3170

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3171

"creator": { # The creator of the event. Read-only.

3172

"email": "A String", # The creator's email address, if available.

3173

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3174

"displayName": "A String", # The creator's name, if available.

3175

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3176

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3177

"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.

3178

# 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.

3179

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3180

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3181

"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.

3182

"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.

3183

},

3184

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3185

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3189

<code class="details" id="update">update(calendarId, eventId, body=None, conferenceDataVersion=None, supportsAttachments=None, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None, sendUpdates=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3190

<pre>Updates an event.

3191

3192

Args:

3193

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

3194

eventId: string, Event identifier. (required)

3195

body: object, The request body.

3196

The object takes the form of:

3197

3198

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3199

"reminders": { # Information about the event's reminders for the authenticated user.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3200

"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]

3201

"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]

3202

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3203

"method": "A String", # The method used by this reminder. Possible values are:

3204

# - "email" - Reminders are sent via email.

3205

# - "popup" - Reminders are sent via a UI popup.

3206

# Required when adding a reminder.

3207

"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).

3208

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3209

},

3210

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3211

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3212

"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.

3213

"description": "A String", # Description of the event. Can contain HTML. Optional.

3214

"summary": "A String", # Title of the event.

3215

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

3216

{

3217

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3218

"displayName": "A String", # The attendee's name, if available. Optional.

3219

"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.

3220

# Required when adding an attendee.

3221

"comment": "A String", # The attendee's response comment. Optional.

3222

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3223

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3224

"responseStatus": "A String", # The attendee's response status. Possible values are:

3225

# - "needsAction" - The attendee has not responded to the invitation.

3226

# - "declined" - The attendee has declined the invitation.

3227

# - "tentative" - The attendee has tentatively accepted the invitation.

3228

# - "accepted" - The attendee has accepted the invitation.

3229

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3230

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3231

"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.

3232

},

3233

],

3234

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3235

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3236

"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]

3237

"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]

3238

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3239

"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:

3240

# - 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

3241

# - the length of the ID must be between 5 and 1024 characters

3242

# - 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.

3243

# If you do not specify an ID, it will be automatically generated by the server.

3244

# 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.

3245

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3246

# - "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.

3247

# - "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]

3248

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3249

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3250

# There can be at most 25 attachments per event,

3251

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3252

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3253

"title": "A String", # Attachment title.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3254

"fileId": "A String", # ID of the attached file. Read-only.

3255

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3256

"fileUrl": "A String", # URL link to the attachment.

3257

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3258

# Required when adding an attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3259

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3260

},

3261

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3262

"extendedProperties": { # Extended properties of the event.

3263

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3264

"a_key": "A String", # The name of the shared property and the corresponding value.

3265

},

3266

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3267

"a_key": "A String", # The name of the private property and the corresponding value.

3268

},

3269

},

3270

"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.

3271

"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.

3272

"A String",

3273

],

3274

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3275

"sequence": 42, # Sequence number as per iCalendar.

3276

"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.

3277

"displayName": "A String", # The organizer's name, if available.

3278

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3279

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3280

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3281

},

3282

"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.

3283

"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.

3284

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3285

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3286

"type": "A String", # The conference solution type.

3287

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3288

# The possible values are:

3289

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3290

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3291

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3292

# - "addOn" for 3P conference providers

3293

},

3294

"requestId": "A String", # The client-generated unique ID for this request.

3295

# 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.

3296

"status": { # The status of the conference create request.

3297

"statusCode": "A String", # The current status of the conference create request. Read-only.

3298

# The possible values are:

3299

# - "pending": the conference create request is still being processed.

3300

# - "success": the conference create request succeeded, the entry points are populated.

3301

# - "failure": the conference create request failed, there are no entry points.

3302

},

3303

},

3304

"conferenceId": "A String", # The ID of the conference.

3305

# Can be used by developers to keep track of conferences, should not be displayed to users.

3306

# Values for solution types:

3307

# - "eventHangout": unset.

3308

# - "eventNamedHangout": the name of the Hangout.

3309

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3310

# - "addOn": defined by 3P conference provider. Optional.

3311

"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.

3312

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3313

# Unset for a conference with a failed create request.

3314

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3315

"name": "A String", # The user-visible name of this solution. Not localized.

3316

"key": { # The key which can uniquely identify the conference solution for this event.

3317

"type": "A String", # The conference solution type.

3318

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3319

# The possible values are:

3320

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3321

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3322

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3323

# - "addOn" for 3P conference providers

3324

},

3325

"iconUri": "A String", # The user-visible icon for this solution.

3326

},

3327

"signature": "A String", # The signature of the conference data.

3328

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3329

# Unset for a conference with a failed create request.

3330

# Optional for a conference with a pending create request.

3331

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3332

# All of them must belong to the same conference.

3333

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3334

{

3335

"entryPointType": "A String", # The type of the conference entry point.

3336

# Possible values are:

3337

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3338

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3339

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3340

# - "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.

3341

"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.

3342

"A String",

3343

],

3344

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3345

# Examples:

3346

# - for video: meet.google.com/aaa-bbbb-ccc

3347

# - for phone: +1 123 268 2601

3348

# - for sip: 12345678@altostrat.com

3349

# - for more: should not be filled

3350

# Optional.

3351

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3352

# 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.

3353

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3354

# Format:

3355

# - for video, http: or https: schema is required.

3356

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3357

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3358

# - for more, http: or https: schema is required.

3359

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3360

# 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.

3361

# Optional.

3362

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3363

# Calendar backend will populate this field only for EntryPointType.PHONE.

3364

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3365

# 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.

3366

# Optional.

3367

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3368

# 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.

3369

# Optional.

3370

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3371

# 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.

},

],

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3376

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

},

"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.

3384

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3385

"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.

3386

"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.

3387

},

3388

"status": "A String", # Status of the event. Optional. Possible values are:

3389

# - "confirmed" - The event is confirmed. This is the default status.

3390

# - "tentative" - The event is tentatively confirmed.

3391

# - "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.

3392

# A cancelled status represents two different states depending on the event type:

3393

# - 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.

3394

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3395

# - 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.

3396

# 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.

3397

# 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.

3398

"etag": "A String", # ETag of the resource.

3399

"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.

3400

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3401

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3402

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3403

"title": "A String", # The gadget's title. Deprecated.

3404

"type": "A String", # The gadget's type. Deprecated.

3405

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3406

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3407

"preferences": { # Preferences.

3408

"a_key": "A String", # The preference name and corresponding value.

3409

},

3410

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3411

# - "icon" - The gadget displays next to the event's title in the calendar view.

3412

# - "chip" - The gadget displays when the event is clicked.

3413

},

3414

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3415

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3416

# - "public" - The event is public and event details are visible to all readers of the calendar.

3417

# - "private" - The event is private and only event attendees may view event details.

3418

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3419

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3420

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3421

"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-11-16 11:05:03 -0700

[diff] [blame]

3422

"location": "A String", # Geographic location of the event as free-form text. Optional.

3423

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3424

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3425

"kind": "calendar#event", # Type of the resource ("calendar#event").

3426

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3427

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3428

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3429

"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.

3430

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3431

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3432

},

3433

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3434

"creator": { # The creator of the event. Read-only.

3435

"email": "A String", # The creator's email address, if available.

3436

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3437

"displayName": "A String", # The creator's name, if available.

3438

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3439

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3440

"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.

3441

# 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-11-16 11:05:03 -0700

[diff] [blame]

3442

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3443

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3444

"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.

3445

"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.

3446

},

3447

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3448

}

3449

3450

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.

3451

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

3452

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

3453

3454

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.

3455

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).

3456

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.

3457

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

3458

Allowed values

3459

all - Notifications are sent to all guests.

3460

externalOnly - Notifications are sent to non-Google Calendar guests only.

3461

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).

3462

3463

Returns:

3464

An object of the form:

3465

3466

{

3467

"reminders": { # Information about the event's reminders for the authenticated user.

3468

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3469

"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.

3470

{

3471

"method": "A String", # The method used by this reminder. Possible values are:

3472

# - "email" - Reminders are sent via email.

3473

# - "popup" - Reminders are sent via a UI popup.

3474

# Required when adding a reminder.

3475

"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).

3476

# Required when adding a reminder.

3477

},

3478

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3479

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3480

"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.

3481

"description": "A String", # Description of the event. Can contain HTML. Optional.

3482

"summary": "A String", # Title of the event.

3483

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

3484

{

3485

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3486

"displayName": "A String", # The attendee's name, if available. Optional.

3487

"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.

3488

# Required when adding an attendee.

3489

"comment": "A String", # The attendee's response comment. Optional.

3490

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3491

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3492

"responseStatus": "A String", # The attendee's response status. Possible values are:

3493

# - "needsAction" - The attendee has not responded to the invitation.

3494

# - "declined" - The attendee has declined the invitation.

3495

# - "tentative" - The attendee has tentatively accepted the invitation.

3496

# - "accepted" - The attendee has accepted the invitation.

3497

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3498

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3499

"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.

3500

},

3501

],

3502

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3503

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3504

"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.

3505

"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.

3506

},

3507

"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:

3508

# - 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

3509

# - the length of the ID must be between 5 and 1024 characters

3510

# - 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.

3511

# If you do not specify an ID, it will be automatically generated by the server.

3512

# 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.

3513

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3514

# - "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.

3515

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3516

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3517

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3518

# There can be at most 25 attachments per event,

3519

{

3520

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3521

"title": "A String", # Attachment title.

3522

"fileId": "A String", # ID of the attached file. Read-only.

3523

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3524

"fileUrl": "A String", # URL link to the attachment.

3525

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3526

# Required when adding an attachment.

3527

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3528

},

3529

],

3530

"extendedProperties": { # Extended properties of the event.

3531

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3532

"a_key": "A String", # The name of the shared property and the corresponding value.

3533

},

3534

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3535

"a_key": "A String", # The name of the private property and the corresponding value.

3536

},

3537

},

3538

"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.

3539

"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.

3540

"A String",

3541

],

3542

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3543

"sequence": 42, # Sequence number as per iCalendar.

3544

"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.

3545

"displayName": "A String", # The organizer's name, if available.

3546

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3547

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3548

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3549

},

3550

"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.

3551

"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.

3552

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3553

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3554

"type": "A String", # The conference solution type.

3555

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3556

# The possible values are:

3557

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3558

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3559

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3560

# - "addOn" for 3P conference providers

3561

},

3562

"requestId": "A String", # The client-generated unique ID for this request.

3563

# 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.

3564

"status": { # The status of the conference create request.

3565

"statusCode": "A String", # The current status of the conference create request. Read-only.

3566

# The possible values are:

3567

# - "pending": the conference create request is still being processed.

3568

# - "success": the conference create request succeeded, the entry points are populated.

3569

# - "failure": the conference create request failed, there are no entry points.

3570

},

3571

},

3572

"conferenceId": "A String", # The ID of the conference.

3573

# Can be used by developers to keep track of conferences, should not be displayed to users.

3574

# Values for solution types:

3575

# - "eventHangout": unset.

3576

# - "eventNamedHangout": the name of the Hangout.

3577

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3578

# - "addOn": defined by 3P conference provider. Optional.

3579

"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.

3580

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3581

# Unset for a conference with a failed create request.

3582

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3583

"name": "A String", # The user-visible name of this solution. Not localized.

3584

"key": { # The key which can uniquely identify the conference solution for this event.

3585

"type": "A String", # The conference solution type.

3586

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3587

# The possible values are:

3588

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3589

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3590

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3591

# - "addOn" for 3P conference providers

3592

},

3593

"iconUri": "A String", # The user-visible icon for this solution.

3594

},

3595

"signature": "A String", # The signature of the conference data.

3596

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3597

# Unset for a conference with a failed create request.

3598

# Optional for a conference with a pending create request.

3599

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3600

# All of them must belong to the same conference.

3601

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3602

{

3603

"entryPointType": "A String", # The type of the conference entry point.

3604

# Possible values are:

3605

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3606

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3607

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3608

# - "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.

3609

"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.

3610

"A String",

3611

],

3612

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3613

# Examples:

3614

# - for video: meet.google.com/aaa-bbbb-ccc

3615

# - for phone: +1 123 268 2601

3616

# - for sip: 12345678@altostrat.com

3617

# - for more: should not be filled

3618

# Optional.

3619

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3620

# 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.

3621

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3622

# Format:

3623

# - for video, http: or https: schema is required.

3624

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3625

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3626

# - for more, http: or https: schema is required.

3627

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3628

# 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.

3629

# Optional.

3630

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3631

# Calendar backend will populate this field only for EntryPointType.PHONE.

3632

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3633

# 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.

3634

# Optional.

3635

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3636

# 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.

3637

# Optional.

3638

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3639

# 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.

},

],

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3644

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

},

"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.

3652

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3653

"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.

3654

"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.

3655

},

3656

"status": "A String", # Status of the event. Optional. Possible values are:

3657

# - "confirmed" - The event is confirmed. This is the default status.

3658

# - "tentative" - The event is tentatively confirmed.

3659

# - "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.

3660

# A cancelled status represents two different states depending on the event type:

3661

# - 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.

3662

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3663

# - 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.

3664

# 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.

3665

# 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.

3666

"etag": "A String", # ETag of the resource.

3667

"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.

3668

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3669

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3670

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3671

"title": "A String", # The gadget's title. Deprecated.

3672

"type": "A String", # The gadget's type. Deprecated.

3673

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3674

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3675

"preferences": { # Preferences.

3676

"a_key": "A String", # The preference name and corresponding value.

3677

},

3678

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3679

# - "icon" - The gadget displays next to the event's title in the calendar view.

3680

# - "chip" - The gadget displays when the event is clicked.

3681

},

3682

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3683

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3684

# - "public" - The event is public and event details are visible to all readers of the calendar.

3685

# - "private" - The event is private and only event attendees may view event details.

3686

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3687

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3688

"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.

3689

"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.

3690

"location": "A String", # Geographic location of the event as free-form text. Optional.

3691

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3692

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3693

"kind": "calendar#event", # Type of the resource ("calendar#event").

3694

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3695

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3696

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3697

"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.

3698

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3699

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3700

},

3701

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3702

"creator": { # The creator of the event. Read-only.

3703

"email": "A String", # The creator's email address, if available.

3704

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3705

"displayName": "A String", # The creator's name, if available.

3706

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3707

},

3708

"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.

3709

# 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.

3710

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3711

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3712

"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.

3713

"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.

3714

},

3715

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3716

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3720

<code class="details" id="watch">watch(calendarId, body=None, iCalUID=None, showHiddenInvitations=None, timeZone=None, maxResults=None, singleEvents=None, syncToken=None, timeMin=None, alwaysIncludeEmail=None, orderBy=None, pageToken=None, privateExtendedProperty=None, updatedMin=None, timeMax=None, q=None, maxAttendees=None, showDeleted=None, sharedExtendedProperty=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3721

<pre>Watch for changes to Events resources.

3722

3723

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3724

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

3725

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3726

The object takes the form of:

3727

3728

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3729

"id": "A String", # A UUID or similar unique string that identifies this channel.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3730

"address": "A String", # The address where notifications are delivered for this channel.

3731

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3732

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3733

"resourceUri": "A String", # A version-specific identifier for the watched resource.

3734

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

3735

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

3736

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

3737

"type": "A String", # The type of delivery mechanism used for this channel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3738

"params": { # Additional parameters controlling delivery channel behavior. Optional.

3739

"a_key": "A String", # Declares a new parameter by name.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3740

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3741

}

3742

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3743

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

3744

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

3745

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

3746

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.

3747

singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

3748

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.

3749

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

3755

- q

3756

- sharedExtendedProperty

3757

- timeMin

3758

- timeMax

3759

- 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.

3760

Learn more about incremental synchronization.

3761

Optional. The default is to return all entries.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3762

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.

3763

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).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3764

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

3765

Allowed values

3766

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

3767

updated - Order by last modification time (ascending).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3768

pageToken: string, Token specifying which result page to return. Optional.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3769

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)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3770

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.

3771

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.

3772

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

3773

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.

3774

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.

3775

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)

John Asmuth