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-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

313

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

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

[diff] [blame]

314

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

315

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

316

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

317

},

318

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

319

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

320

},

321

},

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

"preferences": { # Preferences.

330

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

331

},

332

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

333

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

334

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

335

},

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

Yoshi Automation Bot

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

[diff] [blame]

356

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

357

},

358

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

359

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

360

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

361

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

362

},

363

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

364

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

365

"A String",

366

],

367

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

368

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

369

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

370

{

371

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

372

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

373

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

374

# Required when adding a reminder.

375

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

376

# Required when adding a reminder.

Yoshi Automation Bot

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

[diff] [blame]

377

},

Yoshi Automation Bot

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

[diff] [blame]

378

],

379

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

380

},

381

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

382

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

383

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

384

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

385

},

386

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

387

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

388

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

389

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

390

},

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

415

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

416

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

417

418

Args:

Bu Sun Kim

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

[diff] [blame]

419

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]

420

body: object, The request body.

John Asmuth

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

[diff] [blame]

421

The object takes the form of:

422

423

{

yoshi-code-bot

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

[diff] [blame]

424

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

425

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

426

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

427

# There can be at most 25 attachments per event,

Yoshi Automation Bot

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

[diff] [blame]

428

{

Yoshi Automation Bot

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

[diff] [blame]

429

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

430

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

431

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

432

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

433

# Required when adding an attachment.

434

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

435

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

436

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

Yoshi Automation Bot

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

[diff] [blame]

437

},

Yoshi Automation Bot

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

[diff] [blame]

438

],

439

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

440

{

Yoshi Automation Bot

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

[diff] [blame]

441

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

442

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

443

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

444

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

445

# Required when adding an attendee.

yoshi-code-bot

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

[diff] [blame]

446

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

Yoshi Automation Bot

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

[diff] [blame]

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

},

457

],

458

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

459

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

460

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

461

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

462

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

463

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

yoshi-code-bot

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

[diff] [blame]

464

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

465

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

466

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

467

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

yoshi-code-bot

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

[diff] [blame]

468

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

Yoshi Automation Bot

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

[diff] [blame]

469

# Unset for a conference with a failed create request.

470

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

471

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

472

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

473

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

474

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

475

# The possible values are:

yoshi-code-bot

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

[diff] [blame]

476

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

477

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

478

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

479

# - "addOn" for 3P conference providers

Yoshi Automation Bot

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

[diff] [blame]

480

},

Yoshi Automation Bot

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

[diff] [blame]

481

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

482

},

483

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

484

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

485

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

486

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

487

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

488

# The possible values are:

yoshi-code-bot

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

[diff] [blame]

489

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

490

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

491

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

492

# - "addOn" for 3P conference providers

Yoshi Automation Bot

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

[diff] [blame]

493

},

Yoshi Automation Bot

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

[diff] [blame]

494

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

495

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

496

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

497

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

498

# The possible values are:

499

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

500

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

501

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

Yoshi Automation Bot

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

[diff] [blame]

502

},

Yoshi Automation Bot

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

[diff] [blame]

503

},

504

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

505

# All of them must belong to the same conference.

506

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

Yoshi Automation Bot

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

[diff] [blame]

507

{

Yoshi Automation Bot

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

[diff] [blame]

508

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

509

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

510

# Optional.

511

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

512

"A String",

513

],

514

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

515

# Possible values are:

516

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

517

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

518

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

519

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

520

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

521

# Examples:

522

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

523

# - for phone: +1 123 268 2601

524

# - for sip: 12345678@altostrat.com

525

# - for more: should not be filled

526

# Optional.

527

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

528

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

529

# Optional.

530

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

531

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

532

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

533

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

534

# Optional.

535

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

536

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

537

# Optional.

538

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

539

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

540

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

541

# Format:

542

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

543

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

544

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

545

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

546

},

Yoshi Automation Bot

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

[diff] [blame]

547

],

Yoshi Automation Bot

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

[diff] [blame]

548

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

549

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

550

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

"parameters": {

"a_key": "A String",

},

},

},

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

557

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

558

# Unset for a conference with a failed create request.

559

# Optional for a conference with a pending create request.

560

},

561

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

562

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

563

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

564

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

yoshi-code-bot

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

[diff] [blame]

565

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

Yoshi Automation Bot

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

[diff] [blame]

566

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

567

},

568

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

569

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

570

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

571

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

572

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

573

},

574

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

575

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

yoshi-code-bot

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

[diff] [blame]

576

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

577

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

578

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

579

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

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

[diff] [blame]

580

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

581

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

582

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

583

},

584

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

585

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

586

},

587

},

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

"preferences": { # Preferences.

596

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

597

},

598

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

599

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

600

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

601

},

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

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

Yoshi Automation Bot

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

[diff] [blame]

622

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

623

},

624

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

625

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

626

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

627

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

628

},

629

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

630

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

631

"A String",

632

],

633

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

634

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

635

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

636

{

Yoshi Automation Bot

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

[diff] [blame]

637

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

638

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

639

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

640

# Required when adding a reminder.

Yoshi Automation Bot

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

[diff] [blame]

641

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

642

# Required when adding a reminder.

Yoshi Automation Bot

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

[diff] [blame]

643

},

644

],

Yoshi Automation Bot

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

[diff] [blame]

645

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

646

},

647

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

648

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

649

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

650

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

651

},

652

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

653

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

654

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

655

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

656

},

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

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

674

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

675

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

676

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

677

}

678

679

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.

680

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

681

682

Returns:

683

An object of the form:

684

685

{

yoshi-code-bot

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

[diff] [blame]

686

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

687

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

688

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

689

# There can be at most 25 attachments per event,

690

{

691

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

692

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

693

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

694

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

695

# Required when adding an attachment.

696

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

697

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

698

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

699

},

700

],

701

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

702

{

703

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

704

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

705

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

706

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

707

# Required when adding an attendee.

yoshi-code-bot

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

[diff] [blame]

708

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

Yoshi Automation Bot

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

[diff] [blame]

709

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

710

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

711

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

712

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

713

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

714

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

715

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

716

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

717

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

718

},

719

],

720

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

721

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

722

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

723

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

724

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

725

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

yoshi-code-bot

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

[diff] [blame]

726

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

727

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

728

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

729

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

yoshi-code-bot

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

[diff] [blame]

730

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

Yoshi Automation Bot

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

[diff] [blame]

731

# Unset for a conference with a failed create request.

732

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

733

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

734

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

735

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

736

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

737

# The possible values are:

yoshi-code-bot

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

[diff] [blame]

738

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

739

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

740

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

741

# - "addOn" for 3P conference providers

742

},

743

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

744

},

745

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

746

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

747

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

748

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

749

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

750

# The possible values are:

yoshi-code-bot

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

[diff] [blame]

751

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

752

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

753

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

754

# - "addOn" for 3P conference providers

755

},

756

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

757

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

758

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

759

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

760

# The possible values are:

761

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

762

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

763

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

764

},

765

},

766

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

767

# All of them must belong to the same conference.

768

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

769

{

770

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

771

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

772

# Optional.

773

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

774

"A String",

775

],

776

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

777

# Possible values are:

778

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

779

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

780

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

781

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

782

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

783

# Examples:

784

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

785

# - for phone: +1 123 268 2601

786

# - for sip: 12345678@altostrat.com

787

# - for more: should not be filled

788

# Optional.

789

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

790

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

791

# Optional.

792

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

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

795

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

796

# Optional.

797

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

798

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

799

# Optional.

800

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

801

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

802

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

803

# Format:

804

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

805

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

806

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

807

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

808

},

809

],

810

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

811

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

812

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

"parameters": {

"a_key": "A String",

},

},

},

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

819

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

820

# Unset for a conference with a failed create request.

821

# Optional for a conference with a pending create request.

822

},

823

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

824

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

825

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

826

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

yoshi-code-bot

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

[diff] [blame]

827

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

Yoshi Automation Bot

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

[diff] [blame]

828

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

829

},

830

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

831

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

832

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

833

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

834

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

835

},

836

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

837

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

yoshi-code-bot

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

[diff] [blame]

838

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

839

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

840

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

841

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

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

[diff] [blame]

842

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

843

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

844

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

845

},

846

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

847

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

848

},

849

},

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

"preferences": { # Preferences.

858

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

859

},

860

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

861

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

862

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

863

},

864

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

865

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

866

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

867

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

868

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

869

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

870

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

871

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

872

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

873

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

874

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

875

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

876

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

877

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

878

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

879

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

880

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

881

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

882

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

883

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

Yoshi Automation Bot

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

[diff] [blame]

884

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

885

},

886

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

887

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

888

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

889

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

890

},

891

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

892

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

893

"A String",

894

],

895

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

896

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

897

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

898

{

899

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

900

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

901

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

902

# Required when adding a reminder.

903

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

904

# Required when adding a reminder.

905

},

906

],

907

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

908

},

909

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

910

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

911

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

912

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

913

},

914

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

915

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

916

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

917

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

918

},

919

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

920

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

921

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

922

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

923

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

924

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

925

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

926

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

927

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

928

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

929

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

930

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

931

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

932

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

933

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

934

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

935

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

936

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

937

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

938

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

944

<pre>Creates an event.

945

946

Args:

947

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)

948

body: object, The request body.

949

The object takes the form of:

950

951

{

yoshi-code-bot

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

[diff] [blame]

952

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

953

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

954

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

955

# There can be at most 25 attachments per event,

956

{

957

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

958

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

959

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

960

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

961

# Required when adding an attachment.

962

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

963

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

964

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

965

},

966

],

967

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

968

{

969

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

970

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

971

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

972

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

973

# Required when adding an attendee.

yoshi-code-bot

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

[diff] [blame]

974

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

Yoshi Automation Bot

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

[diff] [blame]

975

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

976

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

977

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

978

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

979

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

980

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

981

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

982

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

983

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

984

},

985

],

986

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

987

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

988

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

989

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

990

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

991

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

yoshi-code-bot

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

[diff] [blame]

992

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

993

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

994

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

995

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

yoshi-code-bot

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

[diff] [blame]

996

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

Yoshi Automation Bot

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

[diff] [blame]

997

# Unset for a conference with a failed create request.

998

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

999

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

1000

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

1001

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

1002

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

1003

# The possible values are:

yoshi-code-bot

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

[diff] [blame]

1004

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

1005

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

1006

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

1007

# - "addOn" for 3P conference providers

1008

},

1009

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

1010

},

1011

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

1012

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

1013

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

1014

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

1015

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

1016

# The possible values are:

yoshi-code-bot

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

[diff] [blame]

1017

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

1018

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

1019

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

1020

# - "addOn" for 3P conference providers

1021

},

1022

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

1023

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

1024

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

1025

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

1026

# The possible values are:

1027

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

1028

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

1029

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

1030

},

1031

},

1032

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

1033

# All of them must belong to the same conference.

1034

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

1035

{

1036

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

1037

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

1038

# Optional.

1039

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

1040

"A String",

1041

],

1042

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

1043

# Possible values are:

1044

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

1045

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

1046

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

1047

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

1048

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

1049

# Examples:

1050

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

1051

# - for phone: +1 123 268 2601

1052

# - for sip: 12345678@altostrat.com

1053

# - for more: should not be filled

1054

# Optional.

1055

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

# Optional.

1058

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

1059

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

1060

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

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

1064

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

1065

# Optional.

1066

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

1067

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

1068

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

1069

# Format:

1070

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

1071

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

1072

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

1073

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

1074

},

1075

],

1076

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

1077

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

1078

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

"parameters": {

"a_key": "A String",

},

},

},

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

1085

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

1086

# Unset for a conference with a failed create request.

1087

# Optional for a conference with a pending create request.

1088

},

1089

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

1090

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

1091

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

1092

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

yoshi-code-bot

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

[diff] [blame]

1093

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

Yoshi Automation Bot

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

[diff] [blame]

1094

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

1095

},

1096

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

1097

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

1098

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

1099

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

1100

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

1101

},

1102

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

1103

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

yoshi-code-bot

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

[diff] [blame]

1104

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

1105

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

1106

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

1107

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

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

[diff] [blame]

1108

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

1109

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

1110

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

1111

},

1112

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

1113

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

1114

},

1115

},

1116

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

1117

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

1118

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

1119

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

1120

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

1121

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

1122

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

1123

"preferences": { # Preferences.

1124

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

1125

},

1126

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

1127

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

1128

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

1129

},

1130

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

1131

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

1132

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

1133

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

1134

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

1135

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

1136

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

1137

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

1138

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

1139

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

1140

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

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

Yoshi Automation Bot

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

[diff] [blame]

1150

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

1151

},

1152

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

1153

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

1154

"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.

1155

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

1156

},

1157

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

1158

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

1159

"A String",

1160

],

1161

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

1162

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

1163

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

1164

{

1165

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

1166

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

1167

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

1168

# Required when adding a reminder.

1169

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

1170

# Required when adding a reminder.

1171

},

1172

],

1173

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

1174

},

1175

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

1176

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

1177

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

1178

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

1179

},

1180

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

1181

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

1182

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

1183

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

1184

},

1185

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

1186

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

1187

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

1188

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

1189

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

1190

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

1191

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

1192

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

1193

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

1194

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

1195

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

1196

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

1197

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

1198

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

1199

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

1200

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

1201

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

1202

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

1203

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

1204

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

1205

}

1206

1207

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.

1208

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.

1209

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

1210

1211

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.

1212

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.

1213

Allowed values

1214

all - Notifications are sent to all guests.

1215

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

Anthonios Partheniou

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

[diff] [blame]

1216

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]

1217

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

1218

1219

Returns:

1220

An object of the form:

1221

1222

{

yoshi-code-bot

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

[diff] [blame]

1223

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

1224

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

1225

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

1226

# There can be at most 25 attachments per event,

1227

{

1228

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

1229

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

1230

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

1231

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

1232

# Required when adding an attachment.

1233

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

1234

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

1235

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

1236

},

1237

],

1238

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

1239

{

1240

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

1241

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

1242

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

1243

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

1244

# Required when adding an attendee.

yoshi-code-bot

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

[diff] [blame]

1245

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

Yoshi Automation Bot

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

[diff] [blame]

1246

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

1247

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

1248

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

1249

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

1250

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

1251

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

1252

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

1253

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

1254

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

1255

},

1256

],

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

yoshi-code-bot

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

[diff] [blame]

1263

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

1264

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

1265

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

1266

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

yoshi-code-bot

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

[diff] [blame]

1267

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

Yoshi Automation Bot

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

[diff] [blame]

1268

# Unset for a conference with a failed create request.

1269

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

1270

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

1271

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

1272

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

1273

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

1274

# The possible values are:

yoshi-code-bot

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

[diff] [blame]

1275

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

1276

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

1277

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

1278

# - "addOn" for 3P conference providers

1279

},

1280

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

1281

},

1282

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

1283

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

1284

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

1285

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

1286

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

1287

# The possible values are:

yoshi-code-bot

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

[diff] [blame]

1288

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

1289

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

1290

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

1291

# - "addOn" for 3P conference providers

1292

},

1293

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

1294

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

1295

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

1296

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

1297

# The possible values are:

1298

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

1299

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

1300

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

1301

},

1302

},

1303

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

1304

# All of them must belong to the same conference.

1305

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

1306

{

1307

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

1308

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

1309

# Optional.

1310

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

1311

"A String",

1312

],

1313

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

1314

# Possible values are:

1315

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

1316

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

1317

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

1318

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

1319

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

1320

# Examples:

1321

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

1322

# - for phone: +1 123 268 2601

1323

# - for sip: 12345678@altostrat.com

1324

# - for more: should not be filled

1325

# Optional.

1326

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

1327

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

1328

# Optional.

1329

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

1330

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

1331

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

1332

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

1333

# Optional.

1334

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

1335

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

1336

# Optional.

1337

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

1338

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

1339

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

1340

# Format:

1341

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

1342

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1343

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1344

# - for more, http: or https: schema is required.

1345

},

1346

],

1347

"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.

1348

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1349

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"signature": "A String", # The signature of the conference data.

1356

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1357

# Unset for a conference with a failed create request.

1358

# Optional for a conference with a pending create request.

1359

},

1360

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1361

"creator": { # The creator of the event. Read-only.

1362

"displayName": "A String", # The creator's name, if available.

1363

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1364

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1365

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1366

},

1367

"description": "A String", # Description of the event. Can contain HTML. Optional.

1368

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1369

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1370

"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.

1371

"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.

1372

},

1373

"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.

1374

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1375

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

1376

# - "default" - A regular event or not further specified.

1377

# - "outOfOffice" - An out-of-office event.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

1378

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1379

"extendedProperties": { # Extended properties of the event.

1380

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1381

"a_key": "A String", # The name of the private property and the corresponding value.

1382

},

1383

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1384

"a_key": "A String", # The name of the shared property and the corresponding value.

1385

},

1386

},

1387

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1388

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1389

# - "icon" - The gadget displays next to the event's title in the calendar view.

1390

# - "chip" - The gadget displays when the event is clicked.

1391

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1392

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1393

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1394

"preferences": { # Preferences.

1395

"a_key": "A String", # The preference name and corresponding value.

1396

},

1397

"title": "A String", # The gadget's title. Deprecated.

1398

"type": "A String", # The gadget's type. Deprecated.

1399

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1400

},

1401

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1402

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1403

"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]

1404

"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]

1405

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1406

"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.

1407

# 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.

1408

"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:

1409

# - 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

1410

# - the length of the ID must be between 5 and 1024 characters

1411

# - 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.

1412

# If you do not specify an ID, it will be automatically generated by the server.

1413

# 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.

1414

"kind": "calendar#event", # Type of the resource ("calendar#event").

1415

"location": "A String", # Geographic location of the event as free-form text. Optional.

1416

"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.

1417

"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.

1418

"displayName": "A String", # The organizer's name, if available.

1419

"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]

1420

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1421

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1422

},

1423

"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.

1424

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1425

"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.

1426

"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.

1427

},

1428

"privateCopy": false, # If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.

1429

"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.

1430

"A String",

1431

],

1432

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1433

"reminders": { # Information about the event's reminders for the authenticated user.

1434

"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.

1435

{

1436

"method": "A String", # The method used by this reminder. Possible values are:

1437

# - "email" - Reminders are sent via email.

1438

# - "popup" - Reminders are sent via a UI popup.

1439

# Required when adding a reminder.

1440

"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).

1441

# Required when adding a reminder.

1442

},

1443

],

1444

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1445

},

1446

"sequence": 42, # Sequence number as per iCalendar.

1447

"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.

1448

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1449

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1450

},

1451

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1452

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1453

"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.

1454

"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.

1455

},

1456

"status": "A String", # Status of the event. Optional. Possible values are:

1457

# - "confirmed" - The event is confirmed. This is the default status.

1458

# - "tentative" - The event is tentatively confirmed.

1459

# - "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.

1460

# A cancelled status represents two different states depending on the event type:

1461

# - 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.

1462

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1463

# - 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.

1464

# 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.

1465

# 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.

1466

"summary": "A String", # Title of the event.

1467

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1468

# - "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.

1469

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1470

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1471

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1472

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1473

# - "public" - The event is public and event details are visible to all readers of the calendar.

1474

# - "private" - The event is private and only event attendees may view event details.

1475

# - "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>

1481

<pre>Returns instances of the specified recurring event.

1482

1483

Args:

1484

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)

1485

eventId: string, Recurring event identifier. (required)

1486

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).

1487

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.

1488

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.

1489

originalStart: string, The original start time of the instance in the result. Optional.

1490

pageToken: string, Token specifying which result page to return. Optional.

1491

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.

1492

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.

1493

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.

1494

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

1495

1496

Returns:

1497

An object of the form:

1498

1499

{

1500

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1501

# - "none" - The user has no access.

1502

# - "freeBusyReader" - The user has read access to free/busy information.

1503

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1504

# - "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.

1505

# - "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.

1506

"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).

1507

{

1508

"method": "A String", # The method used by this reminder. Possible values are:

1509

# - "email" - Reminders are sent via email.

1510

# - "popup" - Reminders are sent via a UI popup.

1511

# Required when adding a reminder.

1512

"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).

1513

# Required when adding a reminder.

1514

},

1515

],

1516

"description": "A String", # Description of the calendar. Read-only.

1517

"etag": "A String", # ETag of the collection.

1518

"items": [ # List of events on the calendar.

1519

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1520

"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]

1521

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1522

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1523

# There can be at most 25 attachments per event,

1524

{

1525

"fileId": "A String", # ID of the attached file. Read-only.

1526

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1527

"fileUrl": "A String", # URL link to the attachment.

1528

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1529

# Required when adding an attachment.

1530

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1531

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1532

"title": "A String", # Attachment title.

1533

},

1534

],

1535

"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.

1536

{

1537

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1538

"comment": "A String", # The attendee's response comment. Optional.

1539

"displayName": "A String", # The attendee's name, if available. Optional.

1540

"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.

1541

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1542

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1543

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1544

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1545

"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.

1546

"responseStatus": "A String", # The attendee's response status. Possible values are:

1547

# - "needsAction" - The attendee has not responded to the invitation.

1548

# - "declined" - The attendee has declined the invitation.

1549

# - "tentative" - The attendee has tentatively accepted the invitation.

1550

# - "accepted" - The attendee has accepted the invitation.

1551

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1552

},

1553

],

1554

"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.

1555

"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.

1556

"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.

1557

"conferenceId": "A String", # The ID of the conference.

1558

# 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]

1559

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

1560

# - eventHangout: ID is not set. (This conference type is deprecated.)

1561

# - 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]

1562

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

1563

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

1564

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1565

# Unset for a conference with a failed create request.

1566

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1567

"iconUri": "A String", # The user-visible icon for this solution.

1568

"key": { # The key which can uniquely identify the conference solution for this event.

1569

"type": "A String", # The conference solution type.

1570

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1571

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

1572

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1573

# - "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]

1574

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1575

# - "addOn" for 3P conference providers

1576

},

1577

"name": "A String", # The user-visible name of this solution. Not localized.

1578

},

1579

"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.

1580

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1581

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1582

"type": "A String", # The conference solution type.

1583

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1584

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

1585

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1586

# - "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]

1587

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1588

# - "addOn" for 3P conference providers

1589

},

1590

"requestId": "A String", # The client-generated unique ID for this request.

1591

# 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.

1592

"status": { # The status of the conference create request.

1593

"statusCode": "A String", # The current status of the conference create request. Read-only.

1594

# The possible values are:

1595

# - "pending": the conference create request is still being processed.

1596

# - "success": the conference create request succeeded, the entry points are populated.

1597

# - "failure": the conference create request failed, there are no entry points.

1598

},

1599

},

1600

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1601

# All of them must belong to the same conference.

1602

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1603

{

1604

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1605

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1606

# Optional.

1607

"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.

1608

"A String",

1609

],

1610

"entryPointType": "A String", # The type of the conference entry point.

1611

# Possible values are:

1612

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1613

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1614

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1615

# - "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.

1616

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1617

# Examples:

1618

# - for video: meet.google.com/aaa-bbbb-ccc

1619

# - for phone: +1 123 268 2601

1620

# - for sip: 12345678@altostrat.com

1621

# - for more: should not be filled

1622

# Optional.

1623

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1624

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1625

# Optional.

1626

"passcode": "A String", # The passcode 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

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1629

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1630

# Optional.

1631

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1632

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1633

# Optional.

1634

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1635

# Calendar backend will populate this field only for EntryPointType.PHONE.

1636

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1637

# Format:

1638

# - for video, http: or https: schema is required.

1639

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1640

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1641

# - for more, http: or https: schema is required.

1642

},

1643

],

1644

"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.

1645

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1646

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"signature": "A String", # The signature of the conference data.

1653

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1654

# Unset for a conference with a failed create request.

1655

# Optional for a conference with a pending create request.

1656

},

1657

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1658

"creator": { # The creator of the event. Read-only.

1659

"displayName": "A String", # The creator's name, if available.

1660

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1661

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1662

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1663

},

1664

"description": "A String", # Description of the event. Can contain HTML. Optional.

1665

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1666

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1667

"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.

1668

"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.

1669

},

1670

"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.

1671

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1672

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

1673

# - "default" - A regular event or not further specified.

1674

# - "outOfOffice" - An out-of-office event.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

1675

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1676

"extendedProperties": { # Extended properties of the event.

1677

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1678

"a_key": "A String", # The name of the private property and the corresponding value.

1679

},

1680

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1681

"a_key": "A String", # The name of the shared property and the corresponding value.

1682

},

1683

},

1684

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1685

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1686

# - "icon" - The gadget displays next to the event's title in the calendar view.

1687

# - "chip" - The gadget displays when the event is clicked.

1688

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1689

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1690

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1691

"preferences": { # Preferences.

1692

"a_key": "A String", # The preference name and corresponding value.

1693

},

1694

"title": "A String", # The gadget's title. Deprecated.

1695

"type": "A String", # The gadget's type. Deprecated.

1696

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1697

},

1698

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1699

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1700

"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]

1701

"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]

1702

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1703

"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.

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

"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:

1706

# - 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

1707

# - the length of the ID must be between 5 and 1024 characters

1708

# - 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.

1709

# If you do not specify an ID, it will be automatically generated by the server.

1710

# 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.

1711

"kind": "calendar#event", # Type of the resource ("calendar#event").

1712

"location": "A String", # Geographic location of the event as free-form text. Optional.

1713

"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.

1714

"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.

1715

"displayName": "A String", # The organizer's name, if available.

1716

"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]

1717

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1718

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1719

},

1720

"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.

1721

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1722

"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.

1723

"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.

1724

},

1725

"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.

1726

"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.

1727

"A String",

1728

],

1729

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1730

"reminders": { # Information about the event's reminders for the authenticated user.

1731

"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.

1732

{

1733

"method": "A String", # The method used by this reminder. Possible values are:

1734

# - "email" - Reminders are sent via email.

1735

# - "popup" - Reminders are sent via a UI popup.

1736

# Required when adding a reminder.

1737

"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).

1738

# Required when adding a reminder.

1739

},

1740

],

1741

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1742

},

1743

"sequence": 42, # Sequence number as per iCalendar.

1744

"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.

1745

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1746

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1747

},

1748

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1749

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1750

"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.

1751

"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.

1752

},

1753

"status": "A String", # Status of the event. Optional. Possible values are:

1754

# - "confirmed" - The event is confirmed. This is the default status.

1755

# - "tentative" - The event is tentatively confirmed.

1756

# - "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.

1757

# A cancelled status represents two different states depending on the event type:

1758

# - 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.

1759

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1760

# - 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.

1761

# 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.

1762

# 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.

1763

"summary": "A String", # Title of the event.

1764

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1765

# - "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.

1766

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1767

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1768

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1769

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1770

# - "public" - The event is public and event details are visible to all readers of the calendar.

1771

# - "private" - The event is private and only event attendees may view event details.

1772

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1773

},

1774

],

1775

"kind": "calendar#events", # Type of the collection ("calendar#events").

1776

"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.

1777

"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.

1778

"summary": "A String", # Title of the calendar. Read-only.

1779

"timeZone": "A String", # The time zone of the calendar. Read-only.

1780

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

1781

}</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>

1786

<pre>Retrieves the next page of results.

1787

1788

Args:

1789

previous_request: The request for the previous page. (required)

1790

previous_response: The response from the request for the previous page. (required)

1791

1792

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1793

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1794

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]

1799

<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]

1800

<pre>Returns events on the specified calendar.

1801

1802

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1803

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]

1804

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]

1805

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]

1806

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.

1807

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.

1808

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

1809

Allowed values

1810

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

1811

updated - Order by last modification time (ascending).

1812

pageToken: string, Token specifying which result page to return. Optional.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1813

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]

1814

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]

1815

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]

1816

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.

1817

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

1818

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]

1819

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.

1820

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

1826

- q

1827

- sharedExtendedProperty

1828

- timeMin

1829

- timeMax

1830

- 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.

1831

Learn more about incremental synchronization.

1832

Optional. The default is to return all entries.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1833

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.

1834

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]

1835

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]

1836

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]

1837

1838

Returns:

1839

An object of the form:

1840

1841

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1842

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1843

# - "none" - The user has no access.

1844

# - "freeBusyReader" - The user has read access to free/busy information.

1845

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1846

# - "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.

1847

# - "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.

1848

"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).

1849

{

1850

"method": "A String", # The method used by this reminder. Possible values are:

1851

# - "email" - Reminders are sent via email.

1852

# - "popup" - Reminders are sent via a UI popup.

1853

# Required when adding a reminder.

1854

"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).

1855

# Required when adding a reminder.

1856

},

1857

],

1858

"description": "A String", # Description of the calendar. Read-only.

1859

"etag": "A String", # ETag of the collection.

1860

"items": [ # List of events on the calendar.

1861

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1862

"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]

1863

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1864

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1865

# There can be at most 25 attachments per event,

1866

{

1867

"fileId": "A String", # ID of the attached file. Read-only.

1868

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1869

"fileUrl": "A String", # URL link to the attachment.

1870

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1871

# Required when adding an attachment.

1872

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1873

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1874

"title": "A String", # Attachment title.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1875

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1876

],

1877

"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.

1878

{

1879

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1880

"comment": "A String", # The attendee's response comment. Optional.

1881

"displayName": "A String", # The attendee's name, if available. Optional.

1882

"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.

1883

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

1884

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1885

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1886

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1887

"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.

1888

"responseStatus": "A String", # The attendee's response status. Possible values are:

1889

# - "needsAction" - The attendee has not responded to the invitation.

1890

# - "declined" - The attendee has declined the invitation.

1891

# - "tentative" - The attendee has tentatively accepted the invitation.

1892

# - "accepted" - The attendee has accepted the invitation.

1893

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1894

},

1895

],

1896

"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.

1897

"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.

1898

"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.

1899

"conferenceId": "A String", # The ID of the conference.

1900

# 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]

1901

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

1902

# - eventHangout: ID is not set. (This conference type is deprecated.)

1903

# - 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]

1904

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

1905

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

1906

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1907

# Unset for a conference with a failed create request.

1908

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1909

"iconUri": "A String", # The user-visible icon for this solution.

1910

"key": { # The key which can uniquely identify the conference solution for this event.

1911

"type": "A String", # The conference solution type.

1912

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1913

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

1914

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1915

# - "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]

1916

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1917

# - "addOn" for 3P conference providers

1918

},

1919

"name": "A String", # The user-visible name of this solution. Not localized.

1920

},

1921

"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.

1922

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1923

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1924

"type": "A String", # The conference solution type.

1925

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1926

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

1927

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

1928

# - "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]

1929

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1930

# - "addOn" for 3P conference providers

1931

},

1932

"requestId": "A String", # The client-generated unique ID for this request.

1933

# 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.

1934

"status": { # The status of the conference create request.

1935

"statusCode": "A String", # The current status of the conference create request. Read-only.

1936

# The possible values are:

1937

# - "pending": the conference create request is still being processed.

1938

# - "success": the conference create request succeeded, the entry points are populated.

1939

# - "failure": the conference create request failed, there are no entry points.

1940

},

1941

},

1942

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1943

# All of them must belong to the same conference.

1944

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1945

{

1946

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1947

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1948

# Optional.

1949

"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.

1950

"A String",

1951

],

1952

"entryPointType": "A String", # The type of the conference entry point.

1953

# Possible values are:

1954

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1955

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1956

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1957

# - "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.

1958

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1959

# Examples:

1960

# - for video: meet.google.com/aaa-bbbb-ccc

1961

# - for phone: +1 123 268 2601

1962

# - for sip: 12345678@altostrat.com

1963

# - for more: should not be filled

1964

# Optional.

1965

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1966

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1967

# Optional.

1968

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1969

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1970

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1971

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1972

# Optional.

1973

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1974

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1975

# Optional.

1976

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1977

# Calendar backend will populate this field only for EntryPointType.PHONE.

1978

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1979

# Format:

1980

# - for video, http: or https: schema is required.

1981

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1982

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1983

# - for more, http: or https: schema is required.

1984

},

1985

],

1986

"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.

1987

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1988

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"signature": "A String", # The signature of the conference data.

1995

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1996

# Unset for a conference with a failed create request.

1997

# Optional for a conference with a pending create request.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1998

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1999

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2000

"creator": { # The creator of the event. Read-only.

2001

"displayName": "A String", # The creator's name, if available.

2002

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2003

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2004

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2005

},

2006

"description": "A String", # Description of the event. Can contain HTML. Optional.

2007

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2008

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2009

"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.

2010

"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.

2011

},

2012

"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.

2013

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2014

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

2015

# - "default" - A regular event or not further specified.

2016

# - "outOfOffice" - An out-of-office event.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

2017

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2018

"extendedProperties": { # Extended properties of the event.

2019

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2020

"a_key": "A String", # The name of the private property and the corresponding value.

2021

},

2022

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2023

"a_key": "A String", # The name of the shared property and the corresponding value.

2024

},

2025

},

2026

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2027

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2028

# - "icon" - The gadget displays next to the event's title in the calendar view.

2029

# - "chip" - The gadget displays when the event is clicked.

2030

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2031

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2032

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2033

"preferences": { # Preferences.

2034

"a_key": "A String", # The preference name and corresponding value.

2035

},

2036

"title": "A String", # The gadget's title. Deprecated.

2037

"type": "A String", # The gadget's type. Deprecated.

2038

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2039

},

2040

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2041

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2042

"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]

2043

"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]

2044

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2045

"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.

2046

# 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.

2047

"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:

2048

# - 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

2049

# - the length of the ID must be between 5 and 1024 characters

2050

# - 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.

2051

# If you do not specify an ID, it will be automatically generated by the server.

2052

# 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.

2053

"kind": "calendar#event", # Type of the resource ("calendar#event").

2054

"location": "A String", # Geographic location of the event as free-form text. Optional.

2055

"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.

2056

"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.

2057

"displayName": "A String", # The organizer's name, if available.

2058

"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]

2059

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2060

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2061

},

2062

"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.

2063

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2064

"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.

2065

"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.

2066

},

2067

"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.

2068

"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.

2069

"A String",

2070

],

2071

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2072

"reminders": { # Information about the event's reminders for the authenticated user.

2073

"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.

2074

{

2075

"method": "A String", # The method used by this reminder. Possible values are:

2076

# - "email" - Reminders are sent via email.

2077

# - "popup" - Reminders are sent via a UI popup.

2078

# Required when adding a reminder.

2079

"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).

2080

# Required when adding a reminder.

2081

},

2082

],

2083

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2084

},

2085

"sequence": 42, # Sequence number as per iCalendar.

2086

"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.

2087

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2088

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2089

},

2090

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2091

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2092

"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.

2093

"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.

2094

},

2095

"status": "A String", # Status of the event. Optional. Possible values are:

2096

# - "confirmed" - The event is confirmed. This is the default status.

2097

# - "tentative" - The event is tentatively confirmed.

2098

# - "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.

2099

# A cancelled status represents two different states depending on the event type:

2100

# - 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.

2101

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2102

# - 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.

2103

# 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.

2104

# 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.

2105

"summary": "A String", # Title of the event.

2106

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2107

# - "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.

2108

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2109

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2110

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2111

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2112

# - "public" - The event is public and event details are visible to all readers of the calendar.

2113

# - "private" - The event is private and only event attendees may view event details.

2114

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2115

},

2116

],

2117

"kind": "calendar#events", # Type of the collection ("calendar#events").

2118

"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.

2119

"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.

2120

"summary": "A String", # Title of the calendar. Read-only.

2121

"timeZone": "A String", # The time zone of the calendar. Read-only.

2122

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

2123

}</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>

2128

<pre>Retrieves the next page of results.

2129

2130

Args:

2131

previous_request: The request for the previous page. (required)

2132

previous_response: The response from the request for the previous page. (required)

2133

2134

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2135

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2136

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]

2141

<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]

2142

<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]

2143

2144

Args:

2145

calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)

2146

eventId: string, Event identifier. (required)

2147

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]

2148

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2149

2150

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]

2151

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]

2152

Allowed values

2153

all - Notifications are sent to all guests.

2154

externalOnly - Notifications are sent to non-Google Calendar guests only.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2155

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]

2156

2157

Returns:

2158

An object of the form:

2159

2160

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2161

"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]

2162

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2163

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2164

# There can be at most 25 attachments per event,

2165

{

2166

"fileId": "A String", # ID of the attached file. Read-only.

2167

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2168

"fileUrl": "A String", # URL link to the attachment.

2169

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2170

# Required when adding an attachment.

2171

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2172

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2173

"title": "A String", # Attachment title.

2174

},

2175

],

2176

"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.

2177

{

2178

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2179

"comment": "A String", # The attendee's response comment. Optional.

2180

"displayName": "A String", # The attendee's name, if available. Optional.

2181

"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.

2182

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2183

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2184

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2185

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2186

"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.

2187

"responseStatus": "A String", # The attendee's response status. Possible values are:

2188

# - "needsAction" - The attendee has not responded to the invitation.

2189

# - "declined" - The attendee has declined the invitation.

2190

# - "tentative" - The attendee has tentatively accepted the invitation.

2191

# - "accepted" - The attendee has accepted the invitation.

2192

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2193

},

2194

],

2195

"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.

2196

"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.

2197

"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.

2198

"conferenceId": "A String", # The ID of the conference.

2199

# 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]

2200

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2201

# - eventHangout: ID is not set. (This conference type is deprecated.)

2202

# - 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]

2203

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

2204

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2205

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2206

# Unset for a conference with a failed create request.

2207

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2208

"iconUri": "A String", # The user-visible icon for this solution.

2209

"key": { # The key which can uniquely identify the conference solution for this event.

2210

"type": "A String", # The conference solution type.

2211

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2212

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2213

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2214

# - "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]

2215

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2216

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2217

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2218

"name": "A String", # The user-visible name of this solution. Not localized.

2219

},

2220

"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.

2221

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2222

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2223

"type": "A String", # The conference solution type.

2224

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2225

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2226

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2227

# - "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]

2228

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2229

# - "addOn" for 3P conference providers

2230

},

2231

"requestId": "A String", # The client-generated unique ID for this request.

2232

# 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.

2233

"status": { # The status of the conference create request.

2234

"statusCode": "A String", # The current status of the conference create request. Read-only.

2235

# The possible values are:

2236

# - "pending": the conference create request is still being processed.

2237

# - "success": the conference create request succeeded, the entry points are populated.

2238

# - "failure": the conference create request failed, there are no entry points.

2239

},

2240

},

2241

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2242

# All of them must belong to the same conference.

2243

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2244

{

2245

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2246

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2247

# Optional.

2248

"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.

2249

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2250

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2251

"entryPointType": "A String", # The type of the conference entry point.

2252

# Possible values are:

2253

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2254

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2255

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2256

# - "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.

2257

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2258

# Examples:

2259

# - for video: meet.google.com/aaa-bbbb-ccc

2260

# - for phone: +1 123 268 2601

2261

# - for sip: 12345678@altostrat.com

2262

# - for more: should not be filled

2263

# Optional.

2264

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2265

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2266

# Optional.

2267

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2268

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2269

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2270

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2271

# Optional.

2272

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2273

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2274

# Optional.

2275

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2276

# Calendar backend will populate this field only for EntryPointType.PHONE.

2277

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2278

# Format:

2279

# - for video, http: or https: schema is required.

2280

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2281

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2282

# - for more, http: or https: schema is required.

2283

},

2284

],

2285

"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.

2286

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2287

"addOnParameters": { # Additional add-on specific data.

2288

"parameters": {

2289

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2290

},

2291

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2292

},

2293

"signature": "A String", # The signature of the conference data.

2294

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2295

# Unset for a conference with a failed create request.

2296

# Optional for a conference with a pending create request.

2297

},

2298

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2299

"creator": { # The creator of the event. Read-only.

2300

"displayName": "A String", # The creator's name, if available.

2301

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2302

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2303

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2304

},

2305

"description": "A String", # Description of the event. Can contain HTML. Optional.

2306

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2307

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2308

"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.

2309

"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.

2310

},

2311

"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.

2312

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2313

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

2314

# - "default" - A regular event or not further specified.

2315

# - "outOfOffice" - An out-of-office event.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

2316

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2317

"extendedProperties": { # Extended properties of the event.

2318

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2319

"a_key": "A String", # The name of the private property and the corresponding value.

2320

},

2321

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2322

"a_key": "A String", # The name of the shared property and the corresponding value.

2323

},

2324

},

2325

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2326

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2327

# - "icon" - The gadget displays next to the event's title in the calendar view.

2328

# - "chip" - The gadget displays when the event is clicked.

2329

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2330

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2331

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2332

"preferences": { # Preferences.

2333

"a_key": "A String", # The preference name and corresponding value.

2334

},

2335

"title": "A String", # The gadget's title. Deprecated.

2336

"type": "A String", # The gadget's type. Deprecated.

2337

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2338

},

2339

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2340

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2341

"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]

2342

"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]

2343

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2344

"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.

2345

# 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.

2346

"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:

2347

# - 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

2348

# - the length of the ID must be between 5 and 1024 characters

2349

# - 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.

2350

# If you do not specify an ID, it will be automatically generated by the server.

2351

# 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.

2352

"kind": "calendar#event", # Type of the resource ("calendar#event").

2353

"location": "A String", # Geographic location of the event as free-form text. Optional.

2354

"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.

2355

"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.

2356

"displayName": "A String", # The organizer's name, if available.

2357

"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]

2358

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2359

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2360

},

2361

"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.

2362

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2363

"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.

2364

"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.

2365

},

2366

"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.

2367

"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.

2368

"A String",

2369

],

2370

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2371

"reminders": { # Information about the event's reminders for the authenticated user.

2372

"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.

2373

{

2374

"method": "A String", # The method used by this reminder. Possible values are:

2375

# - "email" - Reminders are sent via email.

2376

# - "popup" - Reminders are sent via a UI popup.

2377

# Required when adding a reminder.

2378

"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).

2379

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2380

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2381

],

2382

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2383

},

2384

"sequence": 42, # Sequence number as per iCalendar.

2385

"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.

2386

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2387

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2388

},

2389

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2390

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2391

"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.

2392

"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.

2393

},

2394

"status": "A String", # Status of the event. Optional. Possible values are:

2395

# - "confirmed" - The event is confirmed. This is the default status.

2396

# - "tentative" - The event is tentatively confirmed.

2397

# - "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.

2398

# A cancelled status represents two different states depending on the event type:

2399

# - 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.

2400

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2401

# - 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.

2402

# 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.

2403

# 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.

2404

"summary": "A String", # Title of the event.

2405

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2406

# - "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.

2407

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2408

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2409

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2410

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2411

# - "public" - The event is public and event details are visible to all readers of the calendar.

2412

# - "private" - The event is private and only event attendees may view event details.

2413

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2414

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2415

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2416

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2417

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2418

<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]

2419

<pre>Updates an event. This method supports patch semantics.

2420

2421

Args:

2422

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)

2423

eventId: string, Event identifier. (required)

2424

body: object, The request body.

2425

The object takes the form of:

2426

2427

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2428

"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]

2429

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2430

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2431

# There can be at most 25 attachments per event,

2432

{

2433

"fileId": "A String", # ID of the attached file. Read-only.

2434

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2435

"fileUrl": "A String", # URL link to the attachment.

2436

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2437

# Required when adding an attachment.

2438

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2439

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2440

"title": "A String", # Attachment title.

2441

},

2442

],

2443

"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.

2444

{

2445

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2446

"comment": "A String", # The attendee's response comment. Optional.

2447

"displayName": "A String", # The attendee's name, if available. Optional.

2448

"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.

2449

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2450

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2451

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2452

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2453

"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.

2454

"responseStatus": "A String", # The attendee's response status. Possible values are:

2455

# - "needsAction" - The attendee has not responded to the invitation.

2456

# - "declined" - The attendee has declined the invitation.

2457

# - "tentative" - The attendee has tentatively accepted the invitation.

2458

# - "accepted" - The attendee has accepted the invitation.

2459

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2460

},

2461

],

2462

"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.

2463

"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.

2464

"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.

2465

"conferenceId": "A String", # The ID of the conference.

2466

# 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]

2467

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2468

# - eventHangout: ID is not set. (This conference type is deprecated.)

2469

# - 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]

2470

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

2471

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2472

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2473

# Unset for a conference with a failed create request.

2474

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2475

"iconUri": "A String", # The user-visible icon for this solution.

2476

"key": { # The key which can uniquely identify the conference solution for this event.

2477

"type": "A String", # The conference solution type.

2478

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2479

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2480

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2481

# - "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]

2482

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2483

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2484

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2485

"name": "A String", # The user-visible name of this solution. Not localized.

2486

},

2487

"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.

2488

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2489

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2490

"type": "A String", # The conference solution type.

2491

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2492

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2493

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2494

# - "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]

2495

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2496

# - "addOn" for 3P conference providers

2497

},

2498

"requestId": "A String", # The client-generated unique ID for this request.

2499

# 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.

2500

"status": { # The status of the conference create request.

2501

"statusCode": "A String", # The current status of the conference create request. Read-only.

2502

# The possible values are:

2503

# - "pending": the conference create request is still being processed.

2504

# - "success": the conference create request succeeded, the entry points are populated.

2505

# - "failure": the conference create request failed, there are no entry points.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2506

},

2507

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2508

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2509

# All of them must belong to the same conference.

2510

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2511

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2512

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2513

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2514

# Optional.

2515

"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.

2516

"A String",

2517

],

2518

"entryPointType": "A String", # The type of the conference entry point.

2519

# Possible values are:

2520

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2521

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2522

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2523

# - "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.

2524

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2525

# Examples:

2526

# - for video: meet.google.com/aaa-bbbb-ccc

2527

# - for phone: +1 123 268 2601

2528

# - for sip: 12345678@altostrat.com

2529

# - for more: should not be filled

2530

# Optional.

2531

"meetingCode": "A String", # The meeting code 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

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2535

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2536

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2537

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2538

# Optional.

2539

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2540

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2541

# Optional.

2542

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2543

# Calendar backend will populate this field only for EntryPointType.PHONE.

2544

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2545

# Format:

2546

# - for video, http: or https: schema is required.

2547

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2548

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2549

# - for more, http: or https: schema is required.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2550

},

2551

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2552

"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.

2553

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2554

"addOnParameters": { # Additional add-on specific data.

2555

"parameters": {

2556

"a_key": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2557

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2558

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2559

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2560

"signature": "A String", # The signature of the conference data.

2561

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2562

# Unset for a conference with a failed create request.

2563

# Optional for a conference with a pending create request.

2564

},

2565

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2566

"creator": { # The creator of the event. Read-only.

2567

"displayName": "A String", # The creator's name, if available.

2568

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2569

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2570

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2571

},

2572

"description": "A String", # Description of the event. Can contain HTML. Optional.

2573

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2574

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2575

"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.

2576

"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.

2577

},

2578

"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.

2579

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2580

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

2581

# - "default" - A regular event or not further specified.

2582

# - "outOfOffice" - An out-of-office event.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

2583

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2584

"extendedProperties": { # Extended properties of the event.

2585

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2586

"a_key": "A String", # The name of the private property and the corresponding value.

2587

},

2588

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2589

"a_key": "A String", # The name of the shared property and the corresponding value.

2590

},

2591

},

2592

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2593

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2594

# - "icon" - The gadget displays next to the event's title in the calendar view.

2595

# - "chip" - The gadget displays when the event is clicked.

2596

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2597

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2598

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2599

"preferences": { # Preferences.

2600

"a_key": "A String", # The preference name and corresponding value.

2601

},

2602

"title": "A String", # The gadget's title. Deprecated.

2603

"type": "A String", # The gadget's type. Deprecated.

2604

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2605

},

2606

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2607

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2608

"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]

2609

"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]

2610

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2611

"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.

2612

# 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.

2613

"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:

2614

# - 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

2615

# - the length of the ID must be between 5 and 1024 characters

2616

# - 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.

2617

# If you do not specify an ID, it will be automatically generated by the server.

2618

# 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.

2619

"kind": "calendar#event", # Type of the resource ("calendar#event").

2620

"location": "A String", # Geographic location of the event as free-form text. Optional.

2621

"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.

2622

"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.

2623

"displayName": "A String", # The organizer's name, if available.

2624

"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]

2625

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2626

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2627

},

2628

"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.

2629

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2630

"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.

2631

"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.

2632

},

2633

"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.

2634

"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.

2635

"A String",

2636

],

2637

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2638

"reminders": { # Information about the event's reminders for the authenticated user.

2639

"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]

2640

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2641

"method": "A String", # The method used by this reminder. Possible values are:

2642

# - "email" - Reminders are sent via email.

2643

# - "popup" - Reminders are sent via a UI popup.

2644

# Required when adding a reminder.

2645

"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).

2646

# Required when adding a reminder.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2647

},

2648

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2649

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2650

},

2651

"sequence": 42, # Sequence number as per iCalendar.

2652

"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.

2653

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2654

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2655

},

2656

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2657

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2658

"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.

2659

"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.

2660

},

2661

"status": "A String", # Status of the event. Optional. Possible values are:

2662

# - "confirmed" - The event is confirmed. This is the default status.

2663

# - "tentative" - The event is tentatively confirmed.

2664

# - "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.

2665

# A cancelled status represents two different states depending on the event type:

2666

# - 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.

2667

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2668

# - 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.

2669

# 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.

2670

# 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.

2671

"summary": "A String", # Title of the event.

2672

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2673

# - "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.

2674

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2675

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2676

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2677

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2678

# - "public" - The event is public and event details are visible to all readers of the calendar.

2679

# - "private" - The event is private and only event attendees may view event details.

2680

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2681

}

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2682

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2683

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]

2684

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.

2685

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]

2686

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2687

2688

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]

2689

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

2690

Allowed values

2691

all - Notifications are sent to all guests.

2692

externalOnly - Notifications are sent to non-Google Calendar guests only.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2693

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]

2694

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]

2695

2696

Returns:

2697

An object of the form:

2698

2699

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2700

"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]

2701

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2702

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2703

# There can be at most 25 attachments per event,

2704

{

2705

"fileId": "A String", # ID of the attached file. Read-only.

2706

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2707

"fileUrl": "A String", # URL link to the attachment.

2708

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2709

# Required when adding an attachment.

2710

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2711

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2712

"title": "A String", # Attachment title.

2713

},

2714

],

2715

"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.

2716

{

2717

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2718

"comment": "A String", # The attendee's response comment. Optional.

2719

"displayName": "A String", # The attendee's name, if available. Optional.

2720

"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.

2721

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2722

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2723

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2724

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2725

"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.

2726

"responseStatus": "A String", # The attendee's response status. Possible values are:

2727

# - "needsAction" - The attendee has not responded to the invitation.

2728

# - "declined" - The attendee has declined the invitation.

2729

# - "tentative" - The attendee has tentatively accepted the invitation.

2730

# - "accepted" - The attendee has accepted the invitation.

2731

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2732

},

2733

],

2734

"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.

2735

"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.

2736

"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.

2737

"conferenceId": "A String", # The ID of the conference.

2738

# 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]

2739

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2740

# - eventHangout: ID is not set. (This conference type is deprecated.)

2741

# - 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]

2742

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

2743

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2744

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2745

# Unset for a conference with a failed create request.

2746

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2747

"iconUri": "A String", # The user-visible icon for this solution.

2748

"key": { # The key which can uniquely identify the conference solution for this event.

2749

"type": "A String", # The conference solution type.

2750

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2751

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2752

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2753

# - "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]

2754

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2755

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2756

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2757

"name": "A String", # The user-visible name of this solution. Not localized.

2758

},

2759

"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.

2760

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2761

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2762

"type": "A String", # The conference solution type.

2763

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2764

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

2765

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

2766

# - "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]

2767

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2768

# - "addOn" for 3P conference providers

2769

},

2770

"requestId": "A String", # The client-generated unique ID for this request.

2771

# 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.

2772

"status": { # The status of the conference create request.

2773

"statusCode": "A String", # The current status of the conference create request. Read-only.

2774

# The possible values are:

2775

# - "pending": the conference create request is still being processed.

2776

# - "success": the conference create request succeeded, the entry points are populated.

2777

# - "failure": the conference create request failed, there are no entry points.

2778

},

2779

},

2780

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2781

# All of them must belong to the same conference.

2782

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2783

{

2784

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2785

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2786

# Optional.

2787

"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.

2788

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2789

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2790

"entryPointType": "A String", # The type of the conference entry point.

2791

# Possible values are:

2792

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2793

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2794

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2795

# - "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.

2796

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2797

# Examples:

2798

# - for video: meet.google.com/aaa-bbbb-ccc

2799

# - for phone: +1 123 268 2601

2800

# - for sip: 12345678@altostrat.com

2801

# - for more: should not be filled

2802

# Optional.

2803

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2804

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2805

# Optional.

2806

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2807

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2808

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2809

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2810

# Optional.

2811

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2812

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2813

# Optional.

2814

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2815

# Calendar backend will populate this field only for EntryPointType.PHONE.

2816

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2817

# Format:

2818

# - for video, http: or https: schema is required.

2819

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2820

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2821

# - for more, http: or https: schema is required.

2822

},

2823

],

2824

"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.

2825

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2826

"addOnParameters": { # Additional add-on specific data.

2827

"parameters": {

2828

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2829

},

2830

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2831

},

2832

"signature": "A String", # The signature of the conference data.

2833

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2834

# Unset for a conference with a failed create request.

2835

# Optional for a conference with a pending create request.

2836

},

2837

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2838

"creator": { # The creator of the event. Read-only.

2839

"displayName": "A String", # The creator's name, if available.

2840

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2841

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2842

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2843

},

2844

"description": "A String", # Description of the event. Can contain HTML. Optional.

2845

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2846

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2847

"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.

2848

"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.

2849

},

2850

"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.

2851

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2852

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

2853

# - "default" - A regular event or not further specified.

2854

# - "outOfOffice" - An out-of-office event.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

2855

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2856

"extendedProperties": { # Extended properties of the event.

2857

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2858

"a_key": "A String", # The name of the private property and the corresponding value.

2859

},

2860

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2861

"a_key": "A String", # The name of the shared property and the corresponding value.

2862

},

2863

},

2864

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2865

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2866

# - "icon" - The gadget displays next to the event's title in the calendar view.

2867

# - "chip" - The gadget displays when the event is clicked.

2868

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2869

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2870

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2871

"preferences": { # Preferences.

2872

"a_key": "A String", # The preference name and corresponding value.

2873

},

2874

"title": "A String", # The gadget's title. Deprecated.

2875

"type": "A String", # The gadget's type. Deprecated.

2876

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2877

},

2878

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2879

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2880

"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]

2881

"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]

2882

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2883

"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.

2884

# 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.

2885

"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:

2886

# - 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

2887

# - the length of the ID must be between 5 and 1024 characters

2888

# - 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.

2889

# If you do not specify an ID, it will be automatically generated by the server.

2890

# 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.

2891

"kind": "calendar#event", # Type of the resource ("calendar#event").

2892

"location": "A String", # Geographic location of the event as free-form text. Optional.

2893

"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.

2894

"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.

2895

"displayName": "A String", # The organizer's name, if available.

2896

"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]

2897

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2898

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2899

},

2900

"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.

2901

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2902

"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.

2903

"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.

2904

},

2905

"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.

2906

"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.

2907

"A String",

2908

],

2909

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2910

"reminders": { # Information about the event's reminders for the authenticated user.

2911

"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.

2912

{

2913

"method": "A String", # The method used by this reminder. Possible values are:

2914

# - "email" - Reminders are sent via email.

2915

# - "popup" - Reminders are sent via a UI popup.

2916

# Required when adding a reminder.

2917

"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).

2918

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2919

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2920

],

2921

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2922

},

2923

"sequence": 42, # Sequence number as per iCalendar.

2924

"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.

2925

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2926

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2927

},

2928

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2929

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2930

"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.

2931

"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.

2932

},

2933

"status": "A String", # Status of the event. Optional. Possible values are:

2934

# - "confirmed" - The event is confirmed. This is the default status.

2935

# - "tentative" - The event is tentatively confirmed.

2936

# - "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.

2937

# A cancelled status represents two different states depending on the event type:

2938

# - 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.

2939

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2940

# - 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.

2941

# 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.

2942

# 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.

2943

"summary": "A String", # Title of the event.

2944

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2945

# - "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.

2946

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2947

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2948

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2949

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2950

# - "public" - The event is public and event details are visible to all readers of the calendar.

2951

# - "private" - The event is private and only event attendees may view event details.

2952

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2953

}</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]

2957

<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]

2958

<pre>Creates an event based on a simple text string.

2959

2960

Args:

2961

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)

2962

text: string, The text describing the event to be created. (required)

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

2963

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2964

2965

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]

2966

sendUpdates: string, Guests who should receive notifications about the creation of the new event.

2967

Allowed values

2968

all - Notifications are sent to all guests.

2969

externalOnly - Notifications are sent to non-Google Calendar guests only.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2970

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]

2971

2972

Returns:

2973

An object of the form:

2974

2975

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2976

"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]

2977

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2978

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2979

# There can be at most 25 attachments per event,

2980

{

2981

"fileId": "A String", # ID of the attached file. Read-only.

2982

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2983

"fileUrl": "A String", # URL link to the attachment.

2984

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2985

# Required when adding an attachment.

2986

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2987

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2988

"title": "A String", # Attachment title.

2989

},

2990

],

2991

"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.

2992

{

2993

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2994

"comment": "A String", # The attendee's response comment. Optional.

2995

"displayName": "A String", # The attendee's name, if available. Optional.

2996

"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.

2997

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

2998

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2999

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3000

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3001

"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.

3002

"responseStatus": "A String", # The attendee's response status. Possible values are:

3003

# - "needsAction" - The attendee has not responded to the invitation.

3004

# - "declined" - The attendee has declined the invitation.

3005

# - "tentative" - The attendee has tentatively accepted the invitation.

3006

# - "accepted" - The attendee has accepted the invitation.

3007

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3008

},

3009

],

3010

"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.

3011

"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.

3012

"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.

3013

"conferenceId": "A String", # The ID of the conference.

3014

# 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]

3015

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3016

# - eventHangout: ID is not set. (This conference type is deprecated.)

3017

# - 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]

3018

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

3019

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3020

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3021

# Unset for a conference with a failed create request.

3022

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3023

"iconUri": "A String", # The user-visible icon for this solution.

3024

"key": { # The key which can uniquely identify the conference solution for this event.

3025

"type": "A String", # The conference solution type.

3026

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3027

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3028

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3029

# - "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]

3030

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3031

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

3032

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3033

"name": "A String", # The user-visible name of this solution. Not localized.

3034

},

3035

"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.

3036

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3037

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3038

"type": "A String", # The conference solution type.

3039

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3040

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3041

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3042

# - "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]

3043

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3044

# - "addOn" for 3P conference providers

3045

},

3046

"requestId": "A String", # The client-generated unique ID for this request.

3047

# 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.

3048

"status": { # The status of the conference create request.

3049

"statusCode": "A String", # The current status of the conference create request. Read-only.

3050

# The possible values are:

3051

# - "pending": the conference create request is still being processed.

3052

# - "success": the conference create request succeeded, the entry points are populated.

3053

# - "failure": the conference create request failed, there are no entry points.

3054

},

3055

},

3056

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3057

# All of them must belong to the same conference.

3058

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3059

{

3060

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3061

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3062

# Optional.

3063

"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.

3064

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3065

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3066

"entryPointType": "A String", # The type of the conference entry point.

3067

# Possible values are:

3068

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3069

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3070

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3071

# - "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.

3072

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3073

# Examples:

3074

# - for video: meet.google.com/aaa-bbbb-ccc

3075

# - for phone: +1 123 268 2601

3076

# - for sip: 12345678@altostrat.com

3077

# - for more: should not be filled

3078

# Optional.

3079

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3080

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3081

# Optional.

3082

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3083

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3084

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3085

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3086

# Optional.

3087

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3088

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3089

# Optional.

3090

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3091

# Calendar backend will populate this field only for EntryPointType.PHONE.

3092

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3093

# Format:

3094

# - for video, http: or https: schema is required.

3095

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3096

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3097

# - for more, http: or https: schema is required.

3098

},

3099

],

3100

"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.

3101

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3102

"addOnParameters": { # Additional add-on specific data.

3103

"parameters": {

3104

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3105

},

3106

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3107

},

3108

"signature": "A String", # The signature of the conference data.

3109

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3110

# Unset for a conference with a failed create request.

3111

# Optional for a conference with a pending create request.

3112

},

3113

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3114

"creator": { # The creator of the event. Read-only.

3115

"displayName": "A String", # The creator's name, if available.

3116

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3117

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3118

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3119

},

3120

"description": "A String", # Description of the event. Can contain HTML. Optional.

3121

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3122

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3123

"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.

3124

"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.

3125

},

3126

"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.

3127

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3128

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

3129

# - "default" - A regular event or not further specified.

3130

# - "outOfOffice" - An out-of-office event.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

3131

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3132

"extendedProperties": { # Extended properties of the event.

3133

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3134

"a_key": "A String", # The name of the private property and the corresponding value.

3135

},

3136

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3137

"a_key": "A String", # The name of the shared property and the corresponding value.

3138

},

3139

},

3140

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3141

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3142

# - "icon" - The gadget displays next to the event's title in the calendar view.

3143

# - "chip" - The gadget displays when the event is clicked.

3144

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3145

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3146

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3147

"preferences": { # Preferences.

3148

"a_key": "A String", # The preference name and corresponding value.

3149

},

3150

"title": "A String", # The gadget's title. Deprecated.

3151

"type": "A String", # The gadget's type. Deprecated.

3152

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3153

},

3154

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3155

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3156

"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]

3157

"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]

3158

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3159

"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.

3160

# 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.

3161

"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:

3162

# - 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

3163

# - the length of the ID must be between 5 and 1024 characters

3164

# - 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.

3165

# If you do not specify an ID, it will be automatically generated by the server.

3166

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

3167

"kind": "calendar#event", # Type of the resource ("calendar#event").

3168

"location": "A String", # Geographic location of the event as free-form text. Optional.

3169

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.

3170

"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.

3171

"displayName": "A String", # The organizer's name, if available.

3172

"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]

3173

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3174

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3175

},

3176

"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.

3177

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3178

"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.

3179

"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.

3180

},

3181

"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.

3182

"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.

3183

"A String",

3184

],

3185

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3186

"reminders": { # Information about the event's reminders for the authenticated user.

3187

"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.

3188

{

3189

"method": "A String", # The method used by this reminder. Possible values are:

3190

# - "email" - Reminders are sent via email.

3191

# - "popup" - Reminders are sent via a UI popup.

3192

# Required when adding a reminder.

3193

"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).

3194

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3195

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3196

],

3197

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3198

},

3199

"sequence": 42, # Sequence number as per iCalendar.

3200

"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.

3201

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3202

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3203

},

3204

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3205

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3206

"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.

3207

"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.

3208

},

3209

"status": "A String", # Status of the event. Optional. Possible values are:

3210

# - "confirmed" - The event is confirmed. This is the default status.

3211

# - "tentative" - The event is tentatively confirmed.

3212

# - "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.

3213

# A cancelled status represents two different states depending on the event type:

3214

# - 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.

3215

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3216

# - 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.

3217

# 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.

3218

# 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.

3219

"summary": "A String", # Title of the event.

3220

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3221

# - "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.

3222

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3223

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3224

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3225

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3226

# - "public" - The event is public and event details are visible to all readers of the calendar.

3227

# - "private" - The event is private and only event attendees may view event details.

3228

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3229

}</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]

3233

<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]

3234

<pre>Updates an event.

3235

3236

Args:

3237

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)

3238

eventId: string, Event identifier. (required)

3239

body: object, The request body.

3240

The object takes the form of:

3241

3242

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3243

"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]

3244

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3245

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3246

# There can be at most 25 attachments per event,

3247

{

3248

"fileId": "A String", # ID of the attached file. Read-only.

3249

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3250

"fileUrl": "A String", # URL link to the attachment.

3251

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3252

# Required when adding an attachment.

3253

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3254

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3255

"title": "A String", # Attachment title.

3256

},

3257

],

3258

"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.

3259

{

3260

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3261

"comment": "A String", # The attendee's response comment. Optional.

3262

"displayName": "A String", # The attendee's name, if available. Optional.

3263

"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.

3264

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3265

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3266

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3267

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3268

"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.

3269

"responseStatus": "A String", # The attendee's response status. Possible values are:

3270

# - "needsAction" - The attendee has not responded to the invitation.

3271

# - "declined" - The attendee has declined the invitation.

3272

# - "tentative" - The attendee has tentatively accepted the invitation.

3273

# - "accepted" - The attendee has accepted the invitation.

3274

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3275

},

3276

],

3277

"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.

3278

"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.

3279

"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.

3280

"conferenceId": "A String", # The ID of the conference.

3281

# 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]

3282

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3283

# - eventHangout: ID is not set. (This conference type is deprecated.)

3284

# - 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]

3285

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

3286

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3287

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3288

# Unset for a conference with a failed create request.

3289

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3290

"iconUri": "A String", # The user-visible icon for this solution.

3291

"key": { # The key which can uniquely identify the conference solution for this event.

3292

"type": "A String", # The conference solution type.

3293

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3294

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3295

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3296

# - "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]

3297

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3298

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3299

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3300

"name": "A String", # The user-visible name of this solution. Not localized.

3301

},

3302

"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.

3303

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3304

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3305

"type": "A String", # The conference solution type.

3306

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3307

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3308

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3309

# - "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]

3310

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3311

# - "addOn" for 3P conference providers

3312

},

3313

"requestId": "A String", # The client-generated unique ID for this request.

3314

# 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.

3315

"status": { # The status of the conference create request.

3316

"statusCode": "A String", # The current status of the conference create request. Read-only.

3317

# The possible values are:

3318

# - "pending": the conference create request is still being processed.

3319

# - "success": the conference create request succeeded, the entry points are populated.

3320

# - "failure": the conference create request failed, there are no entry points.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3321

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

3322

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3323

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3324

# All of them must belong to the same conference.

3325

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3326

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3327

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3328

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3329

# Optional.

3330

"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.

3331

"A String",

3332

],

3333

"entryPointType": "A String", # The type of the conference entry point.

3334

# Possible values are:

3335

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3336

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3337

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3338

# - "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.

3339

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3340

# Examples:

3341

# - for video: meet.google.com/aaa-bbbb-ccc

3342

# - for phone: +1 123 268 2601

3343

# - for sip: 12345678@altostrat.com

3344

# - for more: should not be filled

3345

# Optional.

3346

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3347

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3348

# Optional.

3349

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3350

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3351

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3352

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3353

# Optional.

3354

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3355

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3356

# Optional.

3357

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3358

# Calendar backend will populate this field only for EntryPointType.PHONE.

3359

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3360

# Format:

3361

# - for video, http: or https: schema is required.

3362

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3363

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3364

# - for more, http: or https: schema is required.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3365

},

3366

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3367

"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.

3368

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3369

"addOnParameters": { # Additional add-on specific data.

3370

"parameters": {

3371

"a_key": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3372

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3373

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3374

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3375

"signature": "A String", # The signature of the conference data.

3376

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3377

# Unset for a conference with a failed create request.

3378

# Optional for a conference with a pending create request.

3379

},

3380

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3381

"creator": { # The creator of the event. Read-only.

3382

"displayName": "A String", # The creator's name, if available.

3383

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3384

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3385

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3386

},

3387

"description": "A String", # Description of the event. Can contain HTML. Optional.

3388

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3389

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3390

"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.

3391

"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.

3392

},

3393

"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.

3394

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3395

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

3396

# - "default" - A regular event or not further specified.

3397

# - "outOfOffice" - An out-of-office event.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

3398

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3399

"extendedProperties": { # Extended properties of the event.

3400

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3401

"a_key": "A String", # The name of the private property and the corresponding value.

3402

},

3403

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3404

"a_key": "A String", # The name of the shared property and the corresponding value.

3405

},

3406

},

3407

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3408

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3409

# - "icon" - The gadget displays next to the event's title in the calendar view.

3410

# - "chip" - The gadget displays when the event is clicked.

3411

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3412

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3413

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3414

"preferences": { # Preferences.

3415

"a_key": "A String", # The preference name and corresponding value.

3416

},

3417

"title": "A String", # The gadget's title. Deprecated.

3418

"type": "A String", # The gadget's type. Deprecated.

3419

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3420

},

3421

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3422

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3423

"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]

3424

"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]

3425

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3426

"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.

3427

# 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.

3428

"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:

3429

# - 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

3430

# - the length of the ID must be between 5 and 1024 characters

3431

# - 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.

3432

# If you do not specify an ID, it will be automatically generated by the server.

3433

# 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.

3434

"kind": "calendar#event", # Type of the resource ("calendar#event").

3435

"location": "A String", # Geographic location of the event as free-form text. Optional.

3436

"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.

3437

"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.

3438

"displayName": "A String", # The organizer's name, if available.

3439

"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]

3440

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3441

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3442

},

3443

"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.

3444

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3445

"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.

3446

"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.

3447

},

3448

"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.

3449

"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.

3450

"A String",

3451

],

3452

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3453

"reminders": { # Information about the event's reminders for the authenticated user.

3454

"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]

3455

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3456

"method": "A String", # The method used by this reminder. Possible values are:

3457

# - "email" - Reminders are sent via email.

3458

# - "popup" - Reminders are sent via a UI popup.

3459

# Required when adding a reminder.

3460

"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).

3461

# Required when adding a reminder.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3462

},

3463

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3464

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3465

},

3466

"sequence": 42, # Sequence number as per iCalendar.

3467

"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.

3468

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3469

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3470

},

3471

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3472

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3473

"dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.

3474

"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.

3475

},

3476

"status": "A String", # Status of the event. Optional. Possible values are:

3477

# - "confirmed" - The event is confirmed. This is the default status.

3478

# - "tentative" - The event is tentatively confirmed.

3479

# - "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.

3480

# A cancelled status represents two different states depending on the event type:

3481

# - 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.

3482

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3483

# - 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.

3484

# 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.

3485

# 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.

3486

"summary": "A String", # Title of the event.

3487

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3488

# - "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.

3489

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3490

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3491

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3492

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3493

# - "public" - The event is public and event details are visible to all readers of the calendar.

3494

# - "private" - The event is private and only event attendees may view event details.

3495

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3496

}

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3497

3498

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]

3499

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.

3500

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]

3501

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

3502

3503

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]

3504

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

3505

Allowed values

3506

all - Notifications are sent to all guests.

3507

externalOnly - Notifications are sent to non-Google Calendar guests only.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

3508

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]

3509

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]

3510

3511

Returns:

3512

An object of the form:

3513

3514

{

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3515

"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]

3516

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3517

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3518

# There can be at most 25 attachments per event,

3519

{

3520

"fileId": "A String", # ID of the attached file. Read-only.

3521

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3522

"fileUrl": "A String", # URL link to the attachment.

3523

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3524

# Required when adding an attachment.

3525

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3526

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3527

"title": "A String", # Attachment title.

3528

},

3529

],

3530

"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.

3531

{

3532

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3533

"comment": "A String", # The attendee's response comment. Optional.

3534

"displayName": "A String", # The attendee's name, if available. Optional.

3535

"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.

3536

# Required when adding an attendee.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3537

"id": "A String", # The attendee's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3538

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3539

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3540

"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.

3541

"responseStatus": "A String", # The attendee's response status. Possible values are:

3542

# - "needsAction" - The attendee has not responded to the invitation.

3543

# - "declined" - The attendee has declined the invitation.

3544

# - "tentative" - The attendee has tentatively accepted the invitation.

3545

# - "accepted" - The attendee has accepted the invitation.

3546

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3547

},

3548

],

3549

"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.

3550

"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.

3551

"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.

3552

"conferenceId": "A String", # The ID of the conference.

3553

# 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]

3554

# The ID value is formed differently for each conference solution type:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3555

# - eventHangout: ID is not set. (This conference type is deprecated.)

3556

# - 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]

3557

# - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.

3558

# - addOn: ID is defined by the third-party provider. Optional.

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3559

"conferenceSolution": { # The conference solution, such as Google Meet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3560

# Unset for a conference with a failed create request.

3561

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3562

"iconUri": "A String", # The user-visible icon for this solution.

3563

"key": { # The key which can uniquely identify the conference solution for this event.

3564

"type": "A String", # The conference solution type.

3565

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3566

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3567

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3568

# - "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]

3569

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3570

# - "addOn" for 3P conference providers

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3571

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3572

"name": "A String", # The user-visible name of this solution. Not localized.

3573

},

3574

"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.

3575

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3576

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3577

"type": "A String", # The conference solution type.

3578

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3579

# The possible values are:

yoshi-code-bot

2021-08-17 00:20:40 -0700

[diff] [blame]

3580

# - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)

3581

# - "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]

3582

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3583

# - "addOn" for 3P conference providers

3584

},

3585

"requestId": "A String", # The client-generated unique ID for this request.

3586

# 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.

3587

"status": { # The status of the conference create request.

3588

"statusCode": "A String", # The current status of the conference create request. Read-only.

3589

# The possible values are:

3590

# - "pending": the conference create request is still being processed.

3591

# - "success": the conference create request succeeded, the entry points are populated.

3592

# - "failure": the conference create request failed, there are no entry points.

3593

},

3594

},

3595

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3596

# All of them must belong to the same conference.

3597

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3598

{

3599

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3600

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3601

# Optional.

3602

"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.

3603

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3604

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3605

"entryPointType": "A String", # The type of the conference entry point.

3606

# Possible values are:

3607

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3608

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3609

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3610

# - "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.

3611

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3612

# Examples:

3613

# - for video: meet.google.com/aaa-bbbb-ccc

3614

# - for phone: +1 123 268 2601

3615

# - for sip: 12345678@altostrat.com

3616

# - for more: should not be filled

3617

# Optional.

3618

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3619

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3620

# Optional.

3621

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3622

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3623

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3624

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3625

# Optional.

3626

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3627

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3628

# Optional.

3629

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3630

# Calendar backend will populate this field only for EntryPointType.PHONE.

3631

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3632

# Format:

3633

# - for video, http: or https: schema is required.

3634

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3635

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3636

# - for more, http: or https: schema is required.

3637

},

3638

],

3639

"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.

3640

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3641

"addOnParameters": { # Additional add-on specific data.

3642

"parameters": {

3643

"a_key": "A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3644

},

3645

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3646

},

3647

"signature": "A String", # The signature of the conference data.

3648

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3649

# Unset for a conference with a failed create request.

3650

# Optional for a conference with a pending create request.

3651

},

3652

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3653

"creator": { # The creator of the event. Read-only.

3654

"displayName": "A String", # The creator's name, if available.

3655

"email": "A String", # The creator's email address, if available.

yoshi-code-bot

2021-07-13 00:20:24 -0700

[diff] [blame]

3656

"id": "A String", # The creator's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3657

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3658

},

3659

"description": "A String", # Description of the event. Can contain HTML. Optional.

3660

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3661

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3662

"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.

3663

"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.

3664

},

3665

"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.

3666

"etag": "A String", # ETag of the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3667

"eventType": "default", # Specific type of the event. Read-only. Possible values are:

3668

# - "default" - A regular event or not further specified.

3669

# - "outOfOffice" - An out-of-office event.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame^]

3670

# - "focusTime" - A focus-time event.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3671

"extendedProperties": { # Extended properties of the event.

3672

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3673

"a_key": "A String", # The name of the private property and the corresponding value.

3674

},

3675

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3676

"a_key": "A String", # The name of the shared property and the corresponding value.

3677

},

3678

},

3679

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3680

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3681

# - "icon" - The gadget displays next to the event's title in the calendar view.

3682

# - "chip" - The gadget displays when the event is clicked.

3683

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3684

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3685

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3686

"preferences": { # Preferences.

3687

"a_key": "A String", # The preference name and corresponding value.

3688

},

3689

"title": "A String", # The gadget's title. Deprecated.

3690

"type": "A String", # The gadget's type. Deprecated.

3691

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3692

},

3693

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3694

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3695

"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]

3696

"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]

3697

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3698

"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.

3699

# 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.

3700

"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:

3701

# - 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

3702

# - the length of the ID must be between 5 and 1024 characters

3703

# - 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.

3704

# If you do not specify an ID, it will be automatically generated by the server.

3705

# 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.

3706

"kind": "calendar#event", # Type of the resource ("calendar#event").

3707

"location": "A String", # Geographic location of the event as free-form text. Optional.

3708

"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.

3709

"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.

3710

"displayName": "A String", # The organizer's name, if available.

3711

"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]

3712

"id": "A String", # The organizer's Profile ID, if available.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3713

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3714

},

3715

"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.

3716

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3717

"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.

3718

"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.

3719

},

3720

"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.

3721

"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.

3722

"A String",

3723

],

3724

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3725

"reminders": { # Information about the event's reminders for the authenticated user.

3726

"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.

3727

{

3728

"method": "A String", # The method used by this reminder. Possible values are:

3729

# - "email" - Reminders are sent via email.

3730

# - "popup" - Reminders are sent via a UI popup.

3731

# Required when adding a reminder.

3732

"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).

3733

# Required when adding a reminder.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3734

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3735

],

3736

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3737

},

3738

"sequence": 42, # Sequence number as per iCalendar.

3739

"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.

3740

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3741

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3742

},

3743

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3744

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3745

"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.

3746

"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.

3747

},

3748

"status": "A String", # Status of the event. Optional. Possible values are:

3749

# - "confirmed" - The event is confirmed. This is the default status.

3750

# - "tentative" - The event is tentatively confirmed.

3751

# - "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.

3752

# A cancelled status represents two different states depending on the event type:

3753

# - 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.

3754

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3755

# - 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.

3756

# 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.

3757

# 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.

3758

"summary": "A String", # Title of the event.

3759

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3760

# - "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.

3761

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3762

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3763

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3764

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3765

# - "public" - The event is public and event details are visible to all readers of the calendar.

3766

# - "private" - The event is private and only event attendees may view event details.

3767

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3768

}</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]

3772

<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]

3773

<pre>Watch for changes to Events resources.

3774

3775

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3776

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]

3777

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3778

The object takes the form of:

3779

3780

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3781

"address": "A String", # The address where notifications are delivered for this channel.

3782

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

3783

"id": "A String", # A UUID or similar unique string that identifies this channel.

3784

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

3785

"params": { # Additional parameters controlling delivery channel behavior. Optional.

3786

"a_key": "A String", # Declares a new parameter by name.

3787

},

3788

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

3789

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

3790

"resourceUri": "A String", # A version-specific identifier for the watched resource.

3791

"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]

3792

"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]

3793

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3794

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3795

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]

3796

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]

3797

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.

3798

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]

3799

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

3800

Allowed values

3801

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

3802

updated - Order by last modification time (ascending).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3803

pageToken: string, Token specifying which result page to return. Optional.

3804

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)

3805

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]

3806

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]

3807

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.

3808

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

3809

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]

3810

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.

3811

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

3817

- q

3818

- sharedExtendedProperty

3819

- timeMin

3820

- timeMax

3821

- 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.

3822

Learn more about incremental synchronization.

3823

Optional. The default is to return all entries.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3824

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.

3825

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.

3826

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

3827

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]

3828

3829

Returns:

3830

An object of the form:

3831

3832

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3833

"address": "A String", # The address where notifications are delivered for this channel.

3834

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

3835

"id": "A String", # A UUID or similar unique string that identifies this channel.

3836

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

3837

"params": { # Additional parameters controlling delivery channel behavior. Optional.

3838

"a_key": "A String", # Declares a new parameter by name.

3839

},

3840

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

3841

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

3842

"resourceUri": "A String", # A version-specific identifier for the watched resource.

3843

"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]

3844

"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]

3845

}</pre>

John Asmuth