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

2021-01-15 07:10:04 -0800

[diff] [blame]

93

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

2021-01-15 07:10:04 -0800

[diff] [blame]

99

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

105

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

John Asmuth

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

[diff] [blame]

106

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

107

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

108

<code><a href="#patch">patch(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=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-12-09 08:56:03 -0800

[diff] [blame]

111

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

John Asmuth

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

[diff] [blame]

112

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

113

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

114

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

2021-01-15 07:10:04 -0800

[diff] [blame]

117

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

3e17f89

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

[diff] [blame]

121

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

122

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

139

none - No notifications are sent. For calendar migration tasks, consider using the Events.import method instead.

John Asmuth

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

[diff] [blame]

</pre>

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

144

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

150

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

151

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

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

152

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

John Asmuth

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

[diff] [blame]

153

154

Returns:

155

An object of the form:

156

157

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

158

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

159

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

160

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

161

# There can be at most 25 attachments per event,

162

{

163

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

164

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

165

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

166

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

167

# Required when adding an attachment.

168

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

169

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

170

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

171

},

172

],

173

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

174

{

175

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

176

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

177

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

178

"email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.

179

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

180

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

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

190

},

191

],

192

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

193

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

194

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

195

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

196

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

197

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

198

# - eventHangout: ID is not set. (This conference type is deprecated.)

199

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

200

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

201

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

202

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

203

# Unset for a conference with a failed create request.

204

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

205

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

206

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

207

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

208

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

209

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

210

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

211

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

212

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

213

# - "addOn" for 3P conference providers

Yoshi Automation Bot

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

[diff] [blame]

214

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

215

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

216

},

217

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

218

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

219

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

220

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

221

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

222

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

223

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

224

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

225

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

226

# - "addOn" for 3P conference providers

227

},

228

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

229

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

230

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

231

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

232

# The possible values are:

233

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

234

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

235

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

236

},

237

},

238

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

239

# All of them must belong to the same conference.

240

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

241

{

242

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

243

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

244

# Optional.

245

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

246

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

247

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

248

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

249

# Possible values are:

250

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

251

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

252

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

253

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

254

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

255

# Examples:

256

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

257

# - for phone: +1 123 268 2601

258

# - for sip: 12345678@altostrat.com

259

# - for more: should not be filled

260

# Optional.

261

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

262

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

263

# Optional.

264

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

265

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

266

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

267

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

268

# Optional.

269

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

270

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

271

# Optional.

272

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

273

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

274

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

275

# Format:

276

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

277

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

278

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

279

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

280

},

281

],

282

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

283

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

284

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

285

"parameters": {

286

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

287

},

288

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

289

},

290

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

291

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

292

# Unset for a conference with a failed create request.

293

# Optional for a conference with a pending create request.

294

},

295

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

296

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

297

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

298

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

299

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

300

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

301

},

302

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

303

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

304

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

305

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

306

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

307

},

308

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

309

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

310

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

311

# - "default" - A regular event or not further specified.

312

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

313

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

314

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

315

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

316

},

317

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

318

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

319

},

320

},

321

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

322

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

323

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

324

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

325

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

326

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

327

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

328

"preferences": { # Preferences.

329

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

330

},

331

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

332

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

333

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

334

},

335

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

336

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

337

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

338

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

354

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

355

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

356

},

357

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

358

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

359

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

360

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

361

},

362

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

363

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

364

"A String",

365

],

366

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

367

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

368

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

369

{

370

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

371

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

372

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

373

# Required when adding a reminder.

374

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

375

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

376

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

377

],

378

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

379

},

380

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

381

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

382

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

383

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

384

},

385

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

386

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

387

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

388

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

389

},

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

414

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

415

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

416

417

Args:

Bu Sun Kim

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

[diff] [blame]

418

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]

419

body: object, The request body.

John Asmuth

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

[diff] [blame]

420

The object takes the form of:

421

422

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

423

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

424

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

425

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

426

# There can be at most 25 attachments per event,

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

427

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

428

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

429

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

430

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

431

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

432

# Required when adding an attachment.

433

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

434

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

435

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

Yoshi Automation Bot

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

[diff] [blame]

436

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

437

],

438

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

439

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

440

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

441

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

442

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

443

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

444

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

445

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

},

456

],

457

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

458

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

459

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

460

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

461

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

462

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

463

# - eventHangout: ID is not set. (This conference type is deprecated.)

464

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

465

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

466

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

467

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

468

# Unset for a conference with a failed create request.

469

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

470

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

471

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

472

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

473

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

474

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

475

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

476

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

477

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

478

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

479

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

480

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

481

},

482

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

483

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

484

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

485

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

486

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

487

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

488

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

489

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

490

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

491

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

492

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

493

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

494

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

495

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

496

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

497

# The possible values are:

498

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

499

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

500

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

501

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

502

},

503

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

504

# All of them must belong to the same conference.

505

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

506

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

507

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

508

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

509

# Optional.

510

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

511

"A String",

512

],

513

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

514

# Possible values are:

515

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

516

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

517

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

518

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

519

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

520

# Examples:

521

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

522

# - for phone: +1 123 268 2601

523

# - for sip: 12345678@altostrat.com

524

# - for more: should not be filled

525

# Optional.

526

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

527

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

528

# Optional.

529

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

530

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

531

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

532

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

533

# Optional.

534

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

535

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

536

# Optional.

537

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

538

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

539

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

540

# Format:

541

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

542

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

543

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

544

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

545

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

546

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

547

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

548

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

549

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

"parameters": {

"a_key": "A String",

},

},

},

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

556

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

557

# Unset for a conference with a failed create request.

558

# Optional for a conference with a pending create request.

559

},

560

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

561

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

562

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

563

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

564

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

565

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

566

},

567

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

568

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

569

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

570

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

571

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

572

},

573

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

574

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

575

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

576

# - "default" - A regular event or not further specified.

577

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

578

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

579

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

580

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

581

},

582

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

583

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

584

},

585

},

586

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

587

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

588

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

589

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

590

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

591

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

592

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

593

"preferences": { # Preferences.

594

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

595

},

596

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

597

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

598

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

599

},

600

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

601

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

602

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

603

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

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

618

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

619

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

620

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

621

},

622

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

623

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

624

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

625

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

626

},

627

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

628

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

629

"A String",

630

],

631

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

632

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

633

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

Yoshi Automation Bot

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

[diff] [blame]

634

{

Yoshi Automation Bot

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

[diff] [blame]

635

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

636

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

637

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

638

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

639

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

640

# Required when adding a reminder.

Yoshi Automation Bot

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

[diff] [blame]

641

},

642

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

643

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

644

},

645

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

646

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

647

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

648

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

649

},

650

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

651

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

652

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

653

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

654

},

655

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

656

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

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

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

674

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

675

}

676

677

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.

678

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

679

680

Returns:

681

An object of the form:

682

683

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

684

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

685

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

686

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

687

# There can be at most 25 attachments per event,

688

{

689

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

690

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

691

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

692

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

693

# Required when adding an attachment.

694

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

695

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

696

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

697

},

698

],

699

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

700

{

701

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

702

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

703

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

704

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

705

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

706

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

707

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

708

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

709

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

710

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

711

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

712

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

713

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

714

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

715

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

716

},

717

],

718

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

719

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

720

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

721

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

722

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

723

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

724

# - eventHangout: ID is not set. (This conference type is deprecated.)

725

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

726

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

727

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

728

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

729

# Unset for a conference with a failed create request.

730

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

731

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

732

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

733

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

734

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

735

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

736

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

737

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

738

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

739

# - "addOn" for 3P conference providers

740

},

741

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

742

},

743

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

744

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

745

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

746

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

747

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

748

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

749

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

750

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

751

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

752

# - "addOn" for 3P conference providers

753

},

754

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

755

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

756

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

757

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

758

# The possible values are:

759

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

760

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

761

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

762

},

763

},

764

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

765

# All of them must belong to the same conference.

766

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

767

{

768

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

769

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

770

# Optional.

771

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

772

"A String",

773

],

774

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

775

# Possible values are:

776

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

777

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

778

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

779

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

780

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

781

# Examples:

782

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

783

# - for phone: +1 123 268 2601

784

# - for sip: 12345678@altostrat.com

785

# - for more: should not be filled

786

# Optional.

787

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

788

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

789

# Optional.

790

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

791

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

792

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

793

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

794

# Optional.

795

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

796

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

797

# Optional.

798

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

799

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

800

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

801

# Format:

802

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

803

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

804

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

805

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

806

},

807

],

808

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

809

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

810

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

"parameters": {

"a_key": "A String",

},

},

},

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

817

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

818

# Unset for a conference with a failed create request.

819

# Optional for a conference with a pending create request.

820

},

821

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

822

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

823

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

824

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

825

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

826

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

827

},

828

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

829

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

830

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

831

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

832

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

833

},

834

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

835

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

836

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

837

# - "default" - A regular event or not further specified.

838

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

839

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

840

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

841

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

842

},

843

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

844

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

845

},

846

},

847

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

848

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

849

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

850

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

851

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

852

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

853

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

854

"preferences": { # Preferences.

855

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

856

},

857

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

858

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

859

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

860

},

861

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

862

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

863

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

864

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

865

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

866

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

867

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

868

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

869

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

870

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

871

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

872

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

873

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

874

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

875

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

876

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

877

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

878

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

879

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

880

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

881

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

882

},

883

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

884

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

885

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

886

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

887

},

888

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

889

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

890

"A String",

891

],

892

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

893

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

894

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

895

{

896

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

897

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

898

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

899

# Required when adding a reminder.

900

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

901

# Required when adding a reminder.

902

},

903

],

904

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

905

},

906

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

907

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

908

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

909

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

910

},

911

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

912

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

913

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

914

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

915

},

916

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

917

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

918

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

919

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

920

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

921

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

922

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

923

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

924

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

925

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

926

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

927

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

928

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

929

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

930

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

931

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

932

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

933

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

934

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

935

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

}</pre>

</div>

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

941

<pre>Creates an event.

942

943

Args:

944

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)

945

body: object, The request body.

946

The object takes the form of:

947

948

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

949

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

950

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

951

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

952

# There can be at most 25 attachments per event,

953

{

954

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

955

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

956

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

957

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

958

# Required when adding an attachment.

959

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

960

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

961

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

962

},

963

],

964

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

965

{

966

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

967

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

968

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

969

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

970

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

971

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

972

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

973

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

974

"resource": false, # Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.

975

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

976

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

977

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

978

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

979

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

980

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

981

},

982

],

983

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

984

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

985

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

986

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

987

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

988

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

989

# - eventHangout: ID is not set. (This conference type is deprecated.)

990

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

991

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

992

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

993

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

994

# Unset for a conference with a failed create request.

995

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

996

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

997

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

998

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

999

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

1000

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1001

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1002

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1003

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

1004

# - "addOn" for 3P conference providers

1005

},

1006

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

1007

},

1008

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

1009

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

1010

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

1011

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

1012

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

1013

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1014

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1015

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1016

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

1017

# - "addOn" for 3P conference providers

1018

},

1019

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

1020

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

1021

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

1022

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

1023

# The possible values are:

1024

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

1025

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

1026

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

1027

},

1028

},

1029

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

1030

# All of them must belong to the same conference.

1031

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

1032

{

1033

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

1034

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

1035

# Optional.

1036

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

1037

"A String",

1038

],

1039

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

1040

# Possible values are:

1041

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

1042

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

1043

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

1044

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

1045

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

1046

# Examples:

1047

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

1048

# - for phone: +1 123 268 2601

1049

# - for sip: 12345678@altostrat.com

1050

# - for more: should not be filled

1051

# Optional.

1052

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

1053

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

1054

# Optional.

1055

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

1056

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

1057

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

1058

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

1059

# Optional.

1060

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

1061

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

1062

# Optional.

1063

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

1064

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

1065

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

1066

# Format:

1067

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

1068

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

1069

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

1070

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

1071

},

1072

],

1073

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

1074

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

1075

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

"parameters": {

"a_key": "A String",

},

},

},

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

1082

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

1083

# Unset for a conference with a failed create request.

1084

# Optional for a conference with a pending create request.

1085

},

1086

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

1087

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

1088

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

1089

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1090

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1091

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

1092

},

1093

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

1094

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

1095

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

1096

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

1097

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

1098

},

1099

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

1100

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1101

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

1102

# - "default" - A regular event or not further specified.

1103

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1104

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

1105

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

1106

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

1107

},

1108

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

1109

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

1110

},

1111

},

1112

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

1113

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

1114

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

1115

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

1116

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

1117

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

1118

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

1119

"preferences": { # Preferences.

1120

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

1121

},

1122

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

1123

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

1124

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

1125

},

1126

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

1127

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

1128

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1129

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1130

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

1131

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

1132

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

1133

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

1134

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

1135

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

1136

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

1137

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

1138

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

1139

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

1140

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

1141

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

1142

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

1143

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

1144

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1145

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1146

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

1147

},

1148

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

1149

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

1150

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

1151

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

1152

},

1153

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

1154

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

1155

"A String",

1156

],

1157

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

1158

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

1159

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

1160

{

1161

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

1162

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

1163

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

1164

# Required when adding a reminder.

1165

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

1166

# Required when adding a reminder.

1167

},

1168

],

1169

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

1170

},

1171

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

1172

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

1173

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

1174

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

1175

},

1176

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

1177

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

1178

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

1179

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

1180

},

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

1189

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

1190

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

1191

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

1192

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

1193

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

1194

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

1195

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

1196

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

1197

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

1198

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

1199

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

1200

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

1201

}

1202

1203

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.

1204

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.

1205

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

1206

1207

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.

1208

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.

1209

Allowed values

1210

all - Notifications are sent to all guests.

1211

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1212

none - No notifications are sent. For calendar migration tasks, consider using the Events.import method instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1213

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

1214

1215

Returns:

1216

An object of the form:

1217

1218

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1219

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1220

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

1221

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

1222

# There can be at most 25 attachments per event,

1223

{

1224

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

1225

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

1226

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

1227

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

1228

# Required when adding an attachment.

1229

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

1230

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

1231

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

1232

},

1233

],

1234

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

1235

{

1236

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

1237

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

1238

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

1239

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

1240

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1241

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1242

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

1243

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

1244

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

1245

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

1246

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

1247

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

1248

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

1249

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

1250

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

1251

},

1252

],

1253

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

1254

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

1255

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

1256

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

1257

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

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1258

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1259

# - eventHangout: ID is not set. (This conference type is deprecated.)

1260

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

1261

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

1262

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1263

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1264

# Unset for a conference with a failed create request.

1265

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

1266

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

1267

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

1268

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

1269

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

1270

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1271

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1272

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1273

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

1274

# - "addOn" for 3P conference providers

1275

},

1276

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

1277

},

1278

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

1279

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

1280

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

1281

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

1282

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

1283

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1284

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1285

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1286

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

1287

# - "addOn" for 3P conference providers

1288

},

1289

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

1290

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

1291

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

1292

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

1293

# The possible values are:

1294

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

1295

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

1296

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

1297

},

1298

},

1299

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

1300

# All of them must belong to the same conference.

1301

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

1302

{

1303

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

1304

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

1305

# Optional.

1306

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

1307

"A String",

1308

],

1309

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

1310

# Possible values are:

1311

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

1312

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

1313

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

1314

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

1315

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

1316

# Examples:

1317

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

1318

# - for phone: +1 123 268 2601

1319

# - for sip: 12345678@altostrat.com

1320

# - for more: should not be filled

1321

# Optional.

1322

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

1323

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

1324

# Optional.

1325

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

1326

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

1327

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

1328

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

1329

# Optional.

1330

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

1331

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

1332

# Optional.

1333

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

1334

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

1335

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

1336

# Format:

1337

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

1338

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

1339

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

1340

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

1341

},

1342

],

1343

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

1344

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

1345

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

"parameters": {

"a_key": "A String",

},

},

},

"signature": "A String", # The signature of the conference data.

1352

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1353

# Unset for a conference with a failed create request.

1354

# Optional for a conference with a pending create request.

1355

},

1356

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1357

"creator": { # The creator of the event. Read-only.

1358

"displayName": "A String", # The creator's name, if available.

1359

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1360

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1361

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1362

},

1363

"description": "A String", # Description of the event. Can contain HTML. Optional.

1364

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1365

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1366

"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.

1367

"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.

1368

},

1369

"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.

1370

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1371

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

1372

# - "default" - A regular event or not further specified.

1373

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1374

"extendedProperties": { # Extended properties of the event.

1375

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1376

"a_key": "A String", # The name of the private property and the corresponding value.

1377

},

1378

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1379

"a_key": "A String", # The name of the shared property and the corresponding value.

1380

},

1381

},

1382

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1383

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1384

# - "icon" - The gadget displays next to the event's title in the calendar view.

1385

# - "chip" - The gadget displays when the event is clicked.

1386

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1387

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1388

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1389

"preferences": { # Preferences.

1390

"a_key": "A String", # The preference name and corresponding value.

1391

},

1392

"title": "A String", # The gadget's title. Deprecated.

1393

"type": "A String", # The gadget's type. Deprecated.

1394

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1395

},

1396

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1397

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1398

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1399

"hangoutLink": "A String", # An absolute link to the Google Hangout associated with this event. Read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1400

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1401

"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.

1402

# 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.

1403

"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:

1404

# - 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

1405

# - the length of the ID must be between 5 and 1024 characters

1406

# - 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.

1407

# If you do not specify an ID, it will be automatically generated by the server.

1408

# 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.

1409

"kind": "calendar#event", # Type of the resource ("calendar#event").

1410

"location": "A String", # Geographic location of the event as free-form text. Optional.

1411

"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.

1412

"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.

1413

"displayName": "A String", # The organizer's name, if available.

1414

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1415

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1416

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1417

},

1418

"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.

1419

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1420

"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.

1421

"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.

1422

},

1423

"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.

1424

"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.

1425

"A String",

1426

],

1427

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1428

"reminders": { # Information about the event's reminders for the authenticated user.

1429

"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.

1430

{

1431

"method": "A String", # The method used by this reminder. Possible values are:

1432

# - "email" - Reminders are sent via email.

1433

# - "popup" - Reminders are sent via a UI popup.

1434

# Required when adding a reminder.

1435

"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).

1436

# Required when adding a reminder.

1437

},

1438

],

1439

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1440

},

1441

"sequence": 42, # Sequence number as per iCalendar.

1442

"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.

1443

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1444

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1445

},

1446

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1447

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1448

"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.

1449

"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.

1450

},

1451

"status": "A String", # Status of the event. Optional. Possible values are:

1452

# - "confirmed" - The event is confirmed. This is the default status.

1453

# - "tentative" - The event is tentatively confirmed.

1454

# - "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.

1455

# A cancelled status represents two different states depending on the event type:

1456

# - 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.

1457

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1458

# - 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.

1459

# 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.

1460

# 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.

1461

"summary": "A String", # Title of the event.

1462

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1463

# - "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.

1464

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1465

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1466

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1467

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1468

# - "public" - The event is public and event details are visible to all readers of the calendar.

1469

# - "private" - The event is private and only event attendees may view event details.

1470

# - "confidential" - The event is private. This value is provided for compatibility reasons.

}</pre>

</div>

<code class="details" id="instances">instances(calendarId, eventId, alwaysIncludeEmail=None, maxAttendees=None, maxResults=None, originalStart=None, pageToken=None, showDeleted=None, timeMax=None, timeMin=None, timeZone=None)</code>

1476

<pre>Returns instances of the specified recurring event.

1477

1478

Args:

1479

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)

1480

eventId: string, Recurring event identifier. (required)

1481

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).

1482

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.

1483

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.

1484

originalStart: string, The original start time of the instance in the result. Optional.

1485

pageToken: string, Token specifying which result page to return. Optional.

1486

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.

1487

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.

1488

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.

1489

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

1490

1491

Returns:

1492

An object of the form:

1493

1494

{

1495

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1496

# - "none" - The user has no access.

1497

# - "freeBusyReader" - The user has read access to free/busy information.

1498

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1499

# - "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.

1500

# - "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.

1501

"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).

1502

{

1503

"method": "A String", # The method used by this reminder. Possible values are:

1504

# - "email" - Reminders are sent via email.

1505

# - "popup" - Reminders are sent via a UI popup.

1506

# Required when adding a reminder.

1507

"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).

1508

# Required when adding a reminder.

1509

},

1510

],

1511

"description": "A String", # Description of the calendar. Read-only.

1512

"etag": "A String", # ETag of the collection.

1513

"items": [ # List of events on the calendar.

1514

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1515

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1516

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1517

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1518

# There can be at most 25 attachments per event,

1519

{

1520

"fileId": "A String", # ID of the attached file. Read-only.

1521

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1522

"fileUrl": "A String", # URL link to the attachment.

1523

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1524

# Required when adding an attachment.

1525

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1526

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1527

"title": "A String", # Attachment title.

1528

},

1529

],

1530

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

1531

{

1532

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1533

"comment": "A String", # The attendee's response comment. Optional.

1534

"displayName": "A String", # The attendee's name, if available. Optional.

1535

"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.

1536

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1537

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1538

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1539

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1540

"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.

1541

"responseStatus": "A String", # The attendee's response status. Possible values are:

1542

# - "needsAction" - The attendee has not responded to the invitation.

1543

# - "declined" - The attendee has declined the invitation.

1544

# - "tentative" - The attendee has tentatively accepted the invitation.

1545

# - "accepted" - The attendee has accepted the invitation.

1546

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1547

},

1548

],

1549

"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.

1550

"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.

1551

"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.

1552

"conferenceId": "A String", # The ID of the conference.

1553

# Can be used by developers to keep track of conferences, should not be displayed to users.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1554

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1555

# - eventHangout: ID is not set. (This conference type is deprecated.)

1556

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

1557

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

1558

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1559

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1560

# Unset for a conference with a failed create request.

1561

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1562

"iconUri": "A String", # The user-visible icon for this solution.

1563

"key": { # The key which can uniquely identify the conference solution for this event.

1564

"type": "A String", # The conference solution type.

1565

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1566

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1567

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1568

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1569

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1570

# - "addOn" for 3P conference providers

1571

},

1572

"name": "A String", # The user-visible name of this solution. Not localized.

1573

},

1574

"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.

1575

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1576

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1577

"type": "A String", # The conference solution type.

1578

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1579

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1580

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1581

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1582

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1583

# - "addOn" for 3P conference providers

1584

},

1585

"requestId": "A String", # The client-generated unique ID for this request.

1586

# 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.

1587

"status": { # The status of the conference create request.

1588

"statusCode": "A String", # The current status of the conference create request. Read-only.

1589

# The possible values are:

1590

# - "pending": the conference create request is still being processed.

1591

# - "success": the conference create request succeeded, the entry points are populated.

1592

# - "failure": the conference create request failed, there are no entry points.

1593

},

1594

},

1595

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1596

# All of them must belong to the same conference.

1597

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1598

{

1599

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1600

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1601

# Optional.

1602

"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.

1603

"A String",

1604

],

1605

"entryPointType": "A String", # The type of the conference entry point.

1606

# Possible values are:

1607

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1608

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1609

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1610

# - "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.

1611

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1612

# Examples:

1613

# - for video: meet.google.com/aaa-bbbb-ccc

1614

# - for phone: +1 123 268 2601

1615

# - for sip: 12345678@altostrat.com

1616

# - for more: should not be filled

1617

# Optional.

1618

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1619

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1620

# Optional.

1621

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1622

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1623

"password": "A String", # The password 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

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1630

# Calendar backend will populate this field only for EntryPointType.PHONE.

1631

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1632

# Format:

1633

# - for video, http: or https: schema is required.

1634

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1635

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1636

# - for more, http: or https: schema is required.

1637

},

1638

],

1639

"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.

1640

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1641

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"signature": "A String", # The signature of the conference data.

1648

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1649

# Unset for a conference with a failed create request.

1650

# Optional for a conference with a pending create request.

1651

},

1652

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1653

"creator": { # The creator of the event. Read-only.

1654

"displayName": "A String", # The creator's name, if available.

1655

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1656

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1657

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1658

},

1659

"description": "A String", # Description of the event. Can contain HTML. Optional.

1660

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1661

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1662

"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.

1663

"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.

1664

},

1665

"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.

1666

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1667

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

1668

# - "default" - A regular event or not further specified.

1669

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1670

"extendedProperties": { # Extended properties of the event.

1671

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1672

"a_key": "A String", # The name of the private property and the corresponding value.

1673

},

1674

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1675

"a_key": "A String", # The name of the shared property and the corresponding value.

1676

},

1677

},

1678

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1679

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1680

# - "icon" - The gadget displays next to the event's title in the calendar view.

1681

# - "chip" - The gadget displays when the event is clicked.

1682

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1683

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1684

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1685

"preferences": { # Preferences.

1686

"a_key": "A String", # The preference name and corresponding value.

1687

},

1688

"title": "A String", # The gadget's title. Deprecated.

1689

"type": "A String", # The gadget's type. Deprecated.

1690

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1691

},

1692

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1693

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1694

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1695

"hangoutLink": "A String", # An absolute link to the Google Hangout associated with this event. Read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1696

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1697

"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.

1698

# 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.

1699

"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:

1700

# - 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

1701

# - the length of the ID must be between 5 and 1024 characters

1702

# - 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.

1703

# If you do not specify an ID, it will be automatically generated by the server.

1704

# 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.

1705

"kind": "calendar#event", # Type of the resource ("calendar#event").

1706

"location": "A String", # Geographic location of the event as free-form text. Optional.

1707

"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.

1708

"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.

1709

"displayName": "A String", # The organizer's name, if available.

1710

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1711

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1712

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1713

},

1714

"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.

1715

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1716

"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.

1717

"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.

1718

},

1719

"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.

1720

"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.

1721

"A String",

1722

],

1723

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1724

"reminders": { # Information about the event's reminders for the authenticated user.

1725

"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.

1726

{

1727

"method": "A String", # The method used by this reminder. Possible values are:

1728

# - "email" - Reminders are sent via email.

1729

# - "popup" - Reminders are sent via a UI popup.

1730

# Required when adding a reminder.

1731

"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).

1732

# Required when adding a reminder.

1733

},

1734

],

1735

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1736

},

1737

"sequence": 42, # Sequence number as per iCalendar.

1738

"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.

1739

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1740

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1741

},

1742

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1743

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1744

"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.

1745

"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.

1746

},

1747

"status": "A String", # Status of the event. Optional. Possible values are:

1748

# - "confirmed" - The event is confirmed. This is the default status.

1749

# - "tentative" - The event is tentatively confirmed.

1750

# - "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.

1751

# A cancelled status represents two different states depending on the event type:

1752

# - 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.

1753

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1754

# - 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.

1755

# 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.

1756

# 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.

1757

"summary": "A String", # Title of the event.

1758

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1759

# - "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.

1760

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1761

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1762

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1763

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1764

# - "public" - The event is public and event details are visible to all readers of the calendar.

1765

# - "private" - The event is private and only event attendees may view event details.

1766

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1767

},

1768

],

1769

"kind": "calendar#events", # Type of the collection ("calendar#events").

1770

"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.

1771

"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.

1772

"summary": "A String", # Title of the calendar. Read-only.

1773

"timeZone": "A String", # The time zone of the calendar. Read-only.

1774

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

1775

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

<code class="details" id="instances_next">instances_next(previous_request, previous_response)</code>

1780

<pre>Retrieves the next page of results.

1781

1782

Args:

1783

previous_request: The request for the previous page. (required)

1784

previous_response: The response from the request for the previous page. (required)

1785

1786

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1787

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1788

page. Returns None if there are no more items in the collection.

</pre>

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1793

<code class="details" id="list">list(calendarId, alwaysIncludeEmail=None, iCalUID=None, maxAttendees=None, maxResults=None, orderBy=None, pageToken=None, privateExtendedProperty=None, q=None, sharedExtendedProperty=None, showDeleted=None, showHiddenInvitations=None, singleEvents=None, syncToken=None, timeMax=None, timeMin=None, timeZone=None, updatedMin=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1794

<pre>Returns events on the specified calendar.

1795

1796

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1797

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1798

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-12-09 08:56:03 -0800

[diff] [blame]

1799

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

Yoshi Automation Bot

2021-01-15 07:10:04 -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

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.

1802

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

1803

Allowed values

1804

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

1805

updated - Order by last modification time (ascending).

1806

pageToken: string, Token specifying which result page to return. Optional.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1807

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)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1808

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1809

sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1810

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.

1811

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

1812

singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

1813

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.

1814

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

1820

- q

1821

- sharedExtendedProperty

1822

- timeMin

1823

- timeMax

1824

- 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.

1825

Learn more about incremental synchronization.

1826

Optional. The default is to return all entries.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1827

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.

1828

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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1829

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1830

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

2014-04-24 15:46:26 -0400

[diff] [blame]

1831

1832

Returns:

1833

An object of the form:

1834

1835

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1836

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1837

# - "none" - The user has no access.

1838

# - "freeBusyReader" - The user has read access to free/busy information.

1839

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1840

# - "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.

1841

# - "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.

1842

"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).

1843

{

1844

"method": "A String", # The method used by this reminder. Possible values are:

1845

# - "email" - Reminders are sent via email.

1846

# - "popup" - Reminders are sent via a UI popup.

1847

# Required when adding a reminder.

1848

"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).

1849

# Required when adding a reminder.

1850

},

1851

],

1852

"description": "A String", # Description of the calendar. Read-only.

1853

"etag": "A String", # ETag of the collection.

1854

"items": [ # List of events on the calendar.

1855

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1856

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1857

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1858

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1859

# There can be at most 25 attachments per event,

1860

{

1861

"fileId": "A String", # ID of the attached file. Read-only.

1862

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1863

"fileUrl": "A String", # URL link to the attachment.

1864

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1865

# Required when adding an attachment.

1866

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1867

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1868

"title": "A String", # Attachment title.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1869

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1870

],

1871

"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.

1872

{

1873

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1874

"comment": "A String", # The attendee's response comment. Optional.

1875

"displayName": "A String", # The attendee's name, if available. Optional.

1876

"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.

1877

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1878

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1879

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1880

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1881

"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.

1882

"responseStatus": "A String", # The attendee's response status. Possible values are:

1883

# - "needsAction" - The attendee has not responded to the invitation.

1884

# - "declined" - The attendee has declined the invitation.

1885

# - "tentative" - The attendee has tentatively accepted the invitation.

1886

# - "accepted" - The attendee has accepted the invitation.

1887

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1888

},

1889

],

1890

"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.

1891

"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.

1892

"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.

1893

"conferenceId": "A String", # The ID of the conference.

1894

# Can be used by developers to keep track of conferences, should not be displayed to users.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1895

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1896

# - eventHangout: ID is not set. (This conference type is deprecated.)

1897

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

1898

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

1899

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1900

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1901

# Unset for a conference with a failed create request.

1902

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1903

"iconUri": "A String", # The user-visible icon for this solution.

1904

"key": { # The key which can uniquely identify the conference solution for this event.

1905

"type": "A String", # The conference solution type.

1906

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1907

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1908

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1909

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1910

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1911

# - "addOn" for 3P conference providers

1912

},

1913

"name": "A String", # The user-visible name of this solution. Not localized.

1914

},

1915

"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.

1916

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1917

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1918

"type": "A String", # The conference solution type.

1919

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1920

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

1921

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1922

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1923

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1924

# - "addOn" for 3P conference providers

1925

},

1926

"requestId": "A String", # The client-generated unique ID for this request.

1927

# 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.

1928

"status": { # The status of the conference create request.

1929

"statusCode": "A String", # The current status of the conference create request. Read-only.

1930

# The possible values are:

1931

# - "pending": the conference create request is still being processed.

1932

# - "success": the conference create request succeeded, the entry points are populated.

1933

# - "failure": the conference create request failed, there are no entry points.

1934

},

1935

},

1936

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1937

# All of them must belong to the same conference.

1938

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1939

{

1940

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1941

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1942

# Optional.

1943

"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.

1944

"A String",

1945

],

1946

"entryPointType": "A String", # The type of the conference entry point.

1947

# Possible values are:

1948

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1949

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1950

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1951

# - "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.

1952

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1953

# Examples:

1954

# - for video: meet.google.com/aaa-bbbb-ccc

1955

# - for phone: +1 123 268 2601

1956

# - for sip: 12345678@altostrat.com

1957

# - for more: should not be filled

1958

# Optional.

1959

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1960

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1961

# Optional.

1962

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1963

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1964

"password": "A String", # The password 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

"pin": "A String", # The PIN 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

# Optional.

1970

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1971

# Calendar backend will populate this field only for EntryPointType.PHONE.

1972

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1973

# Format:

1974

# - for video, http: or https: schema is required.

1975

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1976

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1977

# - for more, http: or https: schema is required.

1978

},

1979

],

1980

"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.

1981

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1982

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"signature": "A String", # The signature of the conference data.

1989

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1990

# Unset for a conference with a failed create request.

1991

# Optional for a conference with a pending create request.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1992

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1993

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1994

"creator": { # The creator of the event. Read-only.

1995

"displayName": "A String", # The creator's name, if available.

1996

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1997

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1998

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1999

},

2000

"description": "A String", # Description of the event. Can contain HTML. Optional.

2001

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2002

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2003

"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.

2004

"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.

2005

},

2006

"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.

2007

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2008

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

2009

# - "default" - A regular event or not further specified.

2010

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2011

"extendedProperties": { # Extended properties of the event.

2012

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2013

"a_key": "A String", # The name of the private property and the corresponding value.

2014

},

2015

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2016

"a_key": "A String", # The name of the shared property and the corresponding value.

2017

},

2018

},

2019

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2020

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2021

# - "icon" - The gadget displays next to the event's title in the calendar view.

2022

# - "chip" - The gadget displays when the event is clicked.

2023

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2024

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2025

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2026

"preferences": { # Preferences.

2027

"a_key": "A String", # The preference name and corresponding value.

2028

},

2029

"title": "A String", # The gadget's title. Deprecated.

2030

"type": "A String", # The gadget's type. Deprecated.

2031

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2032

},

2033

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2034

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2035

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2036

"hangoutLink": "A String", # An absolute link to the Google Hangout associated with this event. Read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2037

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2038

"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.

2039

# 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.

2040

"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:

2041

# - 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

2042

# - the length of the ID must be between 5 and 1024 characters

2043

# - 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.

2044

# If you do not specify an ID, it will be automatically generated by the server.

2045

# 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.

2046

"kind": "calendar#event", # Type of the resource ("calendar#event").

2047

"location": "A String", # Geographic location of the event as free-form text. Optional.

2048

"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.

2049

"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.

2050

"displayName": "A String", # The organizer's name, if available.

2051

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2052

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2053

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2054

},

2055

"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.

2056

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2057

"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.

2058

"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.

2059

},

2060

"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.

2061

"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.

2062

"A String",

2063

],

2064

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2065

"reminders": { # Information about the event's reminders for the authenticated user.

2066

"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.

2067

{

2068

"method": "A String", # The method used by this reminder. Possible values are:

2069

# - "email" - Reminders are sent via email.

2070

# - "popup" - Reminders are sent via a UI popup.

2071

# Required when adding a reminder.

2072

"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).

2073

# Required when adding a reminder.

2074

},

2075

],

2076

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2077

},

2078

"sequence": 42, # Sequence number as per iCalendar.

2079

"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.

2080

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2081

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2082

},

2083

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2084

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2085

"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.

2086

"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.

2087

},

2088

"status": "A String", # Status of the event. Optional. Possible values are:

2089

# - "confirmed" - The event is confirmed. This is the default status.

2090

# - "tentative" - The event is tentatively confirmed.

2091

# - "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.

2092

# A cancelled status represents two different states depending on the event type:

2093

# - 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.

2094

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2095

# - 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.

2096

# 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.

2097

# 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.

2098

"summary": "A String", # Title of the event.

2099

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2100

# - "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.

2101

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2102

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2103

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2104

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2105

# - "public" - The event is public and event details are visible to all readers of the calendar.

2106

# - "private" - The event is private and only event attendees may view event details.

2107

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2108

},

2109

],

2110

"kind": "calendar#events", # Type of the collection ("calendar#events").

2111

"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.

2112

"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.

2113

"summary": "A String", # Title of the calendar. Read-only.

2114

"timeZone": "A String", # The time zone of the calendar. Read-only.

2115

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

2116

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2121

<pre>Retrieves the next page of results.

2122

2123

Args:

2124

previous_request: The request for the previous page. (required)

2125

previous_response: The response from the request for the previous page. (required)

2126

2127

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2128

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2129

page. Returns None if there are no more items in the collection.

</pre>

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2134

<code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2135

<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]

2136

2137

Args:

2138

calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)

2139

eventId: string, Event identifier. (required)

2140

destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2141

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2142

2143

Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2144

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]

2145

Allowed values

2146

all - Notifications are sent to all guests.

2147

externalOnly - Notifications are sent to non-Google Calendar guests only.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2148

none - No notifications are sent. For calendar migration tasks, consider using the Events.import method instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2149

2150

Returns:

2151

An object of the form:

2152

2153

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2154

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2155

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2156

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2157

# There can be at most 25 attachments per event,

2158

{

2159

"fileId": "A String", # ID of the attached file. Read-only.

2160

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2161

"fileUrl": "A String", # URL link to the attachment.

2162

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2163

# Required when adding an attachment.

2164

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2165

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2166

"title": "A String", # Attachment title.

2167

},

2168

],

2169

"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.

2170

{

2171

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2172

"comment": "A String", # The attendee's response comment. Optional.

2173

"displayName": "A String", # The attendee's name, if available. Optional.

2174

"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.

2175

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2176

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2177

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2178

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2179

"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.

2180

"responseStatus": "A String", # The attendee's response status. Possible values are:

2181

# - "needsAction" - The attendee has not responded to the invitation.

2182

# - "declined" - The attendee has declined the invitation.

2183

# - "tentative" - The attendee has tentatively accepted the invitation.

2184

# - "accepted" - The attendee has accepted the invitation.

2185

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2186

},

2187

],

2188

"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.

2189

"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.

2190

"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.

2191

"conferenceId": "A String", # The ID of the conference.

2192

# Can be used by developers to keep track of conferences, should not be displayed to users.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2193

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2194

# - eventHangout: ID is not set. (This conference type is deprecated.)

2195

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

2196

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

2197

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2198

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2199

# Unset for a conference with a failed create request.

2200

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2201

"iconUri": "A String", # The user-visible icon for this solution.

2202

"key": { # The key which can uniquely identify the conference solution for this event.

2203

"type": "A String", # The conference solution type.

2204

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2205

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2206

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2207

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2208

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2209

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2210

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2211

"name": "A String", # The user-visible name of this solution. Not localized.

2212

},

2213

"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.

2214

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2215

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2216

"type": "A String", # The conference solution type.

2217

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2218

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2219

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2220

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2221

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2222

# - "addOn" for 3P conference providers

2223

},

2224

"requestId": "A String", # The client-generated unique ID for this request.

2225

# 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.

2226

"status": { # The status of the conference create request.

2227

"statusCode": "A String", # The current status of the conference create request. Read-only.

2228

# The possible values are:

2229

# - "pending": the conference create request is still being processed.

2230

# - "success": the conference create request succeeded, the entry points are populated.

2231

# - "failure": the conference create request failed, there are no entry points.

2232

},

2233

},

2234

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2235

# All of them must belong to the same conference.

2236

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2237

{

2238

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2239

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2240

# Optional.

2241

"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.

2242

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2243

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2244

"entryPointType": "A String", # The type of the conference entry point.

2245

# Possible values are:

2246

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2247

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2248

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2249

# - "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.

2250

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2251

# Examples:

2252

# - for video: meet.google.com/aaa-bbbb-ccc

2253

# - for phone: +1 123 268 2601

2254

# - for sip: 12345678@altostrat.com

2255

# - for more: should not be filled

2256

# Optional.

2257

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2258

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2259

# Optional.

2260

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2261

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2262

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2263

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2264

# Optional.

2265

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2266

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2267

# Optional.

2268

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2269

# Calendar backend will populate this field only for EntryPointType.PHONE.

2270

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2271

# Format:

2272

# - for video, http: or https: schema is required.

2273

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2274

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2275

# - for more, http: or https: schema is required.

2276

},

2277

],

2278

"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.

2279

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2280

"addOnParameters": { # Additional add-on specific data.

2281

"parameters": {

2282

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2283

},

2284

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2285

},

2286

"signature": "A String", # The signature of the conference data.

2287

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2288

# Unset for a conference with a failed create request.

2289

# Optional for a conference with a pending create request.

2290

},

2291

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2292

"creator": { # The creator of the event. Read-only.

2293

"displayName": "A String", # The creator's name, if available.

2294

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2295

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2296

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2297

},

2298

"description": "A String", # Description of the event. Can contain HTML. Optional.

2299

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2300

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2301

"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.

2302

"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.

2303

},

2304

"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.

2305

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2306

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

2307

# - "default" - A regular event or not further specified.

2308

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2309

"extendedProperties": { # Extended properties of the event.

2310

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2311

"a_key": "A String", # The name of the private property and the corresponding value.

2312

},

2313

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2314

"a_key": "A String", # The name of the shared property and the corresponding value.

2315

},

2316

},

2317

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2318

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2319

# - "icon" - The gadget displays next to the event's title in the calendar view.

2320

# - "chip" - The gadget displays when the event is clicked.

2321

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2322

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2323

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2324

"preferences": { # Preferences.

2325

"a_key": "A String", # The preference name and corresponding value.

2326

},

2327

"title": "A String", # The gadget's title. Deprecated.

2328

"type": "A String", # The gadget's type. Deprecated.

2329

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2330

},

2331

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2332

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2333

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2334

"hangoutLink": "A String", # An absolute link to the Google Hangout associated with this event. Read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2335

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2336

"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.

2337

# 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.

2338

"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:

2339

# - 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

2340

# - the length of the ID must be between 5 and 1024 characters

2341

# - 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.

2342

# If you do not specify an ID, it will be automatically generated by the server.

2343

# 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.

2344

"kind": "calendar#event", # Type of the resource ("calendar#event").

2345

"location": "A String", # Geographic location of the event as free-form text. Optional.

2346

"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.

2347

"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.

2348

"displayName": "A String", # The organizer's name, if available.

2349

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2350

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2351

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2352

},

2353

"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.

2354

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2355

"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.

2356

"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.

2357

},

2358

"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.

2359

"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.

2360

"A String",

2361

],

2362

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2363

"reminders": { # Information about the event's reminders for the authenticated user.

2364

"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.

2365

{

2366

"method": "A String", # The method used by this reminder. Possible values are:

2367

# - "email" - Reminders are sent via email.

2368

# - "popup" - Reminders are sent via a UI popup.

2369

# Required when adding a reminder.

2370

"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).

2371

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2372

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2373

],

2374

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2375

},

2376

"sequence": 42, # Sequence number as per iCalendar.

2377

"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.

2378

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2379

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2380

},

2381

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2382

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2383

"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.

2384

"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.

2385

},

2386

"status": "A String", # Status of the event. Optional. Possible values are:

2387

# - "confirmed" - The event is confirmed. This is the default status.

2388

# - "tentative" - The event is tentatively confirmed.

2389

# - "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.

2390

# A cancelled status represents two different states depending on the event type:

2391

# - 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.

2392

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2393

# - 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.

2394

# 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.

2395

# 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.

2396

"summary": "A String", # Title of the event.

2397

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2398

# - "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.

2399

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2400

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2401

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2402

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2403

# - "public" - The event is public and event details are visible to all readers of the calendar.

2404

# - "private" - The event is private and only event attendees may view event details.

2405

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2406

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2407

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2408

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2409

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2410

<code class="details" id="patch">patch(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2411

<pre>Updates an event. This method supports patch semantics.

2412

2413

Args:

2414

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)

2415

eventId: string, Event identifier. (required)

2416

body: object, The request body.

2417

The object takes the form of:

2418

2419

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2420

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2421

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2422

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2423

# There can be at most 25 attachments per event,

2424

{

2425

"fileId": "A String", # ID of the attached file. Read-only.

2426

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2427

"fileUrl": "A String", # URL link to the attachment.

2428

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2429

# Required when adding an attachment.

2430

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2431

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2432

"title": "A String", # Attachment title.

2433

},

2434

],

2435

"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.

2436

{

2437

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2438

"comment": "A String", # The attendee's response comment. Optional.

2439

"displayName": "A String", # The attendee's name, if available. Optional.

2440

"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.

2441

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2442

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2443

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2444

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2445

"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.

2446

"responseStatus": "A String", # The attendee's response status. Possible values are:

2447

# - "needsAction" - The attendee has not responded to the invitation.

2448

# - "declined" - The attendee has declined the invitation.

2449

# - "tentative" - The attendee has tentatively accepted the invitation.

2450

# - "accepted" - The attendee has accepted the invitation.

2451

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2452

},

2453

],

2454

"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.

2455

"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.

2456

"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.

2457

"conferenceId": "A String", # The ID of the conference.

2458

# Can be used by developers to keep track of conferences, should not be displayed to users.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2459

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2460

# - eventHangout: ID is not set. (This conference type is deprecated.)

2461

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

2462

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

2463

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2464

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2465

# Unset for a conference with a failed create request.

2466

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2467

"iconUri": "A String", # The user-visible icon for this solution.

2468

"key": { # The key which can uniquely identify the conference solution for this event.

2469

"type": "A String", # The conference solution type.

2470

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2471

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2472

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2473

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2474

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2475

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2476

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2477

"name": "A String", # The user-visible name of this solution. Not localized.

2478

},

2479

"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.

2480

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2481

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2482

"type": "A String", # The conference solution type.

2483

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2484

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2485

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2486

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2487

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2488

# - "addOn" for 3P conference providers

2489

},

2490

"requestId": "A String", # The client-generated unique ID for this request.

2491

# 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.

2492

"status": { # The status of the conference create request.

2493

"statusCode": "A String", # The current status of the conference create request. Read-only.

2494

# The possible values are:

2495

# - "pending": the conference create request is still being processed.

2496

# - "success": the conference create request succeeded, the entry points are populated.

2497

# - "failure": the conference create request failed, there are no entry points.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2498

},

2499

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2500

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2501

# All of them must belong to the same conference.

2502

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2503

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2504

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2505

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2506

# Optional.

2507

"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.

2508

"A String",

2509

],

2510

"entryPointType": "A String", # The type of the conference entry point.

2511

# Possible values are:

2512

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2513

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2514

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2515

# - "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.

2516

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2517

# Examples:

2518

# - for video: meet.google.com/aaa-bbbb-ccc

2519

# - for phone: +1 123 268 2601

2520

# - for sip: 12345678@altostrat.com

2521

# - for more: should not be filled

2522

# Optional.

2523

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2524

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2525

# Optional.

2526

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2527

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2528

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2529

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2530

# Optional.

2531

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2532

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2533

# Optional.

2534

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2535

# Calendar backend will populate this field only for EntryPointType.PHONE.

2536

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2537

# Format:

2538

# - for video, http: or https: schema is required.

2539

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2540

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2541

# - for more, http: or https: schema is required.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2542

},

2543

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2544

"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.

2545

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2546

"addOnParameters": { # Additional add-on specific data.

2547

"parameters": {

2548

"a_key": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2549

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2550

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2551

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2552

"signature": "A String", # The signature of the conference data.

2553

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2554

# Unset for a conference with a failed create request.

2555

# Optional for a conference with a pending create request.

2556

},

2557

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2558

"creator": { # The creator of the event. Read-only.

2559

"displayName": "A String", # The creator's name, if available.

2560

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2561

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2562

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2563

},

2564

"description": "A String", # Description of the event. Can contain HTML. Optional.

2565

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2566

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2567

"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.

2568

"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.

2569

},

2570

"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.

2571

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2572

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

2573

# - "default" - A regular event or not further specified.

2574

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2575

"extendedProperties": { # Extended properties of the event.

2576

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2577

"a_key": "A String", # The name of the private property and the corresponding value.

2578

},

2579

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2580

"a_key": "A String", # The name of the shared property and the corresponding value.

2581

},

2582

},

2583

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2584

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2585

# - "icon" - The gadget displays next to the event's title in the calendar view.

2586

# - "chip" - The gadget displays when the event is clicked.

2587

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2588

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2589

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2590

"preferences": { # Preferences.

2591

"a_key": "A String", # The preference name and corresponding value.

2592

},

2593

"title": "A String", # The gadget's title. Deprecated.

2594

"type": "A String", # The gadget's type. Deprecated.

2595

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2596

},

2597

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2598

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2599

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2600

"hangoutLink": "A String", # An absolute link to the Google Hangout associated with this event. Read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2601

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2602

"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.

2603

# 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.

2604

"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:

2605

# - 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

2606

# - the length of the ID must be between 5 and 1024 characters

2607

# - 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.

2608

# If you do not specify an ID, it will be automatically generated by the server.

2609

# 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.

2610

"kind": "calendar#event", # Type of the resource ("calendar#event").

2611

"location": "A String", # Geographic location of the event as free-form text. Optional.

2612

"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.

2613

"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.

2614

"displayName": "A String", # The organizer's name, if available.

2615

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2616

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2617

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2618

},

2619

"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.

2620

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2621

"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.

2622

"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.

2623

},

2624

"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.

2625

"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.

2626

"A String",

2627

],

2628

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2629

"reminders": { # Information about the event's reminders for the authenticated user.

2630

"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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2631

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2632

"method": "A String", # The method used by this reminder. Possible values are:

2633

# - "email" - Reminders are sent via email.

2634

# - "popup" - Reminders are sent via a UI popup.

2635

# Required when adding a reminder.

2636

"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).

2637

# Required when adding a reminder.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2638

},

2639

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2640

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2641

},

2642

"sequence": 42, # Sequence number as per iCalendar.

2643

"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.

2644

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2645

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2646

},

2647

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2648

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2649

"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.

2650

"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.

2651

},

2652

"status": "A String", # Status of the event. Optional. Possible values are:

2653

# - "confirmed" - The event is confirmed. This is the default status.

2654

# - "tentative" - The event is tentatively confirmed.

2655

# - "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.

2656

# A cancelled status represents two different states depending on the event type:

2657

# - 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.

2658

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2659

# - 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.

2660

# 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.

2661

# 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.

2662

"summary": "A String", # Title of the event.

2663

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2664

# - "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.

2665

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2666

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2667

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2668

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2669

# - "public" - The event is public and event details are visible to all readers of the calendar.

2670

# - "private" - The event is private and only event attendees may view event details.

2671

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2672

}

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2673

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2674

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

2021-01-15 07:10:04 -0800

[diff] [blame]

2675

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.

2676

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-12-09 08:56:03 -0800

[diff] [blame]

2677

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2678

2679

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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2680

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

2681

Allowed values

2682

all - Notifications are sent to all guests.

2683

externalOnly - Notifications are sent to non-Google Calendar guests only.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2684

none - No notifications are sent. For calendar migration tasks, consider using the Events.import method instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2685

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2686

2687

Returns:

2688

An object of the form:

2689

2690

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2691

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2692

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2693

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2694

# There can be at most 25 attachments per event,

2695

{

2696

"fileId": "A String", # ID of the attached file. Read-only.

2697

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2698

"fileUrl": "A String", # URL link to the attachment.

2699

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2700

# Required when adding an attachment.

2701

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2702

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2703

"title": "A String", # Attachment title.

2704

},

2705

],

2706

"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.

2707

{

2708

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2709

"comment": "A String", # The attendee's response comment. Optional.

2710

"displayName": "A String", # The attendee's name, if available. Optional.

2711

"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.

2712

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2713

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2714

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2715

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2716

"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.

2717

"responseStatus": "A String", # The attendee's response status. Possible values are:

2718

# - "needsAction" - The attendee has not responded to the invitation.

2719

# - "declined" - The attendee has declined the invitation.

2720

# - "tentative" - The attendee has tentatively accepted the invitation.

2721

# - "accepted" - The attendee has accepted the invitation.

2722

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2723

},

2724

],

2725

"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.

2726

"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.

2727

"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.

2728

"conferenceId": "A String", # The ID of the conference.

2729

# Can be used by developers to keep track of conferences, should not be displayed to users.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2730

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2731

# - eventHangout: ID is not set. (This conference type is deprecated.)

2732

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

2733

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

2734

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2735

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2736

# Unset for a conference with a failed create request.

2737

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2738

"iconUri": "A String", # The user-visible icon for this solution.

2739

"key": { # The key which can uniquely identify the conference solution for this event.

2740

"type": "A String", # The conference solution type.

2741

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2742

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2743

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2744

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2745

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2746

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2747

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2748

"name": "A String", # The user-visible name of this solution. Not localized.

2749

},

2750

"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.

2751

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2752

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2753

"type": "A String", # The conference solution type.

2754

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2755

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

2756

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2757

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2758

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2759

# - "addOn" for 3P conference providers

2760

},

2761

"requestId": "A String", # The client-generated unique ID for this request.

2762

# 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.

2763

"status": { # The status of the conference create request.

2764

"statusCode": "A String", # The current status of the conference create request. Read-only.

2765

# The possible values are:

2766

# - "pending": the conference create request is still being processed.

2767

# - "success": the conference create request succeeded, the entry points are populated.

2768

# - "failure": the conference create request failed, there are no entry points.

2769

},

2770

},

2771

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2772

# All of them must belong to the same conference.

2773

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2774

{

2775

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2776

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2777

# Optional.

2778

"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.

2779

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2780

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2781

"entryPointType": "A String", # The type of the conference entry point.

2782

# Possible values are:

2783

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2784

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2785

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2786

# - "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.

2787

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2788

# Examples:

2789

# - for video: meet.google.com/aaa-bbbb-ccc

2790

# - for phone: +1 123 268 2601

2791

# - for sip: 12345678@altostrat.com

2792

# - for more: should not be filled

2793

# Optional.

2794

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2795

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2796

# Optional.

2797

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2798

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2799

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2800

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2801

# Optional.

2802

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2803

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2804

# Optional.

2805

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2806

# Calendar backend will populate this field only for EntryPointType.PHONE.

2807

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2808

# Format:

2809

# - for video, http: or https: schema is required.

2810

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2811

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2812

# - for more, http: or https: schema is required.

2813

},

2814

],

2815

"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.

2816

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2817

"addOnParameters": { # Additional add-on specific data.

2818

"parameters": {

2819

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2820

},

2821

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2822

},

2823

"signature": "A String", # The signature of the conference data.

2824

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2825

# Unset for a conference with a failed create request.

2826

# Optional for a conference with a pending create request.

2827

},

2828

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2829

"creator": { # The creator of the event. Read-only.

2830

"displayName": "A String", # The creator's name, if available.

2831

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2832

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2833

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2834

},

2835

"description": "A String", # Description of the event. Can contain HTML. Optional.

2836

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2837

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2838

"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.

2839

"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.

2840

},

2841

"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.

2842

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2843

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

2844

# - "default" - A regular event or not further specified.

2845

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2846

"extendedProperties": { # Extended properties of the event.

2847

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2848

"a_key": "A String", # The name of the private property and the corresponding value.

2849

},

2850

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2851

"a_key": "A String", # The name of the shared property and the corresponding value.

2852

},

2853

},

2854

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2855

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2856

# - "icon" - The gadget displays next to the event's title in the calendar view.

2857

# - "chip" - The gadget displays when the event is clicked.

2858

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2859

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2860

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2861

"preferences": { # Preferences.

2862

"a_key": "A String", # The preference name and corresponding value.

2863

},

2864

"title": "A String", # The gadget's title. Deprecated.

2865

"type": "A String", # The gadget's type. Deprecated.

2866

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2867

},

2868

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2869

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2870

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2871

"hangoutLink": "A String", # An absolute link to the Google Hangout associated with this event. Read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2872

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2873

"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.

2874

# 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.

2875

"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:

2876

# - 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

2877

# - the length of the ID must be between 5 and 1024 characters

2878

# - 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.

2879

# If you do not specify an ID, it will be automatically generated by the server.

2880

# 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.

2881

"kind": "calendar#event", # Type of the resource ("calendar#event").

2882

"location": "A String", # Geographic location of the event as free-form text. Optional.

2883

"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.

2884

"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

2885

"displayName": "A String", # The organizer's name, if available.

2886

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2887

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2888

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2889

},

2890

"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.

2891

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2892

"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.

2893

"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.

2894

},

2895

"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.

2896

"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.

2897

"A String",

2898

],

2899

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2900

"reminders": { # Information about the event's reminders for the authenticated user.

2901

"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.

2902

{

2903

"method": "A String", # The method used by this reminder. Possible values are:

2904

# - "email" - Reminders are sent via email.

2905

# - "popup" - Reminders are sent via a UI popup.

2906

# Required when adding a reminder.

2907

"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).

2908

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2909

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2910

],

2911

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2912

},

2913

"sequence": 42, # Sequence number as per iCalendar.

2914

"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.

2915

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2916

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2917

},

2918

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2919

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2920

"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.

2921

"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.

2922

},

2923

"status": "A String", # Status of the event. Optional. Possible values are:

2924

# - "confirmed" - The event is confirmed. This is the default status.

2925

# - "tentative" - The event is tentatively confirmed.

2926

# - "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.

2927

# A cancelled status represents two different states depending on the event type:

2928

# - 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.

2929

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2930

# - 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.

2931

# 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.

2932

# 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.

2933

"summary": "A String", # Title of the event.

2934

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2935

# - "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.

2936

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2937

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2938

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2939

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2940

# - "public" - The event is public and event details are visible to all readers of the calendar.

2941

# - "private" - The event is private and only event attendees may view event details.

2942

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2943

}</pre>

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2947

<code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None, sendUpdates=None)</code>

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2948

<pre>Creates an event based on a simple text string.

2949

2950

Args:

2951

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)

2952

text: string, The text describing the event to be created. (required)

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2953

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2954

2955

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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2956

sendUpdates: string, Guests who should receive notifications about the creation of the new event.

2957

Allowed values

2958

all - Notifications are sent to all guests.

2959

externalOnly - Notifications are sent to non-Google Calendar guests only.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2960

none - No notifications are sent. For calendar migration tasks, consider using the Events.import method instead.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2961

2962

Returns:

2963

An object of the form:

2964

2965

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2966

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2967

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2968

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2969

# There can be at most 25 attachments per event,

2970

{

2971

"fileId": "A String", # ID of the attached file. Read-only.

2972

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2973

"fileUrl": "A String", # URL link to the attachment.

2974

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2975

# Required when adding an attachment.

2976

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2977

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2978

"title": "A String", # Attachment title.

2979

},

2980

],

2981

"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.

2982

{

2983

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2984

"comment": "A String", # The attendee's response comment. Optional.

2985

"displayName": "A String", # The attendee's name, if available. Optional.

2986

"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.

2987

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2988

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2989

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2990

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2991

"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.

2992

"responseStatus": "A String", # The attendee's response status. Possible values are:

2993

# - "needsAction" - The attendee has not responded to the invitation.

2994

# - "declined" - The attendee has declined the invitation.

2995

# - "tentative" - The attendee has tentatively accepted the invitation.

2996

# - "accepted" - The attendee has accepted the invitation.

2997

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2998

},

2999

],

3000

"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.

3001

"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.

3002

"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.

3003

"conferenceId": "A String", # The ID of the conference.

3004

# Can be used by developers to keep track of conferences, should not be displayed to users.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3005

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3006

# - eventHangout: ID is not set. (This conference type is deprecated.)

3007

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

3008

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

3009

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3010

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3011

# Unset for a conference with a failed create request.

3012

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3013

"iconUri": "A String", # The user-visible icon for this solution.

3014

"key": { # The key which can uniquely identify the conference solution for this event.

3015

"type": "A String", # The conference solution type.

3016

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3017

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3018

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3019

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3020

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3021

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

3022

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3023

"name": "A String", # The user-visible name of this solution. Not localized.

3024

},

3025

"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.

3026

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3027

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3028

"type": "A String", # The conference solution type.

3029

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3030

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3031

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3032

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3033

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3034

# - "addOn" for 3P conference providers

3035

},

3036

"requestId": "A String", # The client-generated unique ID for this request.

3037

# 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.

3038

"status": { # The status of the conference create request.

3039

"statusCode": "A String", # The current status of the conference create request. Read-only.

3040

# The possible values are:

3041

# - "pending": the conference create request is still being processed.

3042

# - "success": the conference create request succeeded, the entry points are populated.

3043

# - "failure": the conference create request failed, there are no entry points.

3044

},

3045

},

3046

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3047

# All of them must belong to the same conference.

3048

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3049

{

3050

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3051

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3052

# Optional.

3053

"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.

3054

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3055

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3056

"entryPointType": "A String", # The type of the conference entry point.

3057

# Possible values are:

3058

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3059

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3060

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3061

# - "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.

3062

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3063

# Examples:

3064

# - for video: meet.google.com/aaa-bbbb-ccc

3065

# - for phone: +1 123 268 2601

3066

# - for sip: 12345678@altostrat.com

3067

# - for more: should not be filled

3068

# Optional.

3069

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3070

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3071

# Optional.

3072

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3073

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3074

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3075

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3076

# Optional.

3077

"pin": "A String", # The PIN 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

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3081

# Calendar backend will populate this field only for EntryPointType.PHONE.

3082

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3083

# Format:

3084

# - for video, http: or https: schema is required.

3085

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3086

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3087

# - for more, http: or https: schema is required.

3088

},

3089

],

3090

"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.

3091

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3092

"addOnParameters": { # Additional add-on specific data.

3093

"parameters": {

3094

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3095

},

3096

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3097

},

3098

"signature": "A String", # The signature of the conference data.

3099

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3100

# Unset for a conference with a failed create request.

3101

# Optional for a conference with a pending create request.

3102

},

3103

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3104

"creator": { # The creator of the event. Read-only.

3105

"displayName": "A String", # The creator's name, if available.

3106

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3107

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3108

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3109

},

3110

"description": "A String", # Description of the event. Can contain HTML. Optional.

3111

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3112

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3113

"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.

3114

"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.

3115

},

3116

"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.

3117

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3118

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

3119

# - "default" - A regular event or not further specified.

3120

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3121

"extendedProperties": { # Extended properties of the event.

3122

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3123

"a_key": "A String", # The name of the private property and the corresponding value.

3124

},

3125

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3126

"a_key": "A String", # The name of the shared property and the corresponding value.

3127

},

3128

},

3129

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3130

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3131

# - "icon" - The gadget displays next to the event's title in the calendar view.

3132

# - "chip" - The gadget displays when the event is clicked.

3133

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3134

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3135

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3136

"preferences": { # Preferences.

3137

"a_key": "A String", # The preference name and corresponding value.

3138

},

3139

"title": "A String", # The gadget's title. Deprecated.

3140

"type": "A String", # The gadget's type. Deprecated.

3141

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3142

},

3143

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3144

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3145

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3146

"hangoutLink": "A String", # An absolute link to the Google Hangout associated with this event. Read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3147

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3148

"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.

3149

# 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.

3150

"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:

3151

# - 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

3152

# - the length of the ID must be between 5 and 1024 characters

3153

# - 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.

3154

# If you do not specify an ID, it will be automatically generated by the server.

3155

# 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.

3156

"kind": "calendar#event", # Type of the resource ("calendar#event").

3157

"location": "A String", # Geographic location of the event as free-form text. Optional.

3158

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.

3159

"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.

3160

"displayName": "A String", # The organizer's name, if available.

3161

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3162

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3163

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3164

},

3165

"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.

3166

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3167

"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.

3168

"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.

3169

},

3170

"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.

3171

"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.

3172

"A String",

3173

],

3174

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3175

"reminders": { # Information about the event's reminders for the authenticated user.

3176

"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.

3177

{

3178

"method": "A String", # The method used by this reminder. Possible values are:

3179

# - "email" - Reminders are sent via email.

3180

# - "popup" - Reminders are sent via a UI popup.

3181

# Required when adding a reminder.

3182

"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).

3183

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3184

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3185

],

3186

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3187

},

3188

"sequence": 42, # Sequence number as per iCalendar.

3189

"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.

3190

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3191

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3192

},

3193

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3194

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3195

"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.

3196

"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.

3197

},

3198

"status": "A String", # Status of the event. Optional. Possible values are:

3199

# - "confirmed" - The event is confirmed. This is the default status.

3200

# - "tentative" - The event is tentatively confirmed.

3201

# - "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.

3202

# A cancelled status represents two different states depending on the event type:

3203

# - 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.

3204

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3205

# - 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.

3206

# 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.

3207

# 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.

3208

"summary": "A String", # Title of the event.

3209

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3210

# - "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.

3211

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3212

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3213

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3214

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3215

# - "public" - The event is public and event details are visible to all readers of the calendar.

3216

# - "private" - The event is private and only event attendees may view event details.

3217

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3218

}</pre>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3222

<code class="details" id="update">update(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3223

<pre>Updates an event.

3224

3225

Args:

3226

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)

3227

eventId: string, Event identifier. (required)

3228

body: object, The request body.

3229

The object takes the form of:

3230

3231

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3232

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3233

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3234

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3235

# There can be at most 25 attachments per event,

3236

{

3237

"fileId": "A String", # ID of the attached file. Read-only.

3238

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3239

"fileUrl": "A String", # URL link to the attachment.

3240

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3241

# Required when adding an attachment.

3242

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3243

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3244

"title": "A String", # Attachment title.

3245

},

3246

],

3247

"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.

3248

{

3249

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3250

"comment": "A String", # The attendee's response comment. Optional.

3251

"displayName": "A String", # The attendee's name, if available. Optional.

3252

"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.

3253

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3254

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3255

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3256

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3257

"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.

3258

"responseStatus": "A String", # The attendee's response status. Possible values are:

3259

# - "needsAction" - The attendee has not responded to the invitation.

3260

# - "declined" - The attendee has declined the invitation.

3261

# - "tentative" - The attendee has tentatively accepted the invitation.

3262

# - "accepted" - The attendee has accepted the invitation.

3263

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3264

},

3265

],

3266

"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.

3267

"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.

3268

"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.

3269

"conferenceId": "A String", # The ID of the conference.

3270

# Can be used by developers to keep track of conferences, should not be displayed to users.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3271

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3272

# - eventHangout: ID is not set. (This conference type is deprecated.)

3273

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

3274

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

3275

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3276

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3277

# Unset for a conference with a failed create request.

3278

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3279

"iconUri": "A String", # The user-visible icon for this solution.

3280

"key": { # The key which can uniquely identify the conference solution for this event.

3281

"type": "A String", # The conference solution type.

3282

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3283

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3284

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3285

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3286

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3287

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3288

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3289

"name": "A String", # The user-visible name of this solution. Not localized.

3290

},

3291

"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.

3292

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3293

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3294

"type": "A String", # The conference solution type.

3295

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3296

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3297

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3298

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3299

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3300

# - "addOn" for 3P conference providers

3301

},

3302

"requestId": "A String", # The client-generated unique ID for this request.

3303

# 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.

3304

"status": { # The status of the conference create request.

3305

"statusCode": "A String", # The current status of the conference create request. Read-only.

3306

# The possible values are:

3307

# - "pending": the conference create request is still being processed.

3308

# - "success": the conference create request succeeded, the entry points are populated.

3309

# - "failure": the conference create request failed, there are no entry points.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3310

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

3311

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3312

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3313

# All of them must belong to the same conference.

3314

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3315

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3316

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3317

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3318

# Optional.

3319

"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.

3320

"A String",

3321

],

3322

"entryPointType": "A String", # The type of the conference entry point.

3323

# Possible values are:

3324

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3325

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3326

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3327

# - "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.

3328

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3329

# Examples:

3330

# - for video: meet.google.com/aaa-bbbb-ccc

3331

# - for phone: +1 123 268 2601

3332

# - for sip: 12345678@altostrat.com

3333

# - for more: should not be filled

3334

# Optional.

3335

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3336

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3337

# Optional.

3338

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3339

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3340

"password": "A String", # The password 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

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3347

# Calendar backend will populate this field only for EntryPointType.PHONE.

3348

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3349

# Format:

3350

# - for video, http: or https: schema is required.

3351

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3352

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3353

# - for more, http: or https: schema is required.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3354

},

3355

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3356

"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.

3357

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3358

"addOnParameters": { # Additional add-on specific data.

3359

"parameters": {

3360

"a_key": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3361

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3362

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3363

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3364

"signature": "A String", # The signature of the conference data.

3365

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3366

# Unset for a conference with a failed create request.

3367

# Optional for a conference with a pending create request.

3368

},

3369

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3370

"creator": { # The creator of the event. Read-only.

3371

"displayName": "A String", # The creator's name, if available.

3372

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3373

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3374

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3375

},

3376

"description": "A String", # Description of the event. Can contain HTML. Optional.

3377

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3378

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3379

"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.

3380

"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.

3381

},

3382

"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.

3383

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3384

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

3385

# - "default" - A regular event or not further specified.

3386

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3387

"extendedProperties": { # Extended properties of the event.

3388

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3389

"a_key": "A String", # The name of the private property and the corresponding value.

3390

},

3391

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3392

"a_key": "A String", # The name of the shared property and the corresponding value.

3393

},

3394

},

3395

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3396

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3397

# - "icon" - The gadget displays next to the event's title in the calendar view.

3398

# - "chip" - The gadget displays when the event is clicked.

3399

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3400

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3401

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3402

"preferences": { # Preferences.

3403

"a_key": "A String", # The preference name and corresponding value.

3404

},

3405

"title": "A String", # The gadget's title. Deprecated.

3406

"type": "A String", # The gadget's type. Deprecated.

3407

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3408

},

3409

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3410

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3411

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3412

"hangoutLink": "A String", # An absolute link to the Google Hangout associated with this event. Read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3413

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3414

"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.

3415

# 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.

3416

"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:

3417

# - 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

3418

# - the length of the ID must be between 5 and 1024 characters

3419

# - 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.

3420

# If you do not specify an ID, it will be automatically generated by the server.

3421

# 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.

3422

"kind": "calendar#event", # Type of the resource ("calendar#event").

3423

"location": "A String", # Geographic location of the event as free-form text. Optional.

3424

"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.

3425

"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.

3426

"displayName": "A String", # The organizer's name, if available.

3427

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3428

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3429

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3430

},

3431

"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.

3432

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3433

"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.

3434

"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.

3435

},

3436

"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.

3437

"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.

3438

"A String",

3439

],

3440

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3441

"reminders": { # Information about the event's reminders for the authenticated user.

3442

"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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3443

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3444

"method": "A String", # The method used by this reminder. Possible values are:

3445

# - "email" - Reminders are sent via email.

3446

# - "popup" - Reminders are sent via a UI popup.

3447

# Required when adding a reminder.

3448

"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).

3449

# Required when adding a reminder.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3450

},

3451

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3452

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3453

},

3454

"sequence": 42, # Sequence number as per iCalendar.

3455

"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.

3456

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3457

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3458

},

3459

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3460

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3461

"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.

3462

"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.

3463

},

3464

"status": "A String", # Status of the event. Optional. Possible values are:

3465

# - "confirmed" - The event is confirmed. This is the default status.

3466

# - "tentative" - The event is tentatively confirmed.

3467

# - "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.

3468

# A cancelled status represents two different states depending on the event type:

3469

# - 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.

3470

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3471

# - 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.

3472

# 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.

3473

# 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.

3474

"summary": "A String", # Title of the event.

3475

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3476

# - "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.

3477

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3478

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3479

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3480

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3481

# - "public" - The event is public and event details are visible to all readers of the calendar.

3482

# - "private" - The event is private and only event attendees may view event details.

3483

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3484

}

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3485

3486

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

2021-01-15 07:10:04 -0800

[diff] [blame]

3487

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.

3488

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-12-09 08:56:03 -0800

[diff] [blame]

3489

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

3490

3491

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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3492

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

3493

Allowed values

3494

all - Notifications are sent to all guests.

3495

externalOnly - Notifications are sent to non-Google Calendar guests only.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

3496

none - No notifications are sent. For calendar migration tasks, consider using the Events.import method instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3497

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3498

3499

Returns:

3500

An object of the form:

3501

3502

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3503

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3504

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3505

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3506

# There can be at most 25 attachments per event,

3507

{

3508

"fileId": "A String", # ID of the attached file. Read-only.

3509

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3510

"fileUrl": "A String", # URL link to the attachment.

3511

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3512

# Required when adding an attachment.

3513

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3514

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3515

"title": "A String", # Attachment title.

3516

},

3517

],

3518

"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.

3519

{

3520

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3521

"comment": "A String", # The attendee's response comment. Optional.

3522

"displayName": "A String", # The attendee's name, if available. Optional.

3523

"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.

3524

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3525

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3526

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3527

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3528

"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.

3529

"responseStatus": "A String", # The attendee's response status. Possible values are:

3530

# - "needsAction" - The attendee has not responded to the invitation.

3531

# - "declined" - The attendee has declined the invitation.

3532

# - "tentative" - The attendee has tentatively accepted the invitation.

3533

# - "accepted" - The attendee has accepted the invitation.

3534

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3535

},

3536

],

3537

"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.

3538

"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.

3539

"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.

3540

"conferenceId": "A String", # The ID of the conference.

3541

# Can be used by developers to keep track of conferences, should not be displayed to users.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3542

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3543

# - eventHangout: ID is not set. (This conference type is deprecated.)

3544

# - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)

yoshi-code-bot

2021-05-04 06:46:03 -0700

[diff] [blame]

3545

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

3546

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3547

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3548

# Unset for a conference with a failed create request.

3549

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3550

"iconUri": "A String", # The user-visible icon for this solution.

3551

"key": { # The key which can uniquely identify the conference solution for this event.

3552

"type": "A String", # The conference solution type.

3553

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3554

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3555

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3556

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3557

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3558

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3559

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3560

"name": "A String", # The user-visible name of this solution. Not localized.

3561

},

3562

"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.

3563

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3564

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3565

"type": "A String", # The conference solution type.

3566

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3567

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame^]

3568

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3569

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3570

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3571

# - "addOn" for 3P conference providers

3572

},

3573

"requestId": "A String", # The client-generated unique ID for this request.

3574

# 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.

3575

"status": { # The status of the conference create request.

3576

"statusCode": "A String", # The current status of the conference create request. Read-only.

3577

# The possible values are:

3578

# - "pending": the conference create request is still being processed.

3579

# - "success": the conference create request succeeded, the entry points are populated.

3580

# - "failure": the conference create request failed, there are no entry points.

3581

},

3582

},

3583

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3584

# All of them must belong to the same conference.

3585

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3586

{

3587

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3588

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3589

# Optional.

3590

"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.

3591

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3592

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3593

"entryPointType": "A String", # The type of the conference entry point.

3594

# Possible values are:

3595

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3596

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3597

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3598

# - "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.

3599

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3600

# Examples:

3601

# - for video: meet.google.com/aaa-bbbb-ccc

3602

# - for phone: +1 123 268 2601

3603

# - for sip: 12345678@altostrat.com

3604

# - for more: should not be filled

3605

# Optional.

3606

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3607

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3608

# Optional.

3609

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3610

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3611

"password": "A String", # The password 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

"pin": "A String", # The PIN 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

# Optional.

3617

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3618

# Calendar backend will populate this field only for EntryPointType.PHONE.

3619

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3620

# Format:

3621

# - for video, http: or https: schema is required.

3622

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3623

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3624

# - for more, http: or https: schema is required.

3625

},

3626

],

3627

"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.

3628

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3629

"addOnParameters": { # Additional add-on specific data.

3630

"parameters": {

3631

"a_key": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3632

},

3633

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3634

},

3635

"signature": "A String", # The signature of the conference data.

3636

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3637

# Unset for a conference with a failed create request.

3638

# Optional for a conference with a pending create request.

3639

},

3640

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3641

"creator": { # The creator of the event. Read-only.

3642

"displayName": "A String", # The creator's name, if available.

3643

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3644

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3645

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3646

},

3647

"description": "A String", # Description of the event. Can contain HTML. Optional.

3648

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3649

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3650

"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.

3651

"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.

3652

},

3653

"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.

3654

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3655

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

3656

# - "default" - A regular event or not further specified.

3657

# - "outOfOffice" - An out-of-office event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3658

"extendedProperties": { # Extended properties of the event.

3659

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3660

"a_key": "A String", # The name of the private property and the corresponding value.

3661

},

3662

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3663

"a_key": "A String", # The name of the shared property and the corresponding value.

3664

},

3665

},

3666

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3667

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3668

# - "icon" - The gadget displays next to the event's title in the calendar view.

3669

# - "chip" - The gadget displays when the event is clicked.

3670

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3671

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3672

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3673

"preferences": { # Preferences.

3674

"a_key": "A String", # The preference name and corresponding value.

3675

},

3676

"title": "A String", # The gadget's title. Deprecated.

3677

"type": "A String", # The gadget's type. Deprecated.

3678

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3679

},

3680

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3681

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3682

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3683

"hangoutLink": "A String", # An absolute link to the Google Hangout associated with this event. Read-only.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3684

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3685

"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.

3686

# 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.

3687

"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:

3688

# - 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

3689

# - the length of the ID must be between 5 and 1024 characters

3690

# - 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.

3691

# If you do not specify an ID, it will be automatically generated by the server.

3692

# 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.

3693

"kind": "calendar#event", # Type of the resource ("calendar#event").

3694

"location": "A String", # Geographic location of the event as free-form text. Optional.

3695

"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.

3696

"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.

3697

"displayName": "A String", # The organizer's name, if available.

3698

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3699

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3700

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3701

},

3702

"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.

3703

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3704

"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.

3705

"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.

3706

},

3707

"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.

3708

"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.

3709

"A String",

3710

],

3711

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3712

"reminders": { # Information about the event's reminders for the authenticated user.

3713

"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.

3714

{

3715

"method": "A String", # The method used by this reminder. Possible values are:

3716

# - "email" - Reminders are sent via email.

3717

# - "popup" - Reminders are sent via a UI popup.

3718

# Required when adding a reminder.

3719

"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).

3720

# Required when adding a reminder.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3721

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3722

],

3723

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3724

},

3725

"sequence": 42, # Sequence number as per iCalendar.

3726

"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.

3727

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3728

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3729

},

3730

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3731

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3732

"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.

3733

"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.

3734

},

3735

"status": "A String", # Status of the event. Optional. Possible values are:

3736

# - "confirmed" - The event is confirmed. This is the default status.

3737

# - "tentative" - The event is tentatively confirmed.

3738

# - "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.

3739

# A cancelled status represents two different states depending on the event type:

3740

# - 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.

3741

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3742

# - 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.

3743

# 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.

3744

# 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.

3745

"summary": "A String", # Title of the event.

3746

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3747

# - "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.

3748

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3749

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3750

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3751

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3752

# - "public" - The event is public and event details are visible to all readers of the calendar.

3753

# - "private" - The event is private and only event attendees may view event details.

3754

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3755

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3759

<code class="details" id="watch">watch(calendarId, alwaysIncludeEmail=None, body=None, iCalUID=None, maxAttendees=None, maxResults=None, orderBy=None, pageToken=None, privateExtendedProperty=None, q=None, sharedExtendedProperty=None, showDeleted=None, showHiddenInvitations=None, singleEvents=None, syncToken=None, timeMax=None, timeMin=None, timeZone=None, updatedMin=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3760

<pre>Watch for changes to Events resources.

3761

3762

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3763

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]

3764

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3765

The object takes the form of:

3766

3767

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3768

"address": "A String", # The address where notifications are delivered for this channel.

3769

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

3770

"id": "A String", # A UUID or similar unique string that identifies this channel.

3771

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

3772

"params": { # Additional parameters controlling delivery channel behavior. Optional.

3773

"a_key": "A String", # Declares a new parameter by name.

3774

},

3775

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

3776

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

3777

"resourceUri": "A String", # A version-specific identifier for the watched resource.

3778

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3779

"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3780

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3781

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3782

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-12-09 08:56:03 -0800

[diff] [blame]

3783

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3784

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.

3785

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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3786

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

3787

Allowed values

3788

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

3789

updated - Order by last modification time (ascending).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3790

pageToken: string, Token specifying which result page to return. Optional.

3791

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)

3792

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3793

sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3794

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.

3795

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

3796

singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

3797

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.

3798

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

3804

- q

3805

- sharedExtendedProperty

3806

- timeMin

3807

- timeMax

3808

- 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.

3809

Learn more about incremental synchronization.

3810

Optional. The default is to return all entries.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3811

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.

3812

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.

3813

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

3814

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

2014-04-24 15:46:26 -0400

[diff] [blame]

3815

3816

Returns:

3817

An object of the form:

3818

3819

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3820

"address": "A String", # The address where notifications are delivered for this channel.

3821

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

3822

"id": "A String", # A UUID or similar unique string that identifies this channel.

3823

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

3824

"params": { # Additional parameters controlling delivery channel behavior. Optional.

3825

"a_key": "A String", # Declares a new parameter by name.

3826

},

3827

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

3828

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

3829

"resourceUri": "A String", # A version-specific identifier for the watched resource.

3830

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3831

"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3832

}</pre>

John Asmuth