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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

93

<code><a href="#instances">instances(calendarId, eventId, alwaysIncludeEmail=None, originalStart=None, timeMin=None, maxResults=None, pageToken=None, showDeleted=None, timeZone=None, timeMax=None, maxAttendees=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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

99

<code><a href="#list">list(calendarId, timeZone=None, syncToken=None, orderBy=None, timeMax=None, maxAttendees=None, showDeleted=None, iCalUID=None, updatedMin=None, privateExtendedProperty=None, sharedExtendedProperty=None, alwaysIncludeEmail=None, showHiddenInvitations=None, timeMin=None, singleEvents=None, q=None, maxResults=None, pageToken=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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

108

<code><a href="#patch">patch(calendarId, eventId, body=None, maxAttendees=None, conferenceDataVersion=None, alwaysIncludeEmail=None, sendUpdates=None, sendNotifications=None, supportsAttachments=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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

111

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

John Asmuth

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

[diff] [blame]

112

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

113

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

114

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

John Asmuth

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

[diff] [blame]

115

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

116

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

117

<code><a href="#watch">watch(calendarId, body=None, timeMax=None, q=None, iCalUID=None, singleEvents=None, pageToken=None, timeZone=None, timeMin=None, maxAttendees=None, sharedExtendedProperty=None, maxResults=None, privateExtendedProperty=None, alwaysIncludeEmail=None, syncToken=None, showDeleted=None, orderBy=None, showHiddenInvitations=None, updatedMin=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

715bd7f

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>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

144

<code class="details" id="get">get(calendarId, eventId, maxAttendees=None, timeZone=None, alwaysIncludeEmail=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)

Bu Sun Kim

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

[diff] [blame]

150

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

151

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

152

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]

153

154

Returns:

155

An object of the form:

156

157

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

158

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

159

{

160

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

161

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

162

# Required when adding an attendee.

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

Bu Sun Kim

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

[diff] [blame]

175

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

176

],

177

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

178

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

179

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

180

# There can be at most 25 attachments per event,

181

{

182

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

183

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

184

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

185

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

186

# Required when adding an attachment.

187

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

188

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

189

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

190

},

191

],

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

},

207

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

208

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

209

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

210

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

211

},

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

Bu Sun Kim

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

[diff] [blame]

228

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

229

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

230

# Required when adding a reminder.

231

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

232

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

233

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

234

# Required when adding a reminder.

Bu Sun Kim

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

[diff] [blame]

235

},

236

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

237

},

238

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

239

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

240

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

241

},

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

"preferences": { # Preferences.

251

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

Bu Sun Kim

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

[diff] [blame]

252

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

253

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

254

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

255

},

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

# The possible values are:

267

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

268

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

269

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

270

},

271

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

272

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

273

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

274

# The possible values are:

275

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

276

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

277

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

278

# - "addOn" for 3P conference providers

279

},

280

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

281

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

282

},

283

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

284

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

285

# Unset for a conference with a failed create request.

286

# Optional for a conference with a pending create request.

287

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

288

# All of them must belong to the same conference.

289

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

Bu Sun Kim

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

[diff] [blame]

290

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

291

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

292

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

293

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

294

# Format:

295

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

296

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

297

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

298

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

299

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

300

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

301

# Optional.

302

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

303

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

304

# Optional.

305

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

306

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

307

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

308

"A String",

309

],

310

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

311

# Possible values are:

312

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

313

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

314

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

315

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

316

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

317

# Examples:

318

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

319

# - for phone: +1 123 268 2601

320

# - for sip: 12345678@altostrat.com

321

# - for more: should not be filled

322

# Optional.

323

"meetingCode": "A String", # The meeting code 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

"password": "A String", # The password 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.

Bu Sun Kim

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

[diff] [blame]

329

},

330

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

331

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

332

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

333

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

334

# Values for solution types:

335

# - "eventHangout": unset.

336

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

337

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

338

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

339

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

340

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

341

"parameters": {

342

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

343

},

Dmitry Frenkel

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

[diff] [blame]

344

},

Bu Sun Kim

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

[diff] [blame]

345

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

346

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

347

# Unset for a conference with a failed create request.

348

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

349

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

350

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

351

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

352

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

353

# The possible values are:

354

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

355

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

356

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

357

# - "addOn" for 3P conference providers

Takashi Matsuo

0669410

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

[diff] [blame]

358

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

359

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

Bu Sun Kim

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

[diff] [blame]

360

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

361

},

362

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

363

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

364

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

Bu Sun Kim

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

[diff] [blame]

365

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

366

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

367

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

Bu Sun Kim

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

[diff] [blame]

368

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

369

},

370

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

371

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

372

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

373

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

374

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

375

},

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

},

392

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

393

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

394

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

395

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

396

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

397

},

398

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

399

"A String",

400

],

401

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

402

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

403

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

404

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

405

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

406

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

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

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

420

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

421

{

422

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

423

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

424

# Required when adding an attendee.

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

Bu Sun Kim

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

[diff] [blame]

437

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

438

],

439

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

440

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

441

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

442

# There can be at most 25 attachments per event,

443

{

444

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

445

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

446

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

447

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

448

# Required when adding an attachment.

449

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

450

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

451

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

452

},

453

],

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

},

469

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

470

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

471

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

472

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

473

},

474

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

475

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

476

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

477

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

478

# - "cancelled" - The event is cancelled (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.

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

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

488

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

489

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

490

{

491

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

492

# Required when adding a reminder.

493

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

494

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

495

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

496

# Required when adding a reminder.

},

],

},

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

501

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

502

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

503

},

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

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

512

"preferences": { # Preferences.

513

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

514

},

515

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

516

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

517

},

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

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

528

# The possible values are:

529

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

530

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

531

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

532

},

533

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

534

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

535

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

536

# The possible values are:

537

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

538

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

539

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

540

# - "addOn" for 3P conference providers

541

},

542

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

543

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

544

},

545

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

546

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

547

# Unset for a conference with a failed create request.

548

# Optional for a conference with a pending create request.

549

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

550

# All of them must belong to the same conference.

551

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

552

{

553

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

554

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

555

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

556

# Format:

557

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

558

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

559

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

560

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

561

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

562

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

563

# Optional.

564

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

565

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

566

# Optional.

567

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

568

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

569

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

570

"A String",

571

],

572

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

573

# Possible values are:

574

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

575

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

576

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

577

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

578

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

579

# Examples:

580

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

581

# - for phone: +1 123 268 2601

582

# - for sip: 12345678@altostrat.com

583

# - for more: should not be filled

584

# Optional.

585

"meetingCode": "A String", # The meeting code 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

"password": "A String", # The password 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.

# Optional.

},

],

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

594

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

595

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

596

# Values for solution types:

597

# - "eventHangout": unset.

598

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

599

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

600

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

601

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

602

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

"parameters": {

"a_key": "A String",

},

},

},

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

609

# Unset for a conference with a failed create request.

610

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

611

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

612

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

613

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

614

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

615

# The possible values are:

616

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

617

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

618

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

619

# - "addOn" for 3P conference providers

620

},

621

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

622

},

623

},

624

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

625

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

626

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

627

},

628

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

629

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

630

},

631

},

632

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

633

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

634

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

635

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

636

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

637

},

638

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

639

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

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

},

654

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

655

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

656

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

657

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

658

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

659

},

660

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

661

"A String",

662

],

663

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

664

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

665

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

666

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

667

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

668

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

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

{

Bu Sun Kim

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

[diff] [blame]

678

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

679

{

680

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

Bu Sun Kim

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

[diff] [blame]

681

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

682

# Required when adding an attendee.

Bu Sun Kim

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

[diff] [blame]

683

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

684

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

Bu Sun Kim

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

[diff] [blame]

685

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

686

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

687

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

688

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

689

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

690

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

691

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

Bu Sun Kim

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

[diff] [blame]

692

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

Bu Sun Kim

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

[diff] [blame]

693

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

694

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

Bu Sun Kim

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

[diff] [blame]

695

},

696

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

697

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

698

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

699

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

700

# There can be at most 25 attachments per event,

701

{

702

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

703

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

704

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

705

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

706

# Required when adding an attachment.

707

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

708

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

709

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

710

},

711

],

712

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

713

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

714

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

715

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

Bu Sun Kim

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

[diff] [blame]

716

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

717

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

718

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

719

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

720

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

721

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

722

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

723

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

724

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

725

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

[diff] [blame]

726

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

727

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

728

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

729

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

730

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

731

},

732

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

733

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

734

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

735

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

736

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

737

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

738

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

739

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

740

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

741

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

742

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

743

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

744

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

745

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

746

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

747

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

748

{

749

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

750

# Required when adding a reminder.

751

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

752

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

753

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

754

# Required when adding a reminder.

},

],

},

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

759

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

760

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

761

},

762

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

763

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

764

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

765

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

766

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

767

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

768

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

769

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

770

"preferences": { # Preferences.

771

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

772

},

773

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

774

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

775

},

776

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

777

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

778

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

Bu Sun Kim

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

[diff] [blame]

779

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

780

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

Bu Sun Kim

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

[diff] [blame]

781

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

782

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

783

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

784

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

785

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

786

# The possible values are:

787

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

788

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

789

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

790

},

Bu Sun Kim

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

[diff] [blame]

791

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

792

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

793

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

794

# The possible values are:

795

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

796

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

797

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

798

# - "addOn" for 3P conference providers

799

},

800

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

801

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

Bu Sun Kim

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

[diff] [blame]

802

},

803

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

804

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

805

# Unset for a conference with a failed create request.

806

# Optional for a conference with a pending create request.

807

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

808

# All of them must belong to the same conference.

809

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

810

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

811

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

812

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

813

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

814

# Format:

815

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

816

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

817

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

818

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

819

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

820

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

821

# Optional.

822

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

823

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

824

# Optional.

825

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

826

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

827

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

828

"A String",

829

],

Bu Sun Kim

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

[diff] [blame]

830

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

831

# Possible values are:

832

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

833

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

834

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

835

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

Bu Sun Kim

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

[diff] [blame]

836

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

837

# Examples:

838

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

839

# - for phone: +1 123 268 2601

840

# - for sip: 12345678@altostrat.com

841

# - for more: should not be filled

842

# Optional.

Bu Sun Kim

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

[diff] [blame]

843

"meetingCode": "A String", # The meeting code 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.

Bu Sun Kim

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

[diff] [blame]

846

"password": "A String", # The password 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.

Bu Sun Kim

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

[diff] [blame]

849

},

850

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

851

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

852

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

853

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

854

# Values for solution types:

855

# - "eventHangout": unset.

856

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

857

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

858

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

Bu Sun Kim

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

[diff] [blame]

859

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

860

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

"parameters": {

"a_key": "A String",

},

},

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

866

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

867

# Unset for a conference with a failed create request.

868

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

869

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

870

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

871

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

872

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

873

# The possible values are:

874

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

875

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

876

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

877

# - "addOn" for 3P conference providers

878

},

879

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

880

},

Bu Sun Kim

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

[diff] [blame]

881

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

882

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

883

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

884

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

885

},

886

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

887

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

888

},

889

},

890

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

891

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

892

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

[diff] [blame]

893

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

894

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

[diff] [blame]

895

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

896

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

897

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

898

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

899

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

Bu Sun Kim

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

[diff] [blame]

900

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

901

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

902

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

903

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

904

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

Bu Sun Kim

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

[diff] [blame]

905

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

906

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

907

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

908

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

909

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

910

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

Bu Sun Kim

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

[diff] [blame]

911

},

Bu Sun Kim

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

[diff] [blame]

912

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

913

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

Bu Sun Kim

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

[diff] [blame]

914

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

915

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

916

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

Bu Sun Kim

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

[diff] [blame]

917

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

918

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

919

"A String",

920

],

921

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

922

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

Dmitry Frenkel

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

[diff] [blame]

923

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

924

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

925

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

926

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

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

931

<code class="details" id="insert">insert(calendarId, body=None, sendNotifications=None, supportsAttachments=None, maxAttendees=None, sendUpdates=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

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

940

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

941

{

942

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

943

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

944

# Required when adding an attendee.

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

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

Bu Sun Kim

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

[diff] [blame]

957

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

958

],

959

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

960

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

961

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

962

# There can be at most 25 attachments per event,

963

{

964

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

965

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

966

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

967

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

968

# Required when adding an attachment.

969

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

970

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

971

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

972

},

973

],

974

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

975

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

976

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

977

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

978

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

979

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

980

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

981

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

982

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

983

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

984

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

985

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

986

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

987

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

988

},

989

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

990

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

991

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

992

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

993

},

994

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

995

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

996

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

997

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

998

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

999

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

1000

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

1001

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

1002

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

1003

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

1004

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

1005

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

1006

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

1007

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

1008

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

1009

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

1010

{

1011

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

1012

# Required when adding a reminder.

1013

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

1014

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

1015

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

1016

# Required when adding a reminder.

},

],

},

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

1021

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

1022

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

1023

},

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

"preferences": { # Preferences.

1033

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

1034

},

1035

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

1036

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

1037

},

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

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

1048

# The possible values are:

1049

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

1050

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

1051

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

1052

},

1053

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

1054

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

1055

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

1056

# The possible values are:

1057

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

1058

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

1059

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

1060

# - "addOn" for 3P conference providers

1061

},

1062

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

1063

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

1064

},

1065

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

1066

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

1067

# Unset for a conference with a failed create request.

1068

# Optional for a conference with a pending create request.

1069

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

1070

# All of them must belong to the same conference.

1071

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

1072

{

1073

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

1074

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

1075

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

1076

# Format:

1077

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

1078

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

1079

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

1080

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

1081

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

1082

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1083

# Optional.

1084

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

1085

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1086

# Optional.

1087

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

1088

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1089

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

1090

"A String",

1091

],

1092

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

1093

# Possible values are:

1094

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

1095

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

1096

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

1097

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

1098

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

1099

# Examples:

1100

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

1101

# - for phone: +1 123 268 2601

1102

# - for sip: 12345678@altostrat.com

1103

# - for more: should not be filled

1104

# Optional.

1105

"meetingCode": "A String", # The meeting code 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

"password": "A String", # The password 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.

# Optional.

},

],

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

1114

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

1115

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

1116

# Values for solution types:

1117

# - "eventHangout": unset.

1118

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

1119

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

1120

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

1121

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

1122

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

"parameters": {

"a_key": "A String",

},

},

},

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

1129

# Unset for a conference with a failed create request.

1130

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

1131

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

1132

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

1133

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

1134

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

1135

# The possible values are:

1136

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

1137

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

1138

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

1139

# - "addOn" for 3P conference providers

1140

},

1141

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

1142

},

1143

},

1144

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

1145

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

1146

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

1147

},

1148

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

1149

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

1150

},

1151

},

1152

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

1153

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

1154

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

1155

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

1156

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

1157

},

1158

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

1159

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

1160

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

1161

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

1162

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

1163

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

1164

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

1165

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

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

},

1174

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

1175

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

1176

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

1177

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

1178

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

1179

},

1180

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

1181

"A String",

1182

],

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

1189

}

1190

1191

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

1192

1193

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.

1194

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

1195

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.

1196

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.

1197

Allowed values

1198

all - Notifications are sent to all guests.

1199

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

1200

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

1201

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

1202

1203

Returns:

1204

An object of the form:

1205

1206

{

Bu Sun Kim

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

[diff] [blame]

1207

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

1208

{

1209

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

Bu Sun Kim

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

[diff] [blame]

1210

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

1211

# Required when adding an attendee.

Bu Sun Kim

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

[diff] [blame]

1212

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1213

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

Bu Sun Kim

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

[diff] [blame]

1214

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

1215

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

1216

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

1217

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

1218

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1219

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

1220

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

Bu Sun Kim

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

[diff] [blame]

1221

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

Bu Sun Kim

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

[diff] [blame]

1222

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1223

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

Bu Sun Kim

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

[diff] [blame]

1224

},

1225

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1226

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

1227

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

1228

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

1229

# There can be at most 25 attachments per event,

1230

{

1231

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

1232

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

1233

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

1234

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

1235

# Required when adding an attachment.

1236

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

1237

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

1238

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

1239

},

1240

],

1241

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

1242

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

1243

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

1244

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

Bu Sun Kim

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

[diff] [blame]

1245

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

1246

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

1247

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

1248

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

1249

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

1250

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1251

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

1252

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

1253

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

1254

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

[diff] [blame]

1255

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1256

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1257

"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.

1258

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1259

"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.

1260

},

1261

"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.

1262

"status": "A String", # Status of the event. Optional. Possible values are:

1263

# - "confirmed" - The event is confirmed. This is the default status.

1264

# - "tentative" - The event is tentatively confirmed.

1265

# - "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.

1266

# A cancelled status represents two different states depending on the event type:

1267

# - 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.

1268

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1269

# - 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.

1270

# 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.

1271

# 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.

1272

"kind": "calendar#event", # Type of the resource ("calendar#event").

1273

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1274

"reminders": { # Information about the event's reminders for the authenticated user.

1275

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1276

"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.

1277

{

1278

"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).

1279

# Required when adding a reminder.

1280

"method": "A String", # The method used by this reminder. Possible values are:

1281

# - "email" - Reminders are sent via email.

1282

# - "popup" - Reminders are sent via a UI popup.

1283

# Required when adding a reminder.

},

],

},

"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.

1288

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1289

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1290

},

1291

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1292

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1293

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1294

"title": "A String", # The gadget's title. Deprecated.

1295

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1296

# - "icon" - The gadget displays next to the event's title in the calendar view.

1297

# - "chip" - The gadget displays when the event is clicked.

1298

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1299

"preferences": { # Preferences.

1300

"a_key": "A String", # The preference name and corresponding value.

1301

},

1302

"type": "A String", # The gadget's type. Deprecated.

1303

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1304

},

1305

"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.

1306

"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.

1307

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1308

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1309

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1310

"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.

1311

"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.

1312

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1313

"status": { # The status of the conference create request.

1314

"statusCode": "A String", # The current status of the conference create request. Read-only.

1315

# The possible values are:

1316

# - "pending": the conference create request is still being processed.

1317

# - "success": the conference create request succeeded, the entry points are populated.

1318

# - "failure": the conference create request failed, there are no entry points.

1319

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1320

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1321

"type": "A String", # The conference solution type.

1322

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1323

# The possible values are:

1324

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1325

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1326

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1327

# - "addOn" for 3P conference providers

1328

},

1329

"requestId": "A String", # The client-generated unique ID for this request.

1330

# 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1331

},

1332

"signature": "A String", # The signature of the conference data.

1333

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1334

# Unset for a conference with a failed create request.

1335

# Optional for a conference with a pending create request.

1336

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1337

# All of them must belong to the same conference.

1338

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1339

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1340

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1341

# Calendar backend will populate this field only for EntryPointType.PHONE.

1342

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1343

# Format:

1344

# - for video, http: or https: schema is required.

1345

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1346

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1347

# - for more, http: or https: schema is required.

1348

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1349

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1350

# Optional.

1351

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1352

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1353

# Optional.

1354

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1355

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1356

"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.

1357

"A String",

1358

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1359

"entryPointType": "A String", # The type of the conference entry point.

1360

# Possible values are:

1361

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1362

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1363

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1364

# - "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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1365

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1366

# Examples:

1367

# - for video: meet.google.com/aaa-bbbb-ccc

1368

# - for phone: +1 123 268 2601

1369

# - for sip: 12345678@altostrat.com

1370

# - for more: should not be filled

1371

# Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1372

"meetingCode": "A String", # The meeting code 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1375

"password": "A String", # The password 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1378

},

1379

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1380

"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.

1381

"conferenceId": "A String", # The ID of the conference.

1382

# Can be used by developers to keep track of conferences, should not be displayed to users.

1383

# Values for solution types:

1384

# - "eventHangout": unset.

1385

# - "eventNamedHangout": the name of the Hangout.

1386

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1387

# - "addOn": defined by 3P conference provider. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1388

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1389

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1395

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1396

# Unset for a conference with a failed create request.

1397

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1398

"iconUri": "A String", # The user-visible icon for this solution.

1399

"key": { # The key which can uniquely identify the conference solution for this event.

1400

"type": "A String", # The conference solution type.

1401

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1402

# The possible values are:

1403

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1404

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1405

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1406

# - "addOn" for 3P conference providers

1407

},

1408

"name": "A String", # The user-visible name of this solution. Not localized.

1409

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1410

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1411

"extendedProperties": { # Extended properties of the event.

1412

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1413

"a_key": "A String", # The name of the shared property and the corresponding value.

1414

},

1415

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1416

"a_key": "A String", # The name of the private property and the corresponding value.

1417

},

1418

},

1419

"summary": "A String", # Title of the event.

1420

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1421

"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-11-16 11:05:03 -0700

[diff] [blame]

1422

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1423

"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-11-16 11:05:03 -0700

[diff] [blame]

1424

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1425

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1426

# - "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.

1427

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1428

"location": "A String", # Geographic location of the event as free-form text. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1429

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1430

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1431

# - "public" - The event is public and event details are visible to all readers of the calendar.

1432

# - "private" - The event is private and only event attendees may view event details.

1433

# - "confidential" - The event is private. This value is provided for compatibility reasons.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1434

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1435

"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.

1436

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1437

"displayName": "A String", # The organizer's name, if available.

1438

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1439

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1440

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1441

"creator": { # The creator of the event. Read-only.

1442

"email": "A String", # The creator's email address, if available.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1443

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1444

"displayName": "A String", # The creator's name, if available.

1445

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1446

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1447

"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.

1448

"A String",

1449

],

1450

"sequence": 42, # Sequence number as per iCalendar.

1451

"description": "A String", # Description of the event. Can contain HTML. Optional.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1452

"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.

1453

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1454

"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.

1455

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1456

}</pre>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1460

<code class="details" id="instances">instances(calendarId, eventId, alwaysIncludeEmail=None, originalStart=None, timeMin=None, maxResults=None, pageToken=None, showDeleted=None, timeZone=None, timeMax=None, maxAttendees=None)</code>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1461

<pre>Returns instances of the specified recurring event.

1462

1463

Args:

1464

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

1465

eventId: string, Recurring event identifier. (required)

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1466

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]

1467

originalStart: string, The original start time of the instance in the result. Optional.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1468

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.

1469

maxResults: integer, Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1470

pageToken: string, Token specifying which result page to return. Optional.

1471

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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1472

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

1473

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.

1474

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1475

1476

Returns:

1477

An object of the form:

1478

1479

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1480

"items": [ # List of events on the calendar.

1481

{

1482

"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.

1483

{

1484

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1485

"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.

1486

# Required when adding an attendee.

1487

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1488

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1489

"responseStatus": "A String", # The attendee's response status. Possible values are:

1490

# - "needsAction" - The attendee has not responded to the invitation.

1491

# - "declined" - The attendee has declined the invitation.

1492

# - "tentative" - The attendee has tentatively accepted the invitation.

1493

# - "accepted" - The attendee has accepted the invitation.

1494

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1495

"displayName": "A String", # The attendee's name, if available. Optional.

1496

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1497

"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.

1498

"comment": "A String", # The attendee's response comment. Optional.

1499

},

1500

],

1501

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1502

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1503

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1504

# There can be at most 25 attachments per event,

1505

{

1506

"fileId": "A String", # ID of the attached file. Read-only.

1507

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1508

"fileUrl": "A String", # URL link to the attachment.

1509

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1510

# Required when adding an attachment.

1511

"title": "A String", # Attachment title.

1512

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1513

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1514

},

1515

],

1516

"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.

1517

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1518

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1519

"etag": "A String", # ETag of the resource.

1520

"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:

1521

# - 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

1522

# - the length of the ID must be between 5 and 1024 characters

1523

# - 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.

1524

# If you do not specify an ID, it will be automatically generated by the server.

1525

# 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.

1526

"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.

1527

"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.

1528

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1529

"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.

1530

},

1531

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

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

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1534

"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.

1535

},

1536

"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.

1537

"status": "A String", # Status of the event. Optional. Possible values are:

1538

# - "confirmed" - The event is confirmed. This is the default status.

1539

# - "tentative" - The event is tentatively confirmed.

1540

# - "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.

1541

# A cancelled status represents two different states depending on the event type:

1542

# - 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.

1543

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1544

# - 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.

1545

# 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.

1546

# 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.

1547

"kind": "calendar#event", # Type of the resource ("calendar#event").

1548

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1549

"reminders": { # Information about the event's reminders for the authenticated user.

1550

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1551

"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.

1552

{

1553

"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).

1554

# Required when adding a reminder.

1555

"method": "A String", # The method used by this reminder. Possible values are:

1556

# - "email" - Reminders are sent via email.

1557

# - "popup" - Reminders are sent via a UI popup.

1558

# Required when adding a reminder.

},

],

},

"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.

1563

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1564

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1565

},

1566

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1567

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1568

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1569

"title": "A String", # The gadget's title. Deprecated.

1570

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1571

# - "icon" - The gadget displays next to the event's title in the calendar view.

1572

# - "chip" - The gadget displays when the event is clicked.

1573

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1574

"preferences": { # Preferences.

1575

"a_key": "A String", # The preference name and corresponding value.

1576

},

1577

"type": "A String", # The gadget's type. Deprecated.

1578

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1579

},

1580

"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.

1581

"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.

1582

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1583

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1584

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1585

"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.

1586

"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.

1587

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1588

"status": { # The status of the conference create request.

1589

"statusCode": "A String", # The current status of the conference create request. Read-only.

1590

# The possible values are:

1591

# - "pending": the conference create request is still being processed.

1592

# - "success": the conference create request succeeded, the entry points are populated.

1593

# - "failure": the conference create request failed, there are no entry points.

1594

},

1595

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1596

"type": "A String", # The conference solution type.

1597

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1598

# The possible values are:

1599

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1600

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1601

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1602

# - "addOn" for 3P conference providers

1603

},

1604

"requestId": "A String", # The client-generated unique ID for this request.

1605

# 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.

1606

},

1607

"signature": "A String", # The signature of the conference data.

1608

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1609

# Unset for a conference with a failed create request.

1610

# Optional for a conference with a pending create request.

1611

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1612

# All of them must belong to the same conference.

1613

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1614

{

1615

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1616

# Calendar backend will populate this field only for EntryPointType.PHONE.

1617

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1618

# Format:

1619

# - for video, http: or https: schema is required.

1620

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1621

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1622

# - for more, http: or https: schema is required.

1623

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1624

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1625

# Optional.

1626

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1627

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1628

# Optional.

1629

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1630

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1631

"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.

1632

"A String",

1633

],

1634

"entryPointType": "A String", # The type of the conference entry point.

1635

# Possible values are:

1636

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1637

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1638

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1639

# - "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.

1640

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1641

# Examples:

1642

# - for video: meet.google.com/aaa-bbbb-ccc

1643

# - for phone: +1 123 268 2601

1644

# - for sip: 12345678@altostrat.com

1645

# - for more: should not be filled

1646

# Optional.

1647

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1648

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1649

# Optional.

1650

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1651

# When creating new conference data, populate only the 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.

},

],

"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.

1656

"conferenceId": "A String", # The ID of the conference.

1657

# Can be used by developers to keep track of conferences, should not be displayed to users.

1658

# Values for solution types:

1659

# - "eventHangout": unset.

1660

# - "eventNamedHangout": the name of the Hangout.

1661

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1662

# - "addOn": defined by 3P conference provider. Optional.

1663

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1664

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1671

# Unset for a conference with a failed create request.

1672

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1673

"iconUri": "A String", # The user-visible icon for this solution.

1674

"key": { # The key which can uniquely identify the conference solution for this event.

1675

"type": "A String", # The conference solution type.

1676

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1677

# The possible values are:

1678

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1679

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1680

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1681

# - "addOn" for 3P conference providers

1682

},

1683

"name": "A String", # The user-visible name of this solution. Not localized.

1684

},

1685

},

1686

"extendedProperties": { # Extended properties of the event.

1687

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1688

"a_key": "A String", # The name of the shared property and the corresponding value.

1689

},

1690

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1691

"a_key": "A String", # The name of the private property and the corresponding value.

1692

},

1693

},

1694

"summary": "A String", # Title of the event.

1695

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1696

"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.

1697

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1698

"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.

1699

},

1700

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1701

# - "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.

1702

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1703

"location": "A String", # Geographic location of the event as free-form text. Optional.

1704

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1705

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1706

# - "public" - The event is public and event details are visible to all readers of the calendar.

1707

# - "private" - The event is private and only event attendees may view event details.

1708

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1709

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1710

"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.

1711

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1712

"displayName": "A String", # The organizer's name, if available.

1713

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1714

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1715

},

1716

"creator": { # The creator of the event. Read-only.

1717

"email": "A String", # The creator's email address, if available.

1718

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1719

"displayName": "A String", # The creator's name, if available.

1720

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1721

},

1722

"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.

1723

"A String",

1724

],

1725

"sequence": 42, # Sequence number as per iCalendar.

1726

"description": "A String", # Description of the event. Can contain HTML. Optional.

1727

"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.

1728

# 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.

1729

"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.

1730

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1731

},

1732

],

1733

"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).

1734

{

1735

"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).

1736

# Required when adding a reminder.

1737

"method": "A String", # The method used by this reminder. Possible values are:

1738

# - "email" - Reminders are sent via email.

1739

# - "popup" - Reminders are sent via a UI popup.

1740

# Required when adding a reminder.

1741

},

1742

],

1743

"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-05-20 12:08:20 -0700

[diff] [blame]

1744

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1745

# - "none" - The user has no access.

1746

# - "freeBusyReader" - The user has read access to free/busy information.

1747

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1748

# - "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.

1749

# - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1750

"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.

1751

"kind": "calendar#events", # Type of the collection ("calendar#events").

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1752

"etag": "A String", # ETag of the collection.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1753

"timeZone": "A String", # The time zone of the calendar. Read-only.

1754

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

1755

"summary": "A String", # Title of the calendar. Read-only.

1756

"description": "A String", # Description of the calendar. Read-only.

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>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1775

<code class="details" id="list">list(calendarId, timeZone=None, syncToken=None, orderBy=None, timeMax=None, maxAttendees=None, showDeleted=None, iCalUID=None, updatedMin=None, privateExtendedProperty=None, sharedExtendedProperty=None, alwaysIncludeEmail=None, showHiddenInvitations=None, timeMin=None, singleEvents=None, q=None, maxResults=None, pageToken=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-07-22 17:02:09 -0700

[diff] [blame]

1780

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

1781

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.

1782

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

1788

- q

1789

- sharedExtendedProperty

1790

- timeMin

1791

- timeMax

1792

- 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.

1793

Learn more about incremental synchronization.

1794

Optional. The default is to return all entries.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1795

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

1796

Allowed values

1797

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

1798

updated - Order by last modification time (ascending).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1799

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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1800

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.

1801

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.

1802

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

1803

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.

1804

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)

1805

sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1806

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1807

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

1808

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.

1809

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.

1810

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

1811

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.

1812

pageToken: string, Token specifying which result page to return. Optional.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1813

1814

Returns:

1815

An object of the form:

1816

1817

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1818

"items": [ # List of events on the calendar.

1819

{

1820

"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.

1821

{

1822

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1823

"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.

1824

# Required when adding an attendee.

1825

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1826

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1827

"responseStatus": "A String", # The attendee's response status. Possible values are:

1828

# - "needsAction" - The attendee has not responded to the invitation.

1829

# - "declined" - The attendee has declined the invitation.

1830

# - "tentative" - The attendee has tentatively accepted the invitation.

1831

# - "accepted" - The attendee has accepted the invitation.

1832

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1833

"displayName": "A String", # The attendee's name, if available. Optional.

1834

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1835

"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.

1836

"comment": "A String", # The attendee's response comment. Optional.

1837

},

1838

],

1839

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1840

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1841

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1842

# There can be at most 25 attachments per event,

1843

{

1844

"fileId": "A String", # ID of the attached file. Read-only.

1845

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1846

"fileUrl": "A String", # URL link to the attachment.

1847

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1848

# Required when adding an attachment.

1849

"title": "A String", # Attachment title.

1850

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1851

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1852

},

1853

],

1854

"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.

1855

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1856

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1857

"etag": "A String", # ETag of the resource.

1858

"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:

1859

# - 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

1860

# - the length of the ID must be between 5 and 1024 characters

1861

# - 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.

1862

# If you do not specify an ID, it will be automatically generated by the server.

1863

# 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.

1864

"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.

1865

"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.

1866

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1867

"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.

1868

},

1869

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

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

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1872

"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.

1873

},

1874

"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.

1875

"status": "A String", # Status of the event. Optional. Possible values are:

1876

# - "confirmed" - The event is confirmed. This is the default status.

1877

# - "tentative" - The event is tentatively confirmed.

1878

# - "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.

1879

# A cancelled status represents two different states depending on the event type:

1880

# - 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.

1881

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1882

# - 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.

1883

# 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.

1884

# 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.

1885

"kind": "calendar#event", # Type of the resource ("calendar#event").

1886

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1887

"reminders": { # Information about the event's reminders for the authenticated user.

1888

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1889

"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.

1890

{

1891

"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).

1892

# Required when adding a reminder.

1893

"method": "A String", # The method used by this reminder. Possible values are:

1894

# - "email" - Reminders are sent via email.

1895

# - "popup" - Reminders are sent via a UI popup.

1896

# Required when adding a reminder.

},

],

},

"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.

1901

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1902

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1903

},

1904

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1905

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1906

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1907

"title": "A String", # The gadget's title. Deprecated.

1908

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1909

# - "icon" - The gadget displays next to the event's title in the calendar view.

1910

# - "chip" - The gadget displays when the event is clicked.

1911

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1912

"preferences": { # Preferences.

1913

"a_key": "A String", # The preference name and corresponding value.

1914

},

1915

"type": "A String", # The gadget's type. Deprecated.

1916

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1917

},

1918

"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.

1919

"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.

1920

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1921

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1922

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1923

"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.

1924

"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.

1925

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1926

"status": { # The status of the conference create request.

1927

"statusCode": "A String", # The current status of the conference create request. Read-only.

1928

# The possible values are:

1929

# - "pending": the conference create request is still being processed.

1930

# - "success": the conference create request succeeded, the entry points are populated.

1931

# - "failure": the conference create request failed, there are no entry points.

1932

},

1933

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1934

"type": "A String", # The conference solution type.

1935

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1936

# The possible values are:

1937

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1938

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1939

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1940

# - "addOn" for 3P conference providers

1941

},

1942

"requestId": "A String", # The client-generated unique ID for this request.

1943

# 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.

1944

},

1945

"signature": "A String", # The signature of the conference data.

1946

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1947

# Unset for a conference with a failed create request.

1948

# Optional for a conference with a pending create request.

1949

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1950

# All of them must belong to the same conference.

1951

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1952

{

1953

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1954

# Calendar backend will populate this field only for EntryPointType.PHONE.

1955

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1956

# Format:

1957

# - for video, http: or https: schema is required.

1958

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1959

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1960

# - for more, http: or https: schema is required.

1961

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1962

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1963

# Optional.

1964

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1965

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1966

# Optional.

1967

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1968

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1969

"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.

1970

"A String",

1971

],

1972

"entryPointType": "A String", # The type of the conference entry point.

1973

# Possible values are:

1974

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1975

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1976

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1977

# - "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.

1978

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1979

# Examples:

1980

# - for video: meet.google.com/aaa-bbbb-ccc

1981

# - for phone: +1 123 268 2601

1982

# - for sip: 12345678@altostrat.com

1983

# - for more: should not be filled

1984

# Optional.

1985

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1986

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1987

# Optional.

1988

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1989

# When creating new conference data, populate only the 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.

},

],

"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.

1994

"conferenceId": "A String", # The ID of the conference.

1995

# Can be used by developers to keep track of conferences, should not be displayed to users.

1996

# Values for solution types:

1997

# - "eventHangout": unset.

1998

# - "eventNamedHangout": the name of the Hangout.

1999

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2000

# - "addOn": defined by 3P conference provider. Optional.

2001

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2002

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2009

# Unset for a conference with a failed create request.

2010

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2011

"iconUri": "A String", # The user-visible icon for this solution.

2012

"key": { # The key which can uniquely identify the conference solution for this event.

2013

"type": "A String", # The conference solution type.

2014

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2015

# The possible values are:

2016

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2017

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2018

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2019

# - "addOn" for 3P conference providers

2020

},

2021

"name": "A String", # The user-visible name of this solution. Not localized.

2022

},

2023

},

2024

"extendedProperties": { # Extended properties of the event.

2025

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2026

"a_key": "A String", # The name of the shared property and the corresponding value.

2027

},

2028

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2029

"a_key": "A String", # The name of the private property and the corresponding value.

2030

},

2031

},

2032

"summary": "A String", # Title of the event.

2033

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2034

"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.

2035

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2036

"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.

2037

},

2038

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2039

# - "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.

2040

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2041

"location": "A String", # Geographic location of the event as free-form text. Optional.

2042

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2043

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2044

# - "public" - The event is public and event details are visible to all readers of the calendar.

2045

# - "private" - The event is private and only event attendees may view event details.

2046

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2047

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2048

"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.

2049

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2050

"displayName": "A String", # The organizer's name, if available.

2051

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2052

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2053

},

2054

"creator": { # The creator of the event. Read-only.

2055

"email": "A String", # The creator's email address, if available.

2056

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2057

"displayName": "A String", # The creator's name, if available.

2058

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2059

},

2060

"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.

2061

"A String",

2062

],

2063

"sequence": 42, # Sequence number as per iCalendar.

2064

"description": "A String", # Description of the event. Can contain HTML. Optional.

2065

"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.

2066

# 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.

2067

"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.

2068

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2069

},

2070

],

2071

"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).

2072

{

2073

"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).

2074

# Required when adding a reminder.

2075

"method": "A String", # The method used by this reminder. Possible values are:

2076

# - "email" - Reminders are sent via email.

2077

# - "popup" - Reminders are sent via a UI popup.

2078

# Required when adding a reminder.

2079

},

2080

],

2081

"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-05-20 12:08:20 -0700

[diff] [blame]

2082

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

2083

# - "none" - The user has no access.

2084

# - "freeBusyReader" - The user has read access to free/busy information.

2085

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

2086

# - "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.

2087

# - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2088

"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.

2089

"kind": "calendar#events", # Type of the collection ("calendar#events").

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2090

"etag": "A String", # ETag of the collection.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2091

"timeZone": "A String", # The time zone of the calendar. Read-only.

2092

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

2093

"summary": "A String", # Title of the calendar. Read-only.

2094

"description": "A String", # Description of the calendar. Read-only.

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

715bd7f

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

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2133

"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.

2134

{

2135

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2136

"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.

2137

# Required when adding an attendee.

2138

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2139

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2140

"responseStatus": "A String", # The attendee's response status. Possible values are:

2141

# - "needsAction" - The attendee has not responded to the invitation.

2142

# - "declined" - The attendee has declined the invitation.

2143

# - "tentative" - The attendee has tentatively accepted the invitation.

2144

# - "accepted" - The attendee has accepted the invitation.

2145

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2146

"displayName": "A String", # The attendee's name, if available. Optional.

2147

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2148

"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.

2149

"comment": "A String", # The attendee's response comment. Optional.

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

2150

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2151

],

2152

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2153

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2154

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2155

# There can be at most 25 attachments per event,

2156

{

2157

"fileId": "A String", # ID of the attached file. Read-only.

2158

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2159

"fileUrl": "A String", # URL link to the attachment.

2160

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2161

# Required when adding an attachment.

2162

"title": "A String", # Attachment title.

2163

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2164

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2165

},

2166

],

2167

"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.

2168

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2169

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2170

"etag": "A String", # ETag of the resource.

2171

"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:

2172

# - 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

2173

# - the length of the ID must be between 5 and 1024 characters

2174

# - 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.

2175

# If you do not specify an ID, it will be automatically generated by the server.

2176

# 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.

2177

"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.

2178

"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.

2179

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2180

"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.

2181

},

2182

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2183

"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.

2184

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2185

"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.

2186

},

2187

"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.

2188

"status": "A String", # Status of the event. Optional. Possible values are:

2189

# - "confirmed" - The event is confirmed. This is the default status.

2190

# - "tentative" - The event is tentatively confirmed.

2191

# - "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.

2192

# A cancelled status represents two different states depending on the event type:

2193

# - 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.

2194

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2195

# - 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.

2196

# 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.

2197

# 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.

2198

"kind": "calendar#event", # Type of the resource ("calendar#event").

2199

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2200

"reminders": { # Information about the event's reminders for the authenticated user.

2201

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2202

"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2203

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2204

"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).

2205

# Required when adding a reminder.

2206

"method": "A String", # The method used by this reminder. Possible values are:

2207

# - "email" - Reminders are sent via email.

2208

# - "popup" - Reminders are sent via a UI popup.

2209

# Required when adding a reminder.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2210

},

2211

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2212

},

2213

"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.

2214

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2215

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2216

},

2217

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2218

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2219

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2220

"title": "A String", # The gadget's title. Deprecated.

2221

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2222

# - "icon" - The gadget displays next to the event's title in the calendar view.

2223

# - "chip" - The gadget displays when the event is clicked.

2224

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2225

"preferences": { # Preferences.

2226

"a_key": "A String", # The preference name and corresponding value.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2227

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2228

"type": "A String", # The gadget's type. Deprecated.

2229

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2230

},

2231

"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.

2232

"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.

2233

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2234

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2235

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2236

"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.

2237

"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.

2238

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2239

"status": { # The status of the conference create request.

2240

"statusCode": "A String", # The current status of the conference create request. Read-only.

2241

# The possible values are:

2242

# - "pending": the conference create request is still being processed.

2243

# - "success": the conference create request succeeded, the entry points are populated.

2244

# - "failure": the conference create request failed, there are no entry points.

2245

},

2246

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2247

"type": "A String", # The conference solution type.

2248

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2249

# The possible values are:

2250

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2251

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2252

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2253

# - "addOn" for 3P conference providers

2254

},

2255

"requestId": "A String", # The client-generated unique ID for this request.

2256

# 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.

2257

},

2258

"signature": "A String", # The signature of the conference data.

2259

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2260

# Unset for a conference with a failed create request.

2261

# Optional for a conference with a pending create request.

2262

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2263

# All of them must belong to the same conference.

2264

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2265

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2266

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2267

# Calendar backend will populate this field only for EntryPointType.PHONE.

2268

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2269

# Format:

2270

# - for video, http: or https: schema is required.

2271

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2272

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2273

# - for more, http: or https: schema is required.

2274

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2275

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2276

# Optional.

2277

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2278

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2279

# Optional.

2280

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2281

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2282

"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.

2283

"A String",

2284

],

2285

"entryPointType": "A String", # The type of the conference entry point.

2286

# Possible values are:

2287

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2288

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2289

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2290

# - "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.

2291

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2292

# Examples:

2293

# - for video: meet.google.com/aaa-bbbb-ccc

2294

# - for phone: +1 123 268 2601

2295

# - for sip: 12345678@altostrat.com

2296

# - for more: should not be filled

2297

# Optional.

2298

"meetingCode": "A String", # The meeting code 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

"password": "A String", # The password 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2304

},

2305

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2306

"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.

2307

"conferenceId": "A String", # The ID of the conference.

2308

# Can be used by developers to keep track of conferences, should not be displayed to users.

2309

# Values for solution types:

2310

# - "eventHangout": unset.

2311

# - "eventNamedHangout": the name of the Hangout.

2312

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2313

# - "addOn": defined by 3P conference provider. Optional.

2314

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2315

"addOnParameters": { # Additional add-on specific data.

2316

"parameters": {

2317

"a_key": "A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2318

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2319

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2320

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2321

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2322

# Unset for a conference with a failed create request.

2323

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2324

"iconUri": "A String", # The user-visible icon for this solution.

2325

"key": { # The key which can uniquely identify the conference solution for this event.

2326

"type": "A String", # The conference solution type.

2327

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2328

# The possible values are:

2329

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2330

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2331

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2332

# - "addOn" for 3P conference providers

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

2333

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2334

"name": "A String", # The user-visible name of this solution. Not localized.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2335

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2336

},

2337

"extendedProperties": { # Extended properties of the event.

2338

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2339

"a_key": "A String", # The name of the shared property and the corresponding value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2340

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2341

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2342

"a_key": "A String", # The name of the private property and the corresponding value.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2343

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2344

},

2345

"summary": "A String", # Title of the event.

2346

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2347

"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.

2348

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2349

"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.

2350

},

2351

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2352

# - "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.

2353

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2354

"location": "A String", # Geographic location of the event as free-form text. Optional.

2355

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2356

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2357

# - "public" - The event is public and event details are visible to all readers of the calendar.

2358

# - "private" - The event is private and only event attendees may view event details.

2359

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2360

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2361

"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.

2362

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2363

"displayName": "A String", # The organizer's name, if available.

2364

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2365

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2366

},

2367

"creator": { # The creator of the event. Read-only.

2368

"email": "A String", # The creator's email address, if available.

2369

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2370

"displayName": "A String", # The creator's name, if available.

2371

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2372

},

2373

"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.

2374

"A String",

2375

],

2376

"sequence": 42, # Sequence number as per iCalendar.

2377

"description": "A String", # Description of the event. Can contain HTML. Optional.

2378

"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.

2379

# 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.

2380

"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.

2381

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2386

<code class="details" id="patch">patch(calendarId, eventId, body=None, maxAttendees=None, conferenceDataVersion=None, alwaysIncludeEmail=None, sendUpdates=None, sendNotifications=None, supportsAttachments=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

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2396

"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.

2397

{

2398

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2399

"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.

2400

# Required when adding an attendee.

2401

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2402

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2403

"responseStatus": "A String", # The attendee's response status. Possible values are:

2404

# - "needsAction" - The attendee has not responded to the invitation.

2405

# - "declined" - The attendee has declined the invitation.

2406

# - "tentative" - The attendee has tentatively accepted the invitation.

2407

# - "accepted" - The attendee has accepted the invitation.

2408

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2409

"displayName": "A String", # The attendee's name, if available. Optional.

2410

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2411

"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.

2412

"comment": "A String", # The attendee's response comment. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2413

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2414

],

2415

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2416

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2417

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2418

# There can be at most 25 attachments per event,

2419

{

2420

"fileId": "A String", # ID of the attached file. Read-only.

2421

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2422

"fileUrl": "A String", # URL link to the attachment.

2423

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2424

# Required when adding an attachment.

2425

"title": "A String", # Attachment title.

2426

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2427

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2428

},

2429

],

2430

"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.

2431

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2432

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2433

"etag": "A String", # ETag of the resource.

2434

"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:

2435

# - 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

2436

# - the length of the ID must be between 5 and 1024 characters

2437

# - 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.

2438

# If you do not specify an ID, it will be automatically generated by the server.

2439

# 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.

2440

"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.

2441

"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.

2442

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2443

"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.

2444

},

2445

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2446

"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.

2447

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2448

"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.

2449

},

2450

"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.

2451

"status": "A String", # Status of the event. Optional. Possible values are:

2452

# - "confirmed" - The event is confirmed. This is the default status.

2453

# - "tentative" - The event is tentatively confirmed.

2454

# - "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.

2455

# A cancelled status represents two different states depending on the event type:

2456

# - 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.

2457

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2458

# - 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.

2459

# 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.

2460

# 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.

2461

"kind": "calendar#event", # Type of the resource ("calendar#event").

2462

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2463

"reminders": { # Information about the event's reminders for the authenticated user.

2464

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2465

"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.

2466

{

2467

"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).

2468

# Required when adding a reminder.

2469

"method": "A String", # The method used by this reminder. Possible values are:

2470

# - "email" - Reminders are sent via email.

2471

# - "popup" - Reminders are sent via a UI popup.

2472

# Required when adding a reminder.

},

],

},

"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.

2477

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2478

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2479

},

2480

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2481

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2482

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2483

"title": "A String", # The gadget's title. Deprecated.

2484

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2485

# - "icon" - The gadget displays next to the event's title in the calendar view.

2486

# - "chip" - The gadget displays when the event is clicked.

2487

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2488

"preferences": { # Preferences.

2489

"a_key": "A String", # The preference name and corresponding value.

2490

},

2491

"type": "A String", # The gadget's type. Deprecated.

2492

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2493

},

2494

"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.

2495

"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.

2496

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2497

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2498

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2499

"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.

2500

"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.

2501

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2502

"status": { # The status of the conference create request.

2503

"statusCode": "A String", # The current status of the conference create request. Read-only.

2504

# The possible values are:

2505

# - "pending": the conference create request is still being processed.

2506

# - "success": the conference create request succeeded, the entry points are populated.

2507

# - "failure": the conference create request failed, there are no entry points.

2508

},

2509

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2510

"type": "A String", # The conference solution type.

2511

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2512

# The possible values are:

2513

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2514

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2515

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2516

# - "addOn" for 3P conference providers

2517

},

2518

"requestId": "A String", # The client-generated unique ID for this request.

2519

# 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.

2520

},

2521

"signature": "A String", # The signature of the conference data.

2522

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2523

# Unset for a conference with a failed create request.

2524

# Optional for a conference with a pending create request.

2525

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2526

# All of them must belong to the same conference.

2527

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2528

{

2529

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2530

# Calendar backend will populate this field only for EntryPointType.PHONE.

2531

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2532

# Format:

2533

# - for video, http: or https: schema is required.

2534

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2535

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2536

# - for more, http: or https: schema is required.

2537

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2538

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2539

# Optional.

2540

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2541

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2542

# Optional.

2543

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2544

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2545

"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.

2546

"A String",

2547

],

2548

"entryPointType": "A String", # The type of the conference entry point.

2549

# Possible values are:

2550

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2551

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2552

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2553

# - "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.

2554

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2555

# Examples:

2556

# - for video: meet.google.com/aaa-bbbb-ccc

2557

# - for phone: +1 123 268 2601

2558

# - for sip: 12345678@altostrat.com

2559

# - for more: should not be filled

2560

# Optional.

2561

"meetingCode": "A String", # The meeting code 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

"password": "A String", # The password 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.

# Optional.

},

],

"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.

2570

"conferenceId": "A String", # The ID of the conference.

2571

# Can be used by developers to keep track of conferences, should not be displayed to users.

2572

# Values for solution types:

2573

# - "eventHangout": unset.

2574

# - "eventNamedHangout": the name of the Hangout.

2575

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2576

# - "addOn": defined by 3P conference provider. Optional.

2577

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2578

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2585

# Unset for a conference with a failed create request.

2586

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2587

"iconUri": "A String", # The user-visible icon for this solution.

2588

"key": { # The key which can uniquely identify the conference solution for this event.

2589

"type": "A String", # The conference solution type.

2590

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2591

# The possible values are:

2592

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2593

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2594

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2595

# - "addOn" for 3P conference providers

2596

},

2597

"name": "A String", # The user-visible name of this solution. Not localized.

2598

},

2599

},

2600

"extendedProperties": { # Extended properties of the event.

2601

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2602

"a_key": "A String", # The name of the shared property and the corresponding value.

2603

},

2604

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2605

"a_key": "A String", # The name of the private property and the corresponding value.

2606

},

2607

},

2608

"summary": "A String", # Title of the event.

2609

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2610

"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.

2611

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2612

"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.

2613

},

2614

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2615

# - "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.

2616

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2617

"location": "A String", # Geographic location of the event as free-form text. Optional.

2618

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2619

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2620

# - "public" - The event is public and event details are visible to all readers of the calendar.

2621

# - "private" - The event is private and only event attendees may view event details.

2622

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2623

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2624

"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.

2625

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2626

"displayName": "A String", # The organizer's name, if available.

2627

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2628

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2629

},

2630

"creator": { # The creator of the event. Read-only.

2631

"email": "A String", # The creator's email address, if available.

2632

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2633

"displayName": "A String", # The creator's name, if available.

2634

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2635

},

2636

"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.

2637

"A String",

2638

],

2639

"sequence": 42, # Sequence number as per iCalendar.

2640

"description": "A String", # Description of the event. Can contain HTML. Optional.

2641

"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.

2642

# 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.

2643

"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.

2644

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2645

}

2646

2647

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

2648

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

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

2650

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

2651

Allowed values

2652

all - Notifications are sent to all guests.

2653

externalOnly - Notifications are sent to non-Google Calendar guests only.

2654

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

2655

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2656

2657

Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.

2658

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

2659

2660

Returns:

2661

An object of the form:

2662

2663

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2664

"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.

2665

{

2666

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2667

"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.

2668

# Required when adding an attendee.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2669

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2670

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2671

"responseStatus": "A String", # The attendee's response status. Possible values are:

2672

# - "needsAction" - The attendee has not responded to the invitation.

2673

# - "declined" - The attendee has declined the invitation.

2674

# - "tentative" - The attendee has tentatively accepted the invitation.

2675

# - "accepted" - The attendee has accepted the invitation.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2676

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2677

"displayName": "A String", # The attendee's name, if available. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2678

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2679

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2680

"comment": "A String", # The attendee's response comment. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2681

},

2682

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2683

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2684

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2685

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2686

# There can be at most 25 attachments per event,

2687

{

2688

"fileId": "A String", # ID of the attached file. Read-only.

2689

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2690

"fileUrl": "A String", # URL link to the attachment.

2691

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2692

# Required when adding an attachment.

2693

"title": "A String", # Attachment title.

2694

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2695

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2696

},

2697

],

2698

"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.

2699

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2700

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2701

"etag": "A String", # ETag of the resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2702

"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:

2703

# - 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

2704

# - the length of the ID must be between 5 and 1024 characters

2705

# - 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.

2706

# If you do not specify an ID, it will be automatically generated by the server.

2707

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2708

"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.

2709

"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.

2710

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2711

"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-11-16 11:05:03 -0700

[diff] [blame]

2712

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2713

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2714

"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.

2715

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2716

"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.

2717

},

2718

"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.

2719

"status": "A String", # Status of the event. Optional. Possible values are:

2720

# - "confirmed" - The event is confirmed. This is the default status.

2721

# - "tentative" - The event is tentatively confirmed.

2722

# - "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.

2723

# A cancelled status represents two different states depending on the event type:

2724

# - 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.

2725

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2726

# - 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.

2727

# 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.

2728

# 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.

2729

"kind": "calendar#event", # Type of the resource ("calendar#event").

2730

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2731

"reminders": { # Information about the event's reminders for the authenticated user.

2732

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2733

"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.

2734

{

2735

"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).

2736

# Required when adding a reminder.

2737

"method": "A String", # The method used by this reminder. Possible values are:

2738

# - "email" - Reminders are sent via email.

2739

# - "popup" - Reminders are sent via a UI popup.

2740

# Required when adding a reminder.

},

],

},

"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.

2745

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2746

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2747

},

2748

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2749

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2750

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2751

"title": "A String", # The gadget's title. Deprecated.

2752

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2753

# - "icon" - The gadget displays next to the event's title in the calendar view.

2754

# - "chip" - The gadget displays when the event is clicked.

2755

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2756

"preferences": { # Preferences.

2757

"a_key": "A String", # The preference name and corresponding value.

2758

},

2759

"type": "A String", # The gadget's type. Deprecated.

2760

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2761

},

2762

"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.

2763

"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.

2764

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2765

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2766

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2767

"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.

2768

"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.

2769

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2770

"status": { # The status of the conference create request.

2771

"statusCode": "A String", # The current status of the conference create request. Read-only.

2772

# The possible values are:

2773

# - "pending": the conference create request is still being processed.

2774

# - "success": the conference create request succeeded, the entry points are populated.

2775

# - "failure": the conference create request failed, there are no entry points.

2776

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2777

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2778

"type": "A String", # The conference solution type.

2779

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2780

# The possible values are:

2781

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2782

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2783

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2784

# - "addOn" for 3P conference providers

2785

},

2786

"requestId": "A String", # The client-generated unique ID for this request.

2787

# 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2788

},

2789

"signature": "A String", # The signature of the conference data.

2790

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2791

# Unset for a conference with a failed create request.

2792

# Optional for a conference with a pending create request.

2793

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2794

# All of them must belong to the same conference.

2795

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2796

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2797

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2798

# Calendar backend will populate this field only for EntryPointType.PHONE.

2799

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2800

# Format:

2801

# - for video, http: or https: schema is required.

2802

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2803

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2804

# - for more, http: or https: schema is required.

2805

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2806

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2807

# Optional.

2808

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2809

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2810

# Optional.

2811

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2812

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2813

"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.

2814

"A String",

2815

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2816

"entryPointType": "A String", # The type of the conference entry point.

2817

# Possible values are:

2818

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2819

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2820

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2821

# - "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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2822

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2823

# Examples:

2824

# - for video: meet.google.com/aaa-bbbb-ccc

2825

# - for phone: +1 123 268 2601

2826

# - for sip: 12345678@altostrat.com

2827

# - for more: should not be filled

2828

# Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2829

"meetingCode": "A String", # The meeting code 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2832

"password": "A String", # The password 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2835

},

2836

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2837

"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.

2838

"conferenceId": "A String", # The ID of the conference.

2839

# Can be used by developers to keep track of conferences, should not be displayed to users.

2840

# Values for solution types:

2841

# - "eventHangout": unset.

2842

# - "eventNamedHangout": the name of the Hangout.

2843

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2844

# - "addOn": defined by 3P conference provider. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2845

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2846

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2852

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2853

# Unset for a conference with a failed create request.

2854

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2855

"iconUri": "A String", # The user-visible icon for this solution.

2856

"key": { # The key which can uniquely identify the conference solution for this event.

2857

"type": "A String", # The conference solution type.

2858

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2859

# The possible values are:

2860

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2861

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2862

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2863

# - "addOn" for 3P conference providers

2864

},

2865

"name": "A String", # The user-visible name of this solution. Not localized.

2866

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2867

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2868

"extendedProperties": { # Extended properties of the event.

2869

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2870

"a_key": "A String", # The name of the shared property and the corresponding value.

2871

},

2872

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2873

"a_key": "A String", # The name of the private property and the corresponding value.

2874

},

2875

},

2876

"summary": "A String", # Title of the event.

2877

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2878

"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-11-16 11:05:03 -0700

[diff] [blame]

2879

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2880

"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-11-16 11:05:03 -0700

[diff] [blame]

2881

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2882

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2883

# - "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.

2884

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2885

"location": "A String", # Geographic location of the event as free-form text. Optional.

2886

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2887

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2888

# - "public" - The event is public and event details are visible to all readers of the calendar.

2889

# - "private" - The event is private and only event attendees may view event details.

2890

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2891

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2892

"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.

2893

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2894

"displayName": "A String", # The organizer's name, if available.

2895

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2896

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2897

},

2898

"creator": { # The creator of the event. Read-only.

2899

"email": "A String", # The creator's email address, if available.

2900

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2901

"displayName": "A String", # The creator's name, if available.

2902

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2903

},

2904

"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.

2905

"A String",

2906

],

2907

"sequence": 42, # Sequence number as per iCalendar.

2908

"description": "A String", # Description of the event. Can contain HTML. Optional.

2909

"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.

2910

# 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.

2911

"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.

2912

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

}</pre>

</div>

<code class="details" id="quickAdd">quickAdd(calendarId, text, sendUpdates=None, sendNotifications=None)</code>

2918

<pre>Creates an event based on a simple text string.

2919

2920

Args:

2921

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

2922

text: string, The text describing the event to be created. (required)

2923

sendUpdates: string, Guests who should receive notifications about the creation of the new event.

2924

Allowed values

2925

all - Notifications are sent to all guests.

2926

externalOnly - Notifications are sent to non-Google Calendar guests only.

2927

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

2928

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2929

2930

Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.

2931

2932

Returns:

2933

An object of the form:

2934

2935

{

2936

"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.

2937

{

2938

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2939

"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.

2940

# Required when adding an attendee.

2941

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2942

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2943

"responseStatus": "A String", # The attendee's response status. Possible values are:

2944

# - "needsAction" - The attendee has not responded to the invitation.

2945

# - "declined" - The attendee has declined the invitation.

2946

# - "tentative" - The attendee has tentatively accepted the invitation.

2947

# - "accepted" - The attendee has accepted the invitation.

2948

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2949

"displayName": "A String", # The attendee's name, if available. Optional.

2950

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2951

"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.

2952

"comment": "A String", # The attendee's response comment. Optional.

2953

},

2954

],

2955

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2956

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2957

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2958

# There can be at most 25 attachments per event,

2959

{

2960

"fileId": "A String", # ID of the attached file. Read-only.

2961

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2962

"fileUrl": "A String", # URL link to the attachment.

2963

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2964

# Required when adding an attachment.

2965

"title": "A String", # Attachment title.

2966

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2967

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2968

},

2969

],

2970

"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.

2971

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2972

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2973

"etag": "A String", # ETag of the resource.

2974

"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:

2975

# - 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

2976

# - the length of the ID must be between 5 and 1024 characters

2977

# - 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.

2978

# If you do not specify an ID, it will be automatically generated by the server.

2979

# 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.

2980

"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.

2981

"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.

2982

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2983

"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.

2984

},

2985

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2986

"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.

2987

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2988

"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.

2989

},

2990

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2991

"status": "A String", # Status of the event. Optional. Possible values are:

2992

# - "confirmed" - The event is confirmed. This is the default status.

2993

# - "tentative" - The event is tentatively confirmed.

2994

# - "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.

2995

# A cancelled status represents two different states depending on the event type:

2996

# - 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.

2997

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2998

# - 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.

2999

# 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.

3000

# If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3001

"kind": "calendar#event", # Type of the resource ("calendar#event").

3002

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3003

"reminders": { # Information about the event's reminders for the authenticated user.

3004

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3005

"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.

3006

{

3007

"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).

3008

# Required when adding a reminder.

3009

"method": "A String", # The method used by this reminder. Possible values are:

3010

# - "email" - Reminders are sent via email.

3011

# - "popup" - Reminders are sent via a UI popup.

3012

# Required when adding a reminder.

},

],

},

"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.

3017

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3018

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3019

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3020

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3021

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3022

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3023

"title": "A String", # The gadget's title. Deprecated.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3024

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3025

# - "icon" - The gadget displays next to the event's title in the calendar view.

3026

# - "chip" - The gadget displays when the event is clicked.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3027

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3028

"preferences": { # Preferences.

3029

"a_key": "A String", # The preference name and corresponding value.

3030

},

3031

"type": "A String", # The gadget's type. Deprecated.

3032

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3033

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3034

"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.

3035

"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.

3036

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3037

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3038

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3039

"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.

3040

"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.

3041

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3042

"status": { # The status of the conference create request.

3043

"statusCode": "A String", # The current status of the conference create request. Read-only.

3044

# The possible values are:

3045

# - "pending": the conference create request is still being processed.

3046

# - "success": the conference create request succeeded, the entry points are populated.

3047

# - "failure": the conference create request failed, there are no entry points.

3048

},

3049

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3050

"type": "A String", # The conference solution type.

3051

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3052

# The possible values are:

3053

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3054

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3055

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3056

# - "addOn" for 3P conference providers

3057

},

3058

"requestId": "A String", # The client-generated unique ID for this request.

3059

# 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.

3060

},

3061

"signature": "A String", # The signature of the conference data.

3062

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3063

# Unset for a conference with a failed create request.

3064

# Optional for a conference with a pending create request.

3065

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3066

# All of them must belong to the same conference.

3067

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3068

{

3069

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3070

# Calendar backend will populate this field only for EntryPointType.PHONE.

3071

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3072

# Format:

3073

# - for video, http: or https: schema is required.

3074

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3075

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3076

# - for more, http: or https: schema is required.

3077

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3078

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3079

# Optional.

3080

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3081

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3082

# Optional.

3083

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3084

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3085

"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.

3086

"A String",

3087

],

3088

"entryPointType": "A String", # The type of the conference entry point.

3089

# Possible values are:

3090

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3091

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3092

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3093

# - "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.

3094

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3095

# Examples:

3096

# - for video: meet.google.com/aaa-bbbb-ccc

3097

# - for phone: +1 123 268 2601

3098

# - for sip: 12345678@altostrat.com

3099

# - for more: should not be filled

3100

# Optional.

3101

"meetingCode": "A String", # The meeting code 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

"password": "A String", # The password 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.

# Optional.

},

],

"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.

3110

"conferenceId": "A String", # The ID of the conference.

3111

# Can be used by developers to keep track of conferences, should not be displayed to users.

3112

# Values for solution types:

3113

# - "eventHangout": unset.

3114

# - "eventNamedHangout": the name of the Hangout.

3115

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3116

# - "addOn": defined by 3P conference provider. Optional.

3117

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3118

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3125

# Unset for a conference with a failed create request.

3126

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3127

"iconUri": "A String", # The user-visible icon for this solution.

3128

"key": { # The key which can uniquely identify the conference solution for this event.

3129

"type": "A String", # The conference solution type.

3130

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3131

# The possible values are:

3132

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3133

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3134

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3135

# - "addOn" for 3P conference providers

3136

},

3137

"name": "A String", # The user-visible name of this solution. Not localized.

3138

},

3139

},

3140

"extendedProperties": { # Extended properties of the event.

3141

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3142

"a_key": "A String", # The name of the shared property and the corresponding value.

3143

},

3144

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3145

"a_key": "A String", # The name of the private property and the corresponding value.

3146

},

3147

},

3148

"summary": "A String", # Title of the event.

3149

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3150

"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.

3151

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3152

"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.

3153

},

3154

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3155

# - "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.

3156

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3157

"location": "A String", # Geographic location of the event as free-form text. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3158

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3159

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3160

# - "public" - The event is public and event details are visible to all readers of the calendar.

3161

# - "private" - The event is private and only event attendees may view event details.

3162

# - "confidential" - The event is private. This value is provided for compatibility reasons.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3163

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3164

"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.

3165

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3166

"displayName": "A String", # The organizer's name, if available.

3167

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3168

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3169

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3170

"creator": { # The creator of the event. Read-only.

3171

"email": "A String", # The creator's email address, if available.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3172

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3173

"displayName": "A String", # The creator's name, if available.

3174

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3175

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3176

"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.

3177

"A String",

3178

],

3179

"sequence": 42, # Sequence number as per iCalendar.

3180

"description": "A String", # Description of the event. Can contain HTML. Optional.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3181

"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.

3182

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3183

"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.

3184

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3185

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3189

<code class="details" id="update">update(calendarId, eventId, body=None, conferenceDataVersion=None, supportsAttachments=None, maxAttendees=None, sendUpdates=None, alwaysIncludeEmail=None, sendNotifications=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

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3199

"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.

3200

{

3201

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3202

"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.

3203

# Required when adding an attendee.

3204

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3205

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3206

"responseStatus": "A String", # The attendee's response status. Possible values are:

3207

# - "needsAction" - The attendee has not responded to the invitation.

3208

# - "declined" - The attendee has declined the invitation.

3209

# - "tentative" - The attendee has tentatively accepted the invitation.

3210

# - "accepted" - The attendee has accepted the invitation.

3211

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3212

"displayName": "A String", # The attendee's name, if available. Optional.

3213

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3214

"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.

3215

"comment": "A String", # The attendee's response comment. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3216

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3217

],

3218

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3219

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3220

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3221

# There can be at most 25 attachments per event,

3222

{

3223

"fileId": "A String", # ID of the attached file. Read-only.

3224

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3225

"fileUrl": "A String", # URL link to the attachment.

3226

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3227

# Required when adding an attachment.

3228

"title": "A String", # Attachment title.

3229

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3230

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3231

},

3232

],

3233

"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.

3234

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3235

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3236

"etag": "A String", # ETag of the resource.

3237

"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:

3238

# - 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

3239

# - the length of the ID must be between 5 and 1024 characters

3240

# - 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.

3241

# If you do not specify an ID, it will be automatically generated by the server.

3242

# 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.

3243

"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.

3244

"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.

3245

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3246

"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.

3247

},

3248

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3249

"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.

3250

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3251

"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.

3252

},

3253

"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.

3254

"status": "A String", # Status of the event. Optional. Possible values are:

3255

# - "confirmed" - The event is confirmed. This is the default status.

3256

# - "tentative" - The event is tentatively confirmed.

3257

# - "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.

3258

# A cancelled status represents two different states depending on the event type:

3259

# - 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.

3260

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3261

# - 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.

3262

# 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.

3263

# 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.

3264

"kind": "calendar#event", # Type of the resource ("calendar#event").

3265

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3266

"reminders": { # Information about the event's reminders for the authenticated user.

3267

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3268

"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.

3269

{

3270

"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).

3271

# Required when adding a reminder.

3272

"method": "A String", # The method used by this reminder. Possible values are:

3273

# - "email" - Reminders are sent via email.

3274

# - "popup" - Reminders are sent via a UI popup.

3275

# Required when adding a reminder.

},

],

},

"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.

3280

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3281

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3282

},

3283

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3284

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3285

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3286

"title": "A String", # The gadget's title. Deprecated.

3287

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3288

# - "icon" - The gadget displays next to the event's title in the calendar view.

3289

# - "chip" - The gadget displays when the event is clicked.

3290

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3291

"preferences": { # Preferences.

3292

"a_key": "A String", # The preference name and corresponding value.

3293

},

3294

"type": "A String", # The gadget's type. Deprecated.

3295

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3296

},

3297

"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.

3298

"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.

3299

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3300

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3301

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3302

"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.

3303

"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.

3304

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3305

"status": { # The status of the conference create request.

3306

"statusCode": "A String", # The current status of the conference create request. Read-only.

3307

# The possible values are:

3308

# - "pending": the conference create request is still being processed.

3309

# - "success": the conference create request succeeded, the entry points are populated.

3310

# - "failure": the conference create request failed, there are no entry points.

3311

},

3312

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3313

"type": "A String", # The conference solution type.

3314

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3315

# The possible values are:

3316

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3317

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3318

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3319

# - "addOn" for 3P conference providers

3320

},

3321

"requestId": "A String", # The client-generated unique ID for this request.

3322

# 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.

3323

},

3324

"signature": "A String", # The signature of the conference data.

3325

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3326

# Unset for a conference with a failed create request.

3327

# Optional for a conference with a pending create request.

3328

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3329

# All of them must belong to the same conference.

3330

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3331

{

3332

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3333

# Calendar backend will populate this field only for EntryPointType.PHONE.

3334

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3335

# Format:

3336

# - for video, http: or https: schema is required.

3337

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3338

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3339

# - for more, http: or https: schema is required.

3340

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3341

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3342

# Optional.

3343

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3344

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3345

# Optional.

3346

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3347

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3348

"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.

3349

"A String",

3350

],

3351

"entryPointType": "A String", # The type of the conference entry point.

3352

# Possible values are:

3353

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3354

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3355

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3356

# - "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.

3357

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3358

# Examples:

3359

# - for video: meet.google.com/aaa-bbbb-ccc

3360

# - for phone: +1 123 268 2601

3361

# - for sip: 12345678@altostrat.com

3362

# - for more: should not be filled

3363

# Optional.

3364

"meetingCode": "A String", # The meeting code 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

"password": "A String", # The password 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.

# Optional.

},

],

"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.

3373

"conferenceId": "A String", # The ID of the conference.

3374

# Can be used by developers to keep track of conferences, should not be displayed to users.

3375

# Values for solution types:

3376

# - "eventHangout": unset.

3377

# - "eventNamedHangout": the name of the Hangout.

3378

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3379

# - "addOn": defined by 3P conference provider. Optional.

3380

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3381

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3388

# Unset for a conference with a failed create request.

3389

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3390

"iconUri": "A String", # The user-visible icon for this solution.

3391

"key": { # The key which can uniquely identify the conference solution for this event.

3392

"type": "A String", # The conference solution type.

3393

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3394

# The possible values are:

3395

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3396

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3397

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3398

# - "addOn" for 3P conference providers

3399

},

3400

"name": "A String", # The user-visible name of this solution. Not localized.

3401

},

3402

},

3403

"extendedProperties": { # Extended properties of the event.

3404

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3405

"a_key": "A String", # The name of the shared property and the corresponding value.

3406

},

3407

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3408

"a_key": "A String", # The name of the private property and the corresponding value.

3409

},

3410

},

3411

"summary": "A String", # Title of the event.

3412

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3413

"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.

3414

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3415

"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.

3416

},

3417

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3418

# - "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.

3419

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3420

"location": "A String", # Geographic location of the event as free-form text. Optional.

3421

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3422

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3423

# - "public" - The event is public and event details are visible to all readers of the calendar.

3424

# - "private" - The event is private and only event attendees may view event details.

3425

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3426

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3427

"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.

3428

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3429

"displayName": "A String", # The organizer's name, if available.

3430

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3431

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3432

},

3433

"creator": { # The creator of the event. Read-only.

3434

"email": "A String", # The creator's email address, if available.

3435

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3436

"displayName": "A String", # The creator's name, if available.

3437

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3438

},

3439

"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.

3440

"A String",

3441

],

3442

"sequence": 42, # Sequence number as per iCalendar.

3443

"description": "A String", # Description of the event. Can contain HTML. Optional.

3444

"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.

3445

# 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.

3446

"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.

3447

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

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

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

3453

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

3454

Allowed values

3455

all - Notifications are sent to all guests.

3456

externalOnly - Notifications are sent to non-Google Calendar guests only.

3457

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).

3458

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).

3459

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

3460

3461

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.

3462

3463

Returns:

3464

An object of the form:

3465

3466

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3467

"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.

3468

{

3469

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3470

"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.

3471

# Required when adding an attendee.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3472

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3473

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3474

"responseStatus": "A String", # The attendee's response status. Possible values are:

3475

# - "needsAction" - The attendee has not responded to the invitation.

3476

# - "declined" - The attendee has declined the invitation.

3477

# - "tentative" - The attendee has tentatively accepted the invitation.

3478

# - "accepted" - The attendee has accepted the invitation.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3479

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3480

"displayName": "A String", # The attendee's name, if available. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3481

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3482

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3483

"comment": "A String", # The attendee's response comment. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3484

},

3485

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3486

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3487

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3488

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3489

# There can be at most 25 attachments per event,

3490

{

3491

"fileId": "A String", # ID of the attached file. Read-only.

3492

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3493

"fileUrl": "A String", # URL link to the attachment.

3494

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3495

# Required when adding an attachment.

3496

"title": "A String", # Attachment title.

3497

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3498

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3499

},

3500

],

3501

"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.

3502

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3503

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3504

"etag": "A String", # ETag of the resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3505

"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:

3506

# - 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

3507

# - the length of the ID must be between 5 and 1024 characters

3508

# - 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.

3509

# If you do not specify an ID, it will be automatically generated by the server.

3510

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3511

"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.

3512

"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.

3513

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3514

"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-11-16 11:05:03 -0700

[diff] [blame]

3515

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3516

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3517

"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.

3518

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3519

"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.

3520

},

3521

"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.

3522

"status": "A String", # Status of the event. Optional. Possible values are:

3523

# - "confirmed" - The event is confirmed. This is the default status.

3524

# - "tentative" - The event is tentatively confirmed.

3525

# - "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.

3526

# A cancelled status represents two different states depending on the event type:

3527

# - 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.

3528

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3529

# - 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.

3530

# 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.

3531

# 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.

3532

"kind": "calendar#event", # Type of the resource ("calendar#event").

3533

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3534

"reminders": { # Information about the event's reminders for the authenticated user.

3535

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3536

"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.

3537

{

3538

"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).

3539

# Required when adding a reminder.

3540

"method": "A String", # The method used by this reminder. Possible values are:

3541

# - "email" - Reminders are sent via email.

3542

# - "popup" - Reminders are sent via a UI popup.

3543

# Required when adding a reminder.

},

],

},

"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.

3548

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3549

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3550

},

3551

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3552

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3553

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3554

"title": "A String", # The gadget's title. Deprecated.

3555

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3556

# - "icon" - The gadget displays next to the event's title in the calendar view.

3557

# - "chip" - The gadget displays when the event is clicked.

3558

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3559

"preferences": { # Preferences.

3560

"a_key": "A String", # The preference name and corresponding value.

3561

},

3562

"type": "A String", # The gadget's type. Deprecated.

3563

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3564

},

3565

"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.

3566

"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.

3567

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3568

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3569

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3570

"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.

3571

"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.

3572

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3573

"status": { # The status of the conference create request.

3574

"statusCode": "A String", # The current status of the conference create request. Read-only.

3575

# The possible values are:

3576

# - "pending": the conference create request is still being processed.

3577

# - "success": the conference create request succeeded, the entry points are populated.

3578

# - "failure": the conference create request failed, there are no entry points.

3579

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3580

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3581

"type": "A String", # The conference solution type.

3582

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3583

# The possible values are:

3584

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3585

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3586

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3587

# - "addOn" for 3P conference providers

3588

},

3589

"requestId": "A String", # The client-generated unique ID for this request.

3590

# 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3591

},

3592

"signature": "A String", # The signature of the conference data.

3593

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3594

# Unset for a conference with a failed create request.

3595

# Optional for a conference with a pending create request.

3596

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3597

# All of them must belong to the same conference.

3598

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3599

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3600

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3601

# Calendar backend will populate this field only for EntryPointType.PHONE.

3602

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3603

# Format:

3604

# - for video, http: or https: schema is required.

3605

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3606

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3607

# - for more, http: or https: schema is required.

3608

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3609

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3610

# Optional.

3611

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3612

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3613

# Optional.

3614

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3615

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3616

"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.

3617

"A String",

3618

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3619

"entryPointType": "A String", # The type of the conference entry point.

3620

# Possible values are:

3621

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3622

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3623

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3624

# - "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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3625

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3626

# Examples:

3627

# - for video: meet.google.com/aaa-bbbb-ccc

3628

# - for phone: +1 123 268 2601

3629

# - for sip: 12345678@altostrat.com

3630

# - for more: should not be filled

3631

# Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3632

"meetingCode": "A String", # The meeting code 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3635

"password": "A String", # The password 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3638

},

3639

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3640

"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.

3641

"conferenceId": "A String", # The ID of the conference.

3642

# Can be used by developers to keep track of conferences, should not be displayed to users.

3643

# Values for solution types:

3644

# - "eventHangout": unset.

3645

# - "eventNamedHangout": the name of the Hangout.

3646

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3647

# - "addOn": defined by 3P conference provider. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3648

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3649

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3655

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3656

# Unset for a conference with a failed create request.

3657

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3658

"iconUri": "A String", # The user-visible icon for this solution.

3659

"key": { # The key which can uniquely identify the conference solution for this event.

3660

"type": "A String", # The conference solution type.

3661

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3662

# The possible values are:

3663

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3664

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3665

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3666

# - "addOn" for 3P conference providers

3667

},

3668

"name": "A String", # The user-visible name of this solution. Not localized.

3669

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3670

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3671

"extendedProperties": { # Extended properties of the event.

3672

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3673

"a_key": "A String", # The name of the shared property and the corresponding value.

3674

},

3675

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3676

"a_key": "A String", # The name of the private property and the corresponding value.

3677

},

3678

},

3679

"summary": "A String", # Title of the event.

3680

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3681

"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-11-16 11:05:03 -0700

[diff] [blame]

3682

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3683

"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-11-16 11:05:03 -0700

[diff] [blame]

3684

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3685

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3686

# - "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.

3687

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3688

"location": "A String", # Geographic location of the event as free-form text. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3689

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3690

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3691

# - "public" - The event is public and event details are visible to all readers of the calendar.

3692

# - "private" - The event is private and only event attendees may view event details.

3693

# - "confidential" - The event is private. This value is provided for compatibility reasons.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3694

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3695

"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.

3696

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3697

"displayName": "A String", # The organizer's name, if available.

3698

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3699

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3700

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3701

"creator": { # The creator of the event. Read-only.

3702

"email": "A String", # The creator's email address, if available.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3703

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3704

"displayName": "A String", # The creator's name, if available.

3705

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3706

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3707

"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.

3708

"A String",

3709

],

3710

"sequence": 42, # Sequence number as per iCalendar.

3711

"description": "A String", # Description of the event. Can contain HTML. Optional.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3712

"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.

3713

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3714

"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.

3715

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3716

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3720

<code class="details" id="watch">watch(calendarId, body=None, timeMax=None, q=None, iCalUID=None, singleEvents=None, pageToken=None, timeZone=None, timeMin=None, maxAttendees=None, sharedExtendedProperty=None, maxResults=None, privateExtendedProperty=None, alwaysIncludeEmail=None, syncToken=None, showDeleted=None, orderBy=None, showHiddenInvitations=None, updatedMin=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

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3729

"resourceUri": "A String", # A version-specific identifier for the watched resource.

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

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3734

"id": "A String", # A UUID or similar unique string that identifies this channel.

3735

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3736

"params": { # Additional parameters controlling delivery channel behavior. Optional.

3737

"a_key": "A String", # Declares a new parameter by name.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3738

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3739

"type": "A String", # The type of delivery mechanism used for this channel.

3740

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3741

}

3742

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3743

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.

3744

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]

3745

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3746

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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3747

pageToken: string, Token specifying which result page to return. Optional.

3748

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

3749

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.

3750

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.

3751

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)

3752

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.

3753

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)

3754

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

3755

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.

3756

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

3762

- q

3763

- sharedExtendedProperty

3764

- timeMin

3765

- timeMax

3766

- 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.

3767

Learn more about incremental synchronization.

3768

Optional. The default is to return all entries.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3769

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3770

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

3771

Allowed values

3772

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

3773

updated - Order by last modification time (ascending).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

3774

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3775

updatedMin: string, Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

John Asmuth