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

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

[diff] [blame]

88

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

89

Bu Sun Kim

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

[diff] [blame]

90

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

91

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

92

93

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

94

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

95

Bu Sun Kim

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

[diff] [blame]

96

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

97

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

98

99

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

100

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

101

Bu Sun Kim

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

[diff] [blame]

102

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

John Asmuth

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

[diff] [blame]

103

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

104

Bu Sun Kim

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

[diff] [blame]

105

<code><a href="#patch">patch(calendarId, eventId, body=None, alwaysIncludeEmail=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]

106

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

107

Bu Sun Kim

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

[diff] [blame]

108

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

109

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

110

Bu Sun Kim

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

[diff] [blame]

111

<code><a href="#update">update(calendarId, eventId, body=None, alwaysIncludeEmail=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]

112

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

113

Bu Sun Kim

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

[diff] [blame]

114

<code><a href="#watch">watch(calendarId, body=None, 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]

115

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

116

<h3>Method Details</h3>

117

Bu Sun Kim

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

[diff] [blame]

118

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

John Asmuth

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

[diff] [blame]

119

<pre>Deletes an event.

120

121

Args:

Bu Sun Kim

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

[diff] [blame]

122

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

John Asmuth

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

[diff] [blame]

123

eventId: string, Event identifier. (required)

Bu Sun Kim

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

[diff] [blame]

124

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

125

126

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.

127

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

128

Allowed values

129

all - Notifications are sent to all guests.

130

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

131

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

John Asmuth

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

[diff] [blame]

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

136

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

137

<pre>Returns an event.

138

139

Args:

Bu Sun Kim

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

[diff] [blame]

140

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

John Asmuth

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

[diff] [blame]

141

eventId: string, Event identifier. (required)

Dan O'Meara

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

[diff] [blame]

142

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

John Asmuth

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

[diff] [blame]

143

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

Bu Sun Kim

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

[diff] [blame]

144

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]

145

146

Returns:

147

An object of the form:

148

149

{

Bu Sun Kim

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

[diff] [blame]

150

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

151

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

152

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

153

# There can be at most 25 attachments per event,

154

{

155

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

156

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

157

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

158

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

159

# Required when adding an attachment.

160

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

161

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

162

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

163

},

164

],

165

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

166

{

167

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

168

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

169

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

170

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

171

# Required when adding an attendee.

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

},

183

],

184

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

185

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

186

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

187

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

188

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

189

# Values for solution types:

190

# - "eventHangout": unset.

191

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

192

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

193

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

194

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

195

# Unset for a conference with a failed create request.

196

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

197

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

198

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

199

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

200

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

201

# The possible values are:

202

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

203

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

204

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

Bu Sun Kim

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

[diff] [blame]

205

# - "addOn" for 3P conference providers

206

},

207

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

208

},

209

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

210

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

211

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

212

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

213

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

214

# The possible values are:

215

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

216

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

217

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

Bu Sun Kim

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

[diff] [blame]

218

# - "addOn" for 3P conference providers

219

},

220

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

221

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

222

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

223

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

224

# The possible values are:

225

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

226

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

227

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

228

},

229

},

230

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

231

# All of them must belong to the same conference.

232

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

Takashi Matsuo

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

[diff] [blame]

233

{

Bu Sun Kim

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

[diff] [blame]

234

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

235

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

236

# Optional.

237

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

238

"A String",

239

],

240

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

241

# Possible values are:

242

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

243

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

244

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

245

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

246

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

247

# Examples:

248

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

249

# - for phone: +1 123 268 2601

250

# - for sip: 12345678@altostrat.com

251

# - for more: should not be filled

252

# Optional.

253

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

254

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

255

# Optional.

256

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

257

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

258

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

259

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

260

# Optional.

261

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

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

265

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

266

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

267

# Format:

268

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

269

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

270

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

271

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

Takashi Matsuo

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

[diff] [blame]

272

},

273

],

Bu Sun Kim

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

[diff] [blame]

274

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

275

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

276

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

"parameters": {

"a_key": "A String",

},

},

John Asmuth

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

[diff] [blame]

281

},

Bu Sun Kim

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

[diff] [blame]

282

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

283

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

284

# Unset for a conference with a failed create request.

285

# Optional for a conference with a pending create request.

286

},

287

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

288

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

289

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

290

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

291

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

292

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

293

},

294

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

295

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

296

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

297

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

298

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

299

},

300

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

301

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

302

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

303

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

304

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

John Asmuth

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

[diff] [blame]

305

},

Bu Sun Kim

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

[diff] [blame]

306

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

307

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

308

},

309

},

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

"preferences": { # Preferences.

318

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

319

},

320

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

321

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

322

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

323

},

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

},

346

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

347

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

348

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

349

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

350

},

351

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

352

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

353

"A String",

354

],

355

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

356

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

357

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

John Asmuth

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

[diff] [blame]

358

{

Bu Sun Kim

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

[diff] [blame]

359

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

360

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

361

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

362

# Required when adding a reminder.

363

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

364

# Required when adding a reminder.

John Asmuth

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

[diff] [blame]

365

},

366

],

Bu Sun Kim

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

[diff] [blame]

367

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

368

},

369

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

370

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

371

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

372

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

373

},

374

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

375

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

376

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

377

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

378

},

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

403

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

404

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

405

406

Args:

Bu Sun Kim

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

[diff] [blame]

407

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

Dan O'Meara

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

[diff] [blame]

408

body: object, The request body.

John Asmuth

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

[diff] [blame]

409

The object takes the form of:

410

411

{

Bu Sun Kim

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

[diff] [blame]

412

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

413

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

414

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

415

# There can be at most 25 attachments per event,

416

{

417

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

418

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

419

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

420

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

421

# Required when adding an attachment.

422

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

423

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

424

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

425

},

426

],

427

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

428

{

429

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

430

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

431

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

432

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

433

# Required when adding an attendee.

434

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

435

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

436

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

437

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

438

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

439

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

440

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

441

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

442

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

443

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

444

},

445

],

446

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

447

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

448

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

449

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

450

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

451

# Values for solution types:

452

# - "eventHangout": unset.

453

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

454

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

455

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

456

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

457

# Unset for a conference with a failed create request.

458

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

459

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

460

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

461

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

462

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

463

# The possible values are:

464

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

465

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

466

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

Bu Sun Kim

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

[diff] [blame]

467

# - "addOn" for 3P conference providers

468

},

469

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

470

},

471

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

472

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

473

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

474

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

475

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

476

# The possible values are:

477

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

478

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

479

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

Bu Sun Kim

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

[diff] [blame]

480

# - "addOn" for 3P conference providers

481

},

482

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

483

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

484

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

485

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

486

# The possible values are:

487

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

488

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

489

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

490

},

491

},

492

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

493

# All of them must belong to the same conference.

494

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

Takashi Matsuo

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

[diff] [blame]

495

{

Bu Sun Kim

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

[diff] [blame]

496

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

497

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

498

# Optional.

499

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

500

"A String",

501

],

502

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

503

# Possible values are:

504

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

505

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

506

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

507

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

508

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

509

# Examples:

510

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

511

# - for phone: +1 123 268 2601

512

# - for sip: 12345678@altostrat.com

513

# - for more: should not be filled

514

# Optional.

515

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

516

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

517

# Optional.

518

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

519

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

520

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

521

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

522

# Optional.

523

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

524

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

525

# Optional.

526

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

527

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

528

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

529

# Format:

530

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

531

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

532

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

533

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

Takashi Matsuo

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

[diff] [blame]

534

},

535

],

Bu Sun Kim

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

[diff] [blame]

536

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

537

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

538

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

"parameters": {

"a_key": "A String",

},

},

John Asmuth

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

[diff] [blame]

543

},

Bu Sun Kim

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

[diff] [blame]

544

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

545

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

546

# Unset for a conference with a failed create request.

547

# Optional for a conference with a pending create request.

548

},

549

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

550

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

551

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

552

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

553

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

554

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

555

},

556

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

557

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

558

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

559

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

560

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

561

},

562

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

563

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

564

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

565

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

566

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

John Asmuth

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

[diff] [blame]

567

},

Bu Sun Kim

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

[diff] [blame]

568

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

569

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

570

},

571

},

572

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

573

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

574

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

575

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

576

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

577

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

578

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

579

"preferences": { # Preferences.

580

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

581

},

582

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

583

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

584

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

585

},

586

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

587

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

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

},

608

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

609

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

610

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

611

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

612

},

613

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

614

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

615

"A String",

616

],

617

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

618

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

619

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

John Asmuth

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

[diff] [blame]

620

{

Bu Sun Kim

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

[diff] [blame]

621

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

622

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

623

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

624

# Required when adding a reminder.

625

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

626

# Required when adding a reminder.

John Asmuth

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

[diff] [blame]

627

},

628

],

Bu Sun Kim

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

[diff] [blame]

629

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

630

},

631

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

632

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

633

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

634

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

635

},

636

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

637

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

638

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

639

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

640

},

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

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

661

}

John Asmuth

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

[diff] [blame]

662

Bu Sun Kim

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

[diff] [blame]

663

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.

Takashi Matsuo

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

[diff] [blame]

664

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

John Asmuth

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

[diff] [blame]

665

666

Returns:

667

An object of the form:

668

669

{

Bu Sun Kim

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

[diff] [blame]

670

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

671

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

Takashi Matsuo

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

[diff] [blame]

672

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

673

# There can be at most 25 attachments per event,

674

{

Bu Sun Kim

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

[diff] [blame]

675

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

676

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

677

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

Takashi Matsuo

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

[diff] [blame]

678

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

Bu Sun Kim

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

[diff] [blame]

679

# Required when adding an attachment.

Bu Sun Kim

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

[diff] [blame]

680

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

681

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

682

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

Takashi Matsuo

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

[diff] [blame]

683

},

684

],

Bu Sun Kim

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

[diff] [blame]

685

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

John Asmuth

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

[diff] [blame]

686

{

Bu Sun Kim

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

[diff] [blame]

687

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

688

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

689

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

690

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

Bu Sun Kim

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

[diff] [blame]

691

# Required when adding an attendee.

Bu Sun Kim

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

[diff] [blame]

692

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

693

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

694

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

695

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

696

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

697

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

698

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

699

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

700

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

701

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

John Asmuth

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

[diff] [blame]

702

},

703

],

Bu Sun Kim

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

[diff] [blame]

704

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

705

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

706

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

707

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

708

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

709

# Values for solution types:

710

# - "eventHangout": unset.

711

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

712

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

713

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

714

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

715

# Unset for a conference with a failed create request.

716

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

717

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

718

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

719

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

720

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

721

# The possible values are:

722

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

723

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

724

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

Bu Sun Kim

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

[diff] [blame]

725

# - "addOn" for 3P conference providers

John Asmuth

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

[diff] [blame]

726

},

Bu Sun Kim

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

[diff] [blame]

727

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

728

},

729

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

730

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

731

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

732

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

733

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

734

# The possible values are:

735

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

736

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

737

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

Bu Sun Kim

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

[diff] [blame]

738

# - "addOn" for 3P conference providers

739

},

740

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

741

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

742

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

743

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

744

# The possible values are:

745

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

746

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

747

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

748

},

749

},

750

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

Bu Sun Kim

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

[diff] [blame]

751

# All of them must belong to the same conference.

752

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

753

{

Bu Sun Kim

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

[diff] [blame]

754

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

Bu Sun Kim

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

[diff] [blame]

755

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

756

# Optional.

Bu Sun Kim

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

[diff] [blame]

757

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

758

"A String",

Bu Sun Kim

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

[diff] [blame]

759

],

Bu Sun Kim

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

[diff] [blame]

760

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

761

# Possible values are:

762

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

763

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

764

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

765

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

766

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

Bu Sun Kim

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

[diff] [blame]

767

# Examples:

768

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

769

# - for phone: +1 123 268 2601

770

# - for sip: 12345678@altostrat.com

771

# - for more: should not be filled

772

# Optional.

Bu Sun Kim

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

[diff] [blame]

773

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

Bu Sun Kim

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

[diff] [blame]

774

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

775

# Optional.

Bu Sun Kim

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

[diff] [blame]

776

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

777

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

778

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

779

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

780

# Optional.

781

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

782

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

783

# Optional.

784

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

785

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

786

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

787

# Format:

788

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

789

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

790

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

791

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

Bu Sun Kim

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

[diff] [blame]

792

},

793

],

Bu Sun Kim

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

[diff] [blame]

794

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

795

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

796

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

797

"parameters": {

798

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

799

},

800

},

801

},

Bu Sun Kim

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

[diff] [blame]

802

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

Bu Sun Kim

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

[diff] [blame]

803

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

804

# Unset for a conference with a failed create request.

805

# Optional for a conference with a pending create request.

806

},

Bu Sun Kim

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

[diff] [blame]

807

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

808

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

809

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

810

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

811

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

812

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

813

},

814

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

815

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

816

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

817

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

818

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

819

},

820

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

821

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

822

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

823

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

824

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

825

},

826

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

827

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

828

},

829

},

830

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

831

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

832

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

833

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

834

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

835

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

836

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

837

"preferences": { # Preferences.

838

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

839

},

840

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

841

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

842

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

843

},

844

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

845

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

846

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

847

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

848

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

849

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

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

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

861

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

862

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

863

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

864

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

865

},

866

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

867

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

868

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

869

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

870

},

871

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

872

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

873

"A String",

874

],

875

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

876

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

877

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

878

{

879

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

880

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

881

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

882

# Required when adding a reminder.

883

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

884

# Required when adding a reminder.

885

},

886

],

887

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

888

},

889

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

890

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

891

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

892

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

893

},

894

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

895

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

896

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

897

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

898

},

899

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

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

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

908

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

909

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

910

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

911

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

912

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

913

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

914

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

915

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

916

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

917

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

918

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

919

}</pre>

920

</div>

John Asmuth

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

[diff] [blame]

921

Bu Sun Kim

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

[diff] [blame]

922

923

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

924

<pre>Creates an event.

925

926

Args:

927

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

928

body: object, The request body.

929

The object takes the form of:

930

931

{

932

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

933

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

934

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

935

# There can be at most 25 attachments per event,

936

{

937

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

938

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

939

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

940

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

941

# Required when adding an attachment.

942

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

943

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

944

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

945

},

946

],

947

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

948

{

949

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

950

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

951

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

952

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

953

# Required when adding an attendee.

954

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

955

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

956

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

957

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

958

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

959

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

960

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

961

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

962

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

963

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

964

},

965

],

966

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

967

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

968

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

969

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

970

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

971

# Values for solution types:

972

# - "eventHangout": unset.

973

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

974

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

975

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

976

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

977

# Unset for a conference with a failed create request.

978

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

979

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

980

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

981

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

982

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

983

# The possible values are:

984

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

985

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

986

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

Bu Sun Kim

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

[diff] [blame]

987

# - "addOn" for 3P conference providers

988

},

989

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

990

},

991

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

992

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

993

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

994

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

995

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

996

# The possible values are:

997

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

998

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

999

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

Bu Sun Kim

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

[diff] [blame]

1000

# - "addOn" for 3P conference providers

1001

},

1002

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

1003

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

1004

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

1005

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

1006

# The possible values are:

1007

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

1008

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

1009

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

1010

},

1011

},

1012

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

1013

# All of them must belong to the same conference.

1014

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

1015

{

1016

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

1017

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

1018

# Optional.

1019

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

1020

"A String",

1021

],

1022

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

1023

# Possible values are:

1024

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

1025

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

1026

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

1027

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

1028

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

1029

# Examples:

1030

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

1031

# - for phone: +1 123 268 2601

1032

# - for sip: 12345678@altostrat.com

1033

# - for more: should not be filled

1034

# Optional.

1035

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

1036

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

1037

# Optional.

1038

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

1039

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

1040

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

1041

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

1042

# Optional.

1043

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

1044

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

1045

# Optional.

1046

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

1047

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

1048

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

1049

# Format:

1050

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

1051

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

1052

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

1053

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

1054

},

1055

],

1056

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

1057

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

1058

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

"parameters": {

"a_key": "A String",

},

},

},

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

1065

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

1066

# Unset for a conference with a failed create request.

1067

# Optional for a conference with a pending create request.

1068

},

1069

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

1070

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

1071

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

1072

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

1073

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

1074

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

1075

},

1076

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

1077

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

1078

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

1079

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

1080

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

1081

},

1082

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

1083

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

1084

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

1085

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

1086

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

1087

},

1088

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

1089

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

1090

},

1091

},

1092

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

1093

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

1094

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

1095

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

1096

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

1097

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

1098

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

1099

"preferences": { # Preferences.

1100

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

1101

},

1102

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

1103

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

1104

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

1105

},

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

"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:

1114

# - 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

1115

# - the length of the ID must be between 5 and 1024 characters

1116

# - 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.

1117

# If you do not specify an ID, it will be automatically generated by the server.

1118

# 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.

1119

"kind": "calendar#event", # Type of the resource ("calendar#event").

1120

"location": "A String", # Geographic location of the event as free-form text. Optional.

1121

"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.

1122

"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.

1123

"displayName": "A String", # The organizer's name, if available.

1124

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1125

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1126

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1127

},

1128

"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.

1129

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1130

"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.

1131

"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.

1132

},

1133

"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.

1134

"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.

1135

"A String",

1136

],

1137

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1138

"reminders": { # Information about the event's reminders for the authenticated user.

1139

"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.

1140

{

1141

"method": "A String", # The method used by this reminder. Possible values are:

1142

# - "email" - Reminders are sent via email.

1143

# - "popup" - Reminders are sent via a UI popup.

1144

# Required when adding a reminder.

1145

"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).

1146

# Required when adding a reminder.

1147

},

1148

],

1149

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1150

},

1151

"sequence": 42, # Sequence number as per iCalendar.

1152

"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.

1153

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1154

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1155

},

1156

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1157

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1158

"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.

1159

"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.

1160

},

1161

"status": "A String", # Status of the event. Optional. Possible values are:

1162

# - "confirmed" - The event is confirmed. This is the default status.

1163

# - "tentative" - The event is tentatively confirmed.

1164

# - "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.

1165

# A cancelled status represents two different states depending on the event type:

1166

# - 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.

1167

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1168

# - 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.

1169

# 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.

1170

# 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.

1171

"summary": "A String", # Title of the event.

1172

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1173

# - "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.

1174

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1175

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1176

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1177

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1178

# - "public" - The event is public and event details are visible to all readers of the calendar.

1179

# - "private" - The event is private and only event attendees may view event details.

1180

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1181

}

1182

1183

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.

1184

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1185

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

1186

1187

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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1188

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.

1189

Allowed values

1190

all - Notifications are sent to all guests.

1191

externalOnly - Notifications are sent to non-Google Calendar guests only.

1192

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1193

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1194

1195

Returns:

1196

An object of the form:

1197

1198

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1199

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1200

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1201

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1202

# There can be at most 25 attachments per event,

1203

{

1204

"fileId": "A String", # ID of the attached file. Read-only.

1205

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1206

"fileUrl": "A String", # URL link to the attachment.

1207

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1208

# Required when adding an attachment.

1209

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1210

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1211

"title": "A String", # Attachment title.

1212

},

1213

],

1214

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

1215

{

1216

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1217

"comment": "A String", # The attendee's response comment. Optional.

1218

"displayName": "A String", # The attendee's name, if available. Optional.

1219

"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.

1220

# Required when adding an attendee.

1221

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1222

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1223

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1224

"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.

1225

"responseStatus": "A String", # The attendee's response status. Possible values are:

1226

# - "needsAction" - The attendee has not responded to the invitation.

1227

# - "declined" - The attendee has declined the invitation.

1228

# - "tentative" - The attendee has tentatively accepted the invitation.

1229

# - "accepted" - The attendee has accepted the invitation.

1230

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1231

},

1232

],

1233

"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.

1234

"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.

1235

"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.

1236

"conferenceId": "A String", # The ID of the conference.

1237

# Can be used by developers to keep track of conferences, should not be displayed to users.

1238

# Values for solution types:

1239

# - "eventHangout": unset.

1240

# - "eventNamedHangout": the name of the Hangout.

1241

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1242

# - "addOn": defined by 3P conference provider. Optional.

1243

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1244

# Unset for a conference with a failed create request.

1245

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1246

"iconUri": "A String", # The user-visible icon for this solution.

1247

"key": { # The key which can uniquely identify the conference solution for this event.

1248

"type": "A String", # The conference solution type.

1249

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1250

# The possible values are:

1251

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1252

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1253

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1254

# - "addOn" for 3P conference providers

1255

},

1256

"name": "A String", # The user-visible name of this solution. Not localized.

1257

},

1258

"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.

1259

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1260

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1261

"type": "A String", # The conference solution type.

1262

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1263

# The possible values are:

1264

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1265

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1266

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1267

# - "addOn" for 3P conference providers

1268

},

1269

"requestId": "A String", # The client-generated unique ID for this request.

1270

# 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.

1271

"status": { # The status of the conference create request.

1272

"statusCode": "A String", # The current status of the conference create request. Read-only.

1273

# The possible values are:

1274

# - "pending": the conference create request is still being processed.

1275

# - "success": the conference create request succeeded, the entry points are populated.

1276

# - "failure": the conference create request failed, there are no entry points.

1277

},

1278

},

1279

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1280

# All of them must belong to the same conference.

1281

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1282

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1283

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1284

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1285

# Optional.

1286

"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.

1287

"A String",

1288

],

1289

"entryPointType": "A String", # The type of the conference entry point.

1290

# Possible values are:

1291

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1292

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1293

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1294

# - "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.

1295

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1296

# Examples:

1297

# - for video: meet.google.com/aaa-bbbb-ccc

1298

# - for phone: +1 123 268 2601

1299

# - for sip: 12345678@altostrat.com

1300

# - for more: should not be filled

1301

# Optional.

1302

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1303

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1304

# Optional.

1305

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1306

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1307

"password": "A String", # The password 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

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1311

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1312

# Optional.

1313

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1314

# Calendar backend will populate this field only for EntryPointType.PHONE.

1315

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1316

# Format:

1317

# - for video, http: or https: schema is required.

1318

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1319

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1320

# - for more, http: or https: schema is required.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1321

},

1322

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1323

"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.

1324

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1325

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1330

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1331

"signature": "A String", # The signature of the conference data.

1332

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1333

# Unset for a conference with a failed create request.

1334

# Optional for a conference with a pending create request.

1335

},

1336

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1337

"creator": { # The creator of the event. Read-only.

1338

"displayName": "A String", # The creator's name, if available.

1339

"email": "A String", # The creator's email address, if available.

1340

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1341

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1342

},

1343

"description": "A String", # Description of the event. Can contain HTML. Optional.

1344

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1345

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1346

"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.

1347

"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.

1348

},

1349

"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.

1350

"etag": "A String", # ETag of the resource.

1351

"extendedProperties": { # Extended properties of the event.

1352

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1353

"a_key": "A String", # The name of the private property and the corresponding value.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1354

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1355

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1356

"a_key": "A String", # The name of the shared property and the corresponding value.

1357

},

1358

},

1359

"gadget": { # A gadget that extends this event.

1360

"display": "A String", # The gadget's display mode. Optional. Possible values are:

1361

# - "icon" - The gadget displays next to the event's title in the calendar view.

1362

# - "chip" - The gadget displays when the event is clicked.

1363

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

1364

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

1365

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

1366

"preferences": { # Preferences.

1367

"a_key": "A String", # The preference name and corresponding value.

1368

},

1369

"title": "A String", # The gadget's title.

1370

"type": "A String", # The gadget's type.

1371

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

1372

},

1373

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1374

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1375

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1376

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1377

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1378

"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.

1379

# 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.

1380

"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:

1381

# - 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

1382

# - the length of the ID must be between 5 and 1024 characters

1383

# - 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.

1384

# If you do not specify an ID, it will be automatically generated by the server.

1385

# 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.

1386

"kind": "calendar#event", # Type of the resource ("calendar#event").

1387

"location": "A String", # Geographic location of the event as free-form text. Optional.

1388

"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.

1389

"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.

1390

"displayName": "A String", # The organizer's name, if available.

1391

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1392

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1393

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1394

},

1395

"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.

1396

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1397

"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.

1398

"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.

1399

},

1400

"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.

1401

"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.

1402

"A String",

1403

],

1404

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1405

"reminders": { # Information about the event's reminders for the authenticated user.

1406

"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1407

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1408

"method": "A String", # The method used by this reminder. Possible values are:

1409

# - "email" - Reminders are sent via email.

1410

# - "popup" - Reminders are sent via a UI popup.

1411

# Required when adding a reminder.

1412

"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).

1413

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1414

},

1415

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1416

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1417

},

1418

"sequence": 42, # Sequence number as per iCalendar.

1419

"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.

1420

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1421

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1422

},

1423

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

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

"status": "A String", # Status of the event. Optional. Possible values are:

1429

# - "confirmed" - The event is confirmed. This is the default status.

1430

# - "tentative" - The event is tentatively confirmed.

1431

# - "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.

1432

# A cancelled status represents two different states depending on the event type:

1433

# - 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.

1434

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1435

# - 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.

1436

# 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.

1437

# 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.

1438

"summary": "A String", # Title of the event.

1439

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1440

# - "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.

1441

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1442

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1443

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1444

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1445

# - "public" - The event is public and event details are visible to all readers of the calendar.

1446

# - "private" - The event is private and only event attendees may view event details.

1447

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1448

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1452

<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>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1453

<pre>Returns instances of the specified recurring event.

1454

1455

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1456

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1457

eventId: string, Recurring event identifier. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1458

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1459

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.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1460

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1461

originalStart: string, The original start time of the instance in the result. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1462

pageToken: string, Token specifying which result page to return. Optional.

1463

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.

1464

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.

1465

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.

1466

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]

1467

1468

Returns:

1469

An object of the form:

1470

1471

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1472

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1473

# - "none" - The user has no access.

1474

# - "freeBusyReader" - The user has read access to free/busy information.

1475

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1476

# - "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.

1477

# - "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.

1478

"defaultReminders": [ # The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1479

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1480

"method": "A String", # The method used by this reminder. Possible values are:

1481

# - "email" - Reminders are sent via email.

1482

# - "popup" - Reminders are sent via a UI popup.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1483

# Required when adding a reminder.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1484

"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1485

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1486

},

1487

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1488

"description": "A String", # Description of the calendar. Read-only.

1489

"etag": "A String", # ETag of the collection.

1490

"items": [ # List of events on the calendar.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1491

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1492

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1493

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1494

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1495

# There can be at most 25 attachments per event,

1496

{

1497

"fileId": "A String", # ID of the attached file. Read-only.

1498

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1499

"fileUrl": "A String", # URL link to the attachment.

1500

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1501

# Required when adding an attachment.

1502

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1503

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1504

"title": "A String", # Attachment title.

1505

},

1506

],

1507

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

1508

{

1509

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1510

"comment": "A String", # The attendee's response comment. Optional.

1511

"displayName": "A String", # The attendee's name, if available. Optional.

1512

"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.

1513

# Required when adding an attendee.

1514

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1515

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1516

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1517

"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.

1518

"responseStatus": "A String", # The attendee's response status. Possible values are:

1519

# - "needsAction" - The attendee has not responded to the invitation.

1520

# - "declined" - The attendee has declined the invitation.

1521

# - "tentative" - The attendee has tentatively accepted the invitation.

1522

# - "accepted" - The attendee has accepted the invitation.

1523

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1524

},

1525

],

1526

"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.

1527

"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.

1528

"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.

1529

"conferenceId": "A String", # The ID of the conference.

1530

# Can be used by developers to keep track of conferences, should not be displayed to users.

1531

# Values for solution types:

1532

# - "eventHangout": unset.

1533

# - "eventNamedHangout": the name of the Hangout.

1534

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1535

# - "addOn": defined by 3P conference provider. Optional.

1536

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1537

# Unset for a conference with a failed create request.

1538

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1539

"iconUri": "A String", # The user-visible icon for this solution.

1540

"key": { # The key which can uniquely identify the conference solution for this event.

1541

"type": "A String", # The conference solution type.

1542

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1543

# The possible values are:

1544

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1545

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1546

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1547

# - "addOn" for 3P conference providers

1548

},

1549

"name": "A String", # The user-visible name of this solution. Not localized.

1550

},

1551

"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.

1552

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1553

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1554

"type": "A String", # The conference solution type.

1555

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1556

# The possible values are:

1557

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1558

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1559

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1560

# - "addOn" for 3P conference providers

1561

},

1562

"requestId": "A String", # The client-generated unique ID for this request.

1563

# 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.

1564

"status": { # The status of the conference create request.

1565

"statusCode": "A String", # The current status of the conference create request. Read-only.

1566

# The possible values are:

1567

# - "pending": the conference create request is still being processed.

1568

# - "success": the conference create request succeeded, the entry points are populated.

1569

# - "failure": the conference create request failed, there are no entry points.

1570

},

1571

},

1572

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1573

# All of them must belong to the same conference.

1574

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1575

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1576

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1577

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1578

# Optional.

1579

"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.

1580

"A String",

1581

],

1582

"entryPointType": "A String", # The type of the conference entry point.

1583

# Possible values are:

1584

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1585

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1586

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1587

# - "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.

1588

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1589

# Examples:

1590

# - for video: meet.google.com/aaa-bbbb-ccc

1591

# - for phone: +1 123 268 2601

1592

# - for sip: 12345678@altostrat.com

1593

# - for more: should not be filled

1594

# Optional.

1595

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1596

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1597

# Optional.

1598

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1599

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1600

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1601

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1602

# Optional.

1603

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1604

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1605

# Optional.

1606

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1607

# Calendar backend will populate this field only for EntryPointType.PHONE.

1608

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1609

# Format:

1610

# - for video, http: or https: schema is required.

1611

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1612

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1613

# - for more, http: or https: schema is required.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1614

},

1615

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1616

"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.

1617

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1618

"addOnParameters": { # Additional add-on specific data.

1619

"parameters": {

1620

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1621

},

1622

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1623

},

1624

"signature": "A String", # The signature of the conference data.

1625

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1626

# Unset for a conference with a failed create request.

1627

# Optional for a conference with a pending create request.

1628

},

1629

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1630

"creator": { # The creator of the event. Read-only.

1631

"displayName": "A String", # The creator's name, if available.

1632

"email": "A String", # The creator's email address, if available.

1633

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1634

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1635

},

1636

"description": "A String", # Description of the event. Can contain HTML. Optional.

1637

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1638

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1639

"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.

1640

"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.

1641

},

1642

"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.

1643

"etag": "A String", # ETag of the resource.

1644

"extendedProperties": { # Extended properties of the event.

1645

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1646

"a_key": "A String", # The name of the private property and the corresponding value.

1647

},

1648

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1649

"a_key": "A String", # The name of the shared property and the corresponding value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1650

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1651

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1652

"gadget": { # A gadget that extends this event.

1653

"display": "A String", # The gadget's display mode. Optional. Possible values are:

1654

# - "icon" - The gadget displays next to the event's title in the calendar view.

1655

# - "chip" - The gadget displays when the event is clicked.

1656

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

1657

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

1658

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

1659

"preferences": { # Preferences.

1660

"a_key": "A String", # The preference name and corresponding value.

1661

},

1662

"title": "A String", # The gadget's title.

1663

"type": "A String", # The gadget's type.

1664

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

1665

},

1666

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1667

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1668

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1669

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1670

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1671

"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.

1672

# 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.

1673

"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:

1674

# - 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

1675

# - the length of the ID must be between 5 and 1024 characters

1676

# - 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.

1677

# If you do not specify an ID, it will be automatically generated by the server.

1678

# 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.

1679

"kind": "calendar#event", # Type of the resource ("calendar#event").

1680

"location": "A String", # Geographic location of the event as free-form text. Optional.

1681

"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.

1682

"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.

1683

"displayName": "A String", # The organizer's name, if available.

1684

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1685

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1686

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1687

},

1688

"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.

1689

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1690

"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.

1691

"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.

1692

},

1693

"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.

1694

"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.

1695

"A String",

1696

],

1697

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1698

"reminders": { # Information about the event's reminders for the authenticated user.

1699

"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.

1700

{

1701

"method": "A String", # The method used by this reminder. Possible values are:

1702

# - "email" - Reminders are sent via email.

1703

# - "popup" - Reminders are sent via a UI popup.

1704

# Required when adding a reminder.

1705

"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).

1706

# Required when adding a reminder.

1707

},

1708

],

1709

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1710

},

1711

"sequence": 42, # Sequence number as per iCalendar.

1712

"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.

1713

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1714

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1715

},

1716

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1717

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1718

"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.

1719

"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.

1720

},

1721

"status": "A String", # Status of the event. Optional. Possible values are:

1722

# - "confirmed" - The event is confirmed. This is the default status.

1723

# - "tentative" - The event is tentatively confirmed.

1724

# - "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.

1725

# A cancelled status represents two different states depending on the event type:

1726

# - 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.

1727

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1728

# - 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.

1729

# 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.

1730

# 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.

1731

"summary": "A String", # Title of the event.

1732

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1733

# - "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.

1734

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1735

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1736

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1737

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1738

# - "public" - The event is public and event details are visible to all readers of the calendar.

1739

# - "private" - The event is private and only event attendees may view event details.

1740

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1741

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1742

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1743

"kind": "calendar#events", # Type of the collection ("calendar#events").

1744

"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.

1745

"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.

1746

"summary": "A String", # Title of the calendar. Read-only.

1747

"timeZone": "A String", # The time zone of the calendar. Read-only.

1748

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="instances_next">instances_next(previous_request, previous_response)</code>

1754

<pre>Retrieves the next page of results.

1755

1756

Args:

1757

previous_request: The request for the previous page. (required)

1758

previous_response: The response from the request for the previous page. (required)

1759

1760

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1761

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1762

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1767

<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]

1768

<pre>Returns events on the specified calendar.

1769

1770

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1771

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

1772

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).

1773

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

1774

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.

1775

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1776

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

1777

Allowed values

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1778

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1779

updated - Order by last modification time (ascending).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1780

pageToken: string, Token specifying which result page to return. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1781

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)

1782

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1783

sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1784

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.

1785

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

1786

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

2014-08-14 00:47:23 -0700

[diff] [blame]

1787

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.

1788

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

1794

- q

1795

- sharedExtendedProperty

1796

- timeMin

1797

- timeMax

1798

- 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.

1799

Learn more about incremental synchronization.

1800

Optional. The default is to return all entries.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1801

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.

1802

timeMin: string, Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1803

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1804

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]

1805

1806

Returns:

1807

An object of the form:

1808

1809

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1810

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1811

# - "none" - The user has no access.

1812

# - "freeBusyReader" - The user has read access to free/busy information.

1813

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1814

# - "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.

1815

# - "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.

1816

"defaultReminders": [ # The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1817

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1818

"method": "A String", # The method used by this reminder. Possible values are:

1819

# - "email" - Reminders are sent via email.

1820

# - "popup" - Reminders are sent via a UI popup.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1821

# Required when adding a reminder.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1822

"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1823

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1824

},

1825

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1826

"description": "A String", # Description of the calendar. Read-only.

1827

"etag": "A String", # ETag of the collection.

1828

"items": [ # List of events on the calendar.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1829

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1830

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1831

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1832

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1833

# There can be at most 25 attachments per event,

1834

{

1835

"fileId": "A String", # ID of the attached file. Read-only.

1836

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1837

"fileUrl": "A String", # URL link to the attachment.

1838

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1839

# Required when adding an attachment.

1840

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1841

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1842

"title": "A String", # Attachment title.

1843

},

1844

],

1845

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

1846

{

1847

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1848

"comment": "A String", # The attendee's response comment. Optional.

1849

"displayName": "A String", # The attendee's name, if available. Optional.

1850

"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.

1851

# Required when adding an attendee.

1852

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1853

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1854

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1855

"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.

1856

"responseStatus": "A String", # The attendee's response status. Possible values are:

1857

# - "needsAction" - The attendee has not responded to the invitation.

1858

# - "declined" - The attendee has declined the invitation.

1859

# - "tentative" - The attendee has tentatively accepted the invitation.

1860

# - "accepted" - The attendee has accepted the invitation.

1861

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1862

},

1863

],

1864

"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.

1865

"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.

1866

"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.

1867

"conferenceId": "A String", # The ID of the conference.

1868

# Can be used by developers to keep track of conferences, should not be displayed to users.

1869

# Values for solution types:

1870

# - "eventHangout": unset.

1871

# - "eventNamedHangout": the name of the Hangout.

1872

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1873

# - "addOn": defined by 3P conference provider. Optional.

1874

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1875

# Unset for a conference with a failed create request.

1876

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1877

"iconUri": "A String", # The user-visible icon for this solution.

1878

"key": { # The key which can uniquely identify the conference solution for this event.

1879

"type": "A String", # The conference solution type.

1880

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1881

# The possible values are:

1882

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1883

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1884

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1885

# - "addOn" for 3P conference providers

1886

},

1887

"name": "A String", # The user-visible name of this solution. Not localized.

1888

},

1889

"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.

1890

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1891

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1892

"type": "A String", # The conference solution type.

1893

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1894

# The possible values are:

1895

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1896

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1897

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1898

# - "addOn" for 3P conference providers

1899

},

1900

"requestId": "A String", # The client-generated unique ID for this request.

1901

# 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.

1902

"status": { # The status of the conference create request.

1903

"statusCode": "A String", # The current status of the conference create request. Read-only.

1904

# The possible values are:

1905

# - "pending": the conference create request is still being processed.

1906

# - "success": the conference create request succeeded, the entry points are populated.

1907

# - "failure": the conference create request failed, there are no entry points.

1908

},

1909

},

1910

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1911

# All of them must belong to the same conference.

1912

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1913

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1914

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1915

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1916

# Optional.

1917

"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.

1918

"A String",

1919

],

1920

"entryPointType": "A String", # The type of the conference entry point.

1921

# Possible values are:

1922

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1923

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1924

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1925

# - "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.

1926

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1927

# Examples:

1928

# - for video: meet.google.com/aaa-bbbb-ccc

1929

# - for phone: +1 123 268 2601

1930

# - for sip: 12345678@altostrat.com

1931

# - for more: should not be filled

1932

# Optional.

1933

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1934

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1935

# Optional.

1936

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1937

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1938

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1939

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1940

# Optional.

1941

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1942

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1943

# Optional.

1944

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1945

# Calendar backend will populate this field only for EntryPointType.PHONE.

1946

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1947

# Format:

1948

# - for video, http: or https: schema is required.

1949

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1950

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1951

# - for more, http: or https: schema is required.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1952

},

1953

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1954

"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.

1955

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1956

"addOnParameters": { # Additional add-on specific data.

1957

"parameters": {

1958

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1959

},

1960

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1961

},

1962

"signature": "A String", # The signature of the conference data.

1963

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1964

# Unset for a conference with a failed create request.

1965

# Optional for a conference with a pending create request.

1966

},

1967

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1968

"creator": { # The creator of the event. Read-only.

1969

"displayName": "A String", # The creator's name, if available.

1970

"email": "A String", # The creator's email address, if available.

1971

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1972

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1973

},

1974

"description": "A String", # Description of the event. Can contain HTML. Optional.

1975

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1976

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1977

"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.

1978

"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.

1979

},

1980

"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.

1981

"etag": "A String", # ETag of the resource.

1982

"extendedProperties": { # Extended properties of the event.

1983

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1984

"a_key": "A String", # The name of the private property and the corresponding value.

1985

},

1986

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1987

"a_key": "A String", # The name of the shared property and the corresponding value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1988

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1989

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1990

"gadget": { # A gadget that extends this event.

1991

"display": "A String", # The gadget's display mode. Optional. Possible values are:

1992

# - "icon" - The gadget displays next to the event's title in the calendar view.

1993

# - "chip" - The gadget displays when the event is clicked.

1994

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

1995

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

1996

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

1997

"preferences": { # Preferences.

1998

"a_key": "A String", # The preference name and corresponding value.

1999

},

2000

"title": "A String", # The gadget's title.

2001

"type": "A String", # The gadget's type.

2002

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

2003

},

2004

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2005

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2006

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2007

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2008

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2009

"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.

2010

# 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.

2011

"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:

2012

# - 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

2013

# - the length of the ID must be between 5 and 1024 characters

2014

# - 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.

2015

# If you do not specify an ID, it will be automatically generated by the server.

2016

# 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.

2017

"kind": "calendar#event", # Type of the resource ("calendar#event").

2018

"location": "A String", # Geographic location of the event as free-form text. Optional.

2019

"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.

2020

"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.

2021

"displayName": "A String", # The organizer's name, if available.

2022

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2023

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2024

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2025

},

2026

"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.

2027

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2028

"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.

2029

"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.

2030

},

2031

"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.

2032

"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.

2033

"A String",

2034

],

2035

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2036

"reminders": { # Information about the event's reminders for the authenticated user.

2037

"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.

2038

{

2039

"method": "A String", # The method used by this reminder. Possible values are:

2040

# - "email" - Reminders are sent via email.

2041

# - "popup" - Reminders are sent via a UI popup.

2042

# Required when adding a reminder.

2043

"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).

2044

# Required when adding a reminder.

2045

},

2046

],

2047

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2048

},

2049

"sequence": 42, # Sequence number as per iCalendar.

2050

"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.

2051

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2052

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2053

},

2054

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2055

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2056

"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.

2057

"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.

2058

},

2059

"status": "A String", # Status of the event. Optional. Possible values are:

2060

# - "confirmed" - The event is confirmed. This is the default status.

2061

# - "tentative" - The event is tentatively confirmed.

2062

# - "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.

2063

# A cancelled status represents two different states depending on the event type:

2064

# - 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.

2065

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2066

# - 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.

2067

# 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.

2068

# 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.

2069

"summary": "A String", # Title of the event.

2070

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2071

# - "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.

2072

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2073

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2074

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2075

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2076

# - "public" - The event is public and event details are visible to all readers of the calendar.

2077

# - "private" - The event is private and only event attendees may view event details.

2078

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2079

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2080

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2081

"kind": "calendar#events", # Type of the collection ("calendar#events").

2082

"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.

2083

"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.

2084

"summary": "A String", # Title of the calendar. Read-only.

2085

"timeZone": "A String", # The time zone of the calendar. Read-only.

2086

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2092

<pre>Retrieves the next page of results.

2093

2094

Args:

2095

previous_request: The request for the previous page. (required)

2096

previous_response: The response from the request for the previous page. (required)

2097

2098

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2099

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2100

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2105

<code class="details" id="move">move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2106

<pre>Moves an event to another calendar, i.e. changes an event's organizer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2107

2108

Args:

2109

calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)

2110

eventId: string, Event identifier. (required)

2111

destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2112

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2113

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2114

Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.

2115

sendUpdates: string, Guests who should receive notifications about the change of the event's organizer.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2116

Allowed values

2117

all - Notifications are sent to all guests.

2118

externalOnly - Notifications are sent to non-Google Calendar guests only.

2119

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2120

2121

Returns:

2122

An object of the form:

2123

2124

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2125

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2126

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2127

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2128

# There can be at most 25 attachments per event,

2129

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2130

"fileId": "A String", # ID of the attached file. Read-only.

2131

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2132

"fileUrl": "A String", # URL link to the attachment.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2133

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2134

# Required when adding an attachment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2135

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2136

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2137

"title": "A String", # Attachment title.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2138

},

2139

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2140

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2141

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2142

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2143

"comment": "A String", # The attendee's response comment. Optional.

2144

"displayName": "A String", # The attendee's name, if available. Optional.

2145

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2146

# Required when adding an attendee.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2147

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2148

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2149

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2150

"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.

2151

"responseStatus": "A String", # The attendee's response status. Possible values are:

2152

# - "needsAction" - The attendee has not responded to the invitation.

2153

# - "declined" - The attendee has declined the invitation.

2154

# - "tentative" - The attendee has tentatively accepted the invitation.

2155

# - "accepted" - The attendee has accepted the invitation.

2156

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2157

},

2158

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2159

"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.

2160

"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.

2161

"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.

2162

"conferenceId": "A String", # The ID of the conference.

2163

# Can be used by developers to keep track of conferences, should not be displayed to users.

2164

# Values for solution types:

2165

# - "eventHangout": unset.

2166

# - "eventNamedHangout": the name of the Hangout.

2167

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2168

# - "addOn": defined by 3P conference provider. Optional.

2169

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2170

# Unset for a conference with a failed create request.

2171

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2172

"iconUri": "A String", # The user-visible icon for this solution.

2173

"key": { # The key which can uniquely identify the conference solution for this event.

2174

"type": "A String", # The conference solution type.

2175

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2176

# The possible values are:

2177

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2178

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2179

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2180

# - "addOn" for 3P conference providers

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2181

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2182

"name": "A String", # The user-visible name of this solution. Not localized.

2183

},

2184

"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.

2185

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2186

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2187

"type": "A String", # The conference solution type.

2188

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2189

# The possible values are:

2190

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2191

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2192

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2193

# - "addOn" for 3P conference providers

2194

},

2195

"requestId": "A String", # The client-generated unique ID for this request.

2196

# 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.

2197

"status": { # The status of the conference create request.

2198

"statusCode": "A String", # The current status of the conference create request. Read-only.

2199

# The possible values are:

2200

# - "pending": the conference create request is still being processed.

2201

# - "success": the conference create request succeeded, the entry points are populated.

2202

# - "failure": the conference create request failed, there are no entry points.

2203

},

2204

},

2205

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2206

# All of them must belong to the same conference.

2207

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2208

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2209

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2210

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2211

# Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2212

"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.

2213

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2214

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2215

"entryPointType": "A String", # The type of the conference entry point.

2216

# Possible values are:

2217

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2218

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2219

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2220

# - "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.

2221

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2222

# Examples:

2223

# - for video: meet.google.com/aaa-bbbb-ccc

2224

# - for phone: +1 123 268 2601

2225

# - for sip: 12345678@altostrat.com

2226

# - for more: should not be filled

2227

# Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2228

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2229

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2230

# Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2231

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2232

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2233

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2234

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2235

# Optional.

2236

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2237

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2238

# Optional.

2239

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2240

# Calendar backend will populate this field only for EntryPointType.PHONE.

2241

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2242

# Format:

2243

# - for video, http: or https: schema is required.

2244

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2245

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2246

# - for more, http: or https: schema is required.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2247

},

2248

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2249

"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.

2250

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2251

"addOnParameters": { # Additional add-on specific data.

2252

"parameters": {

2253

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2254

},

2255

},

2256

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2257

"signature": "A String", # The signature of the conference data.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2258

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2259

# Unset for a conference with a failed create request.

2260

# Optional for a conference with a pending create request.

2261

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2262

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2263

"creator": { # The creator of the event. Read-only.

2264

"displayName": "A String", # The creator's name, if available.

2265

"email": "A String", # The creator's email address, if available.

2266

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2267

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2268

},

2269

"description": "A String", # Description of the event. Can contain HTML. Optional.

2270

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2271

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2272

"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.

2273

"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.

2274

},

2275

"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.

2276

"etag": "A String", # ETag of the resource.

2277

"extendedProperties": { # Extended properties of the event.

2278

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2279

"a_key": "A String", # The name of the private property and the corresponding value.

2280

},

2281

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2282

"a_key": "A String", # The name of the shared property and the corresponding value.

2283

},

2284

},

2285

"gadget": { # A gadget that extends this event.

2286

"display": "A String", # The gadget's display mode. Optional. Possible values are:

2287

# - "icon" - The gadget displays next to the event's title in the calendar view.

2288

# - "chip" - The gadget displays when the event is clicked.

2289

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

2290

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

2291

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

2292

"preferences": { # Preferences.

2293

"a_key": "A String", # The preference name and corresponding value.

2294

},

2295

"title": "A String", # The gadget's title.

2296

"type": "A String", # The gadget's type.

2297

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

2298

},

2299

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2300

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2301

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2302

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2303

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2304

"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.

2305

# 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.

2306

"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:

2307

# - 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

2308

# - the length of the ID must be between 5 and 1024 characters

2309

# - 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.

2310

# If you do not specify an ID, it will be automatically generated by the server.

2311

# 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.

2312

"kind": "calendar#event", # Type of the resource ("calendar#event").

2313

"location": "A String", # Geographic location of the event as free-form text. Optional.

2314

"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.

2315

"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.

2316

"displayName": "A String", # The organizer's name, if available.

2317

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2318

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2319

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2320

},

2321

"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.

2322

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2323

"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.

2324

"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.

2325

},

2326

"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.

2327

"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.

2328

"A String",

2329

],

2330

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2331

"reminders": { # Information about the event's reminders for the authenticated user.

2332

"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.

2333

{

2334

"method": "A String", # The method used by this reminder. Possible values are:

2335

# - "email" - Reminders are sent via email.

2336

# - "popup" - Reminders are sent via a UI popup.

2337

# Required when adding a reminder.

2338

"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).

2339

# Required when adding a reminder.

2340

},

2341

],

2342

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2343

},

2344

"sequence": 42, # Sequence number as per iCalendar.

2345

"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.

2346

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2347

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2348

},

2349

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2350

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2351

"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.

2352

"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.

2353

},

2354

"status": "A String", # Status of the event. Optional. Possible values are:

2355

# - "confirmed" - The event is confirmed. This is the default status.

2356

# - "tentative" - The event is tentatively confirmed.

2357

# - "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.

2358

# A cancelled status represents two different states depending on the event type:

2359

# - 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.

2360

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2361

# - 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.

2362

# 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.

2363

# 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.

2364

"summary": "A String", # Title of the event.

2365

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2366

# - "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.

2367

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2368

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2369

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2370

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2371

# - "public" - The event is public and event details are visible to all readers of the calendar.

2372

# - "private" - The event is private and only event attendees may view event details.

2373

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2374

}</pre>

2375

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2376

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2377

2378

<code class="details" id="patch">patch(calendarId, eventId, body=None, alwaysIncludeEmail=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)</code>

2379

<pre>Updates an event. This method supports patch semantics.

2380

2381

Args:

2382

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

2383

eventId: string, Event identifier. (required)

2384

body: object, The request body.

2385

The object takes the form of:

2386

2387

{

2388

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2389

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2390

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2391

# There can be at most 25 attachments per event,

2392

{

2393

"fileId": "A String", # ID of the attached file. Read-only.

2394

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2395

"fileUrl": "A String", # URL link to the attachment.

2396

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2397

# Required when adding an attachment.

2398

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2399

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2400

"title": "A String", # Attachment title.

2401

},

2402

],

2403

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

2404

{

2405

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2406

"comment": "A String", # The attendee's response comment. Optional.

2407

"displayName": "A String", # The attendee's name, if available. Optional.

2408

"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.

2409

# Required when adding an attendee.

2410

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2411

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2412

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2413

"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.

2414

"responseStatus": "A String", # The attendee's response status. Possible values are:

2415

# - "needsAction" - The attendee has not responded to the invitation.

2416

# - "declined" - The attendee has declined the invitation.

2417

# - "tentative" - The attendee has tentatively accepted the invitation.

2418

# - "accepted" - The attendee has accepted the invitation.

2419

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2420

},

2421

],

2422

"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.

2423

"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.

2424

"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.

2425

"conferenceId": "A String", # The ID of the conference.

2426

# Can be used by developers to keep track of conferences, should not be displayed to users.

2427

# Values for solution types:

2428

# - "eventHangout": unset.

2429

# - "eventNamedHangout": the name of the Hangout.

2430

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2431

# - "addOn": defined by 3P conference provider. Optional.

2432

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2433

# Unset for a conference with a failed create request.

2434

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2435

"iconUri": "A String", # The user-visible icon for this solution.

2436

"key": { # The key which can uniquely identify the conference solution for this event.

2437

"type": "A String", # The conference solution type.

2438

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2439

# The possible values are:

2440

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2441

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2442

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2443

# - "addOn" for 3P conference providers

2444

},

2445

"name": "A String", # The user-visible name of this solution. Not localized.

2446

},

2447

"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.

2448

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2449

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2450

"type": "A String", # The conference solution type.

2451

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2452

# The possible values are:

2453

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2454

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2455

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2456

# - "addOn" for 3P conference providers

2457

},

2458

"requestId": "A String", # The client-generated unique ID for this request.

2459

# 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.

2460

"status": { # The status of the conference create request.

2461

"statusCode": "A String", # The current status of the conference create request. Read-only.

2462

# The possible values are:

2463

# - "pending": the conference create request is still being processed.

2464

# - "success": the conference create request succeeded, the entry points are populated.

2465

# - "failure": the conference create request failed, there are no entry points.

2466

},

2467

},

2468

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2469

# All of them must belong to the same conference.

2470

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2471

{

2472

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2473

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2474

# Optional.

2475

"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.

2476

"A String",

2477

],

2478

"entryPointType": "A String", # The type of the conference entry point.

2479

# Possible values are:

2480

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2481

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2482

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2483

# - "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.

2484

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2485

# Examples:

2486

# - for video: meet.google.com/aaa-bbbb-ccc

2487

# - for phone: +1 123 268 2601

2488

# - for sip: 12345678@altostrat.com

2489

# - for more: should not be filled

2490

# Optional.

2491

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2492

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2493

# Optional.

2494

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2495

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2496

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2497

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2498

# Optional.

2499

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2500

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2501

# Optional.

2502

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2503

# Calendar backend will populate this field only for EntryPointType.PHONE.

2504

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2505

# Format:

2506

# - for video, http: or https: schema is required.

2507

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2508

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2509

# - for more, http: or https: schema is required.

2510

},

2511

],

2512

"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.

2513

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2514

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"signature": "A String", # The signature of the conference data.

2521

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2522

# Unset for a conference with a failed create request.

2523

# Optional for a conference with a pending create request.

2524

},

2525

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2526

"creator": { # The creator of the event. Read-only.

2527

"displayName": "A String", # The creator's name, if available.

2528

"email": "A String", # The creator's email address, if available.

2529

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2530

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2531

},

2532

"description": "A String", # Description of the event. Can contain HTML. Optional.

2533

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2534

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2535

"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.

2536

"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.

2537

},

2538

"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.

2539

"etag": "A String", # ETag of the resource.

2540

"extendedProperties": { # Extended properties of the event.

2541

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2542

"a_key": "A String", # The name of the private property and the corresponding value.

2543

},

2544

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2545

"a_key": "A String", # The name of the shared property and the corresponding value.

2546

},

2547

},

2548

"gadget": { # A gadget that extends this event.

2549

"display": "A String", # The gadget's display mode. Optional. Possible values are:

2550

# - "icon" - The gadget displays next to the event's title in the calendar view.

2551

# - "chip" - The gadget displays when the event is clicked.

2552

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

2553

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

2554

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

2555

"preferences": { # Preferences.

2556

"a_key": "A String", # The preference name and corresponding value.

2557

},

2558

"title": "A String", # The gadget's title.

2559

"type": "A String", # The gadget's type.

2560

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

2561

},

2562

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2563

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2564

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2565

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2566

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2567

"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.

2568

# 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.

2569

"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:

2570

# - 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

2571

# - the length of the ID must be between 5 and 1024 characters

2572

# - 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.

2573

# If you do not specify an ID, it will be automatically generated by the server.

2574

# 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.

2575

"kind": "calendar#event", # Type of the resource ("calendar#event").

2576

"location": "A String", # Geographic location of the event as free-form text. Optional.

2577

"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.

2578

"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.

2579

"displayName": "A String", # The organizer's name, if available.

2580

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2581

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2582

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2583

},

2584

"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.

2585

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2586

"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.

2587

"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.

2588

},

2589

"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.

2590

"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.

2591

"A String",

2592

],

2593

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2594

"reminders": { # Information about the event's reminders for the authenticated user.

2595

"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.

2596

{

2597

"method": "A String", # The method used by this reminder. Possible values are:

2598

# - "email" - Reminders are sent via email.

2599

# - "popup" - Reminders are sent via a UI popup.

2600

# Required when adding a reminder.

2601

"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).

2602

# Required when adding a reminder.

2603

},

2604

],

2605

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2606

},

2607

"sequence": 42, # Sequence number as per iCalendar.

2608

"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.

2609

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2610

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2611

},

2612

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2613

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2614

"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.

2615

"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.

2616

},

2617

"status": "A String", # Status of the event. Optional. Possible values are:

2618

# - "confirmed" - The event is confirmed. This is the default status.

2619

# - "tentative" - The event is tentatively confirmed.

2620

# - "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.

2621

# A cancelled status represents two different states depending on the event type:

2622

# - 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.

2623

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2624

# - 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.

2625

# 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.

2626

# 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.

2627

"summary": "A String", # Title of the event.

2628

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2629

# - "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.

2630

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2631

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2632

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2633

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2634

# - "public" - The event is public and event details are visible to all readers of the calendar.

2635

# - "private" - The event is private and only event attendees may view event details.

2636

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2637

}

2638

2639

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).

2640

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.

2641

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2642

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2643

2644

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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2645

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

2646

Allowed values

2647

all - Notifications are sent to all guests.

2648

externalOnly - Notifications are sent to non-Google Calendar guests only.

2649

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2650

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2651

2652

Returns:

2653

An object of the form:

2654

2655

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2656

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2657

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2658

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2659

# There can be at most 25 attachments per event,

2660

{

2661

"fileId": "A String", # ID of the attached file. Read-only.

2662

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2663

"fileUrl": "A String", # URL link to the attachment.

2664

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2665

# Required when adding an attachment.

2666

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2667

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2668

"title": "A String", # Attachment title.

2669

},

2670

],

2671

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

2672

{

2673

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2674

"comment": "A String", # The attendee's response comment. Optional.

2675

"displayName": "A String", # The attendee's name, if available. Optional.

2676

"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.

2677

# Required when adding an attendee.

2678

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2679

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2680

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2681

"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.

2682

"responseStatus": "A String", # The attendee's response status. Possible values are:

2683

# - "needsAction" - The attendee has not responded to the invitation.

2684

# - "declined" - The attendee has declined the invitation.

2685

# - "tentative" - The attendee has tentatively accepted the invitation.

2686

# - "accepted" - The attendee has accepted the invitation.

2687

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2688

},

2689

],

2690

"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.

2691

"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.

2692

"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.

2693

"conferenceId": "A String", # The ID of the conference.

2694

# Can be used by developers to keep track of conferences, should not be displayed to users.

2695

# Values for solution types:

2696

# - "eventHangout": unset.

2697

# - "eventNamedHangout": the name of the Hangout.

2698

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2699

# - "addOn": defined by 3P conference provider. Optional.

2700

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2701

# Unset for a conference with a failed create request.

2702

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2703

"iconUri": "A String", # The user-visible icon for this solution.

2704

"key": { # The key which can uniquely identify the conference solution for this event.

2705

"type": "A String", # The conference solution type.

2706

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2707

# The possible values are:

2708

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2709

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2710

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2711

# - "addOn" for 3P conference providers

2712

},

2713

"name": "A String", # The user-visible name of this solution. Not localized.

2714

},

2715

"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.

2716

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2717

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2718

"type": "A String", # The conference solution type.

2719

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2720

# The possible values are:

2721

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2722

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2723

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2724

# - "addOn" for 3P conference providers

2725

},

2726

"requestId": "A String", # The client-generated unique ID for this request.

2727

# 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.

2728

"status": { # The status of the conference create request.

2729

"statusCode": "A String", # The current status of the conference create request. Read-only.

2730

# The possible values are:

2731

# - "pending": the conference create request is still being processed.

2732

# - "success": the conference create request succeeded, the entry points are populated.

2733

# - "failure": the conference create request failed, there are no entry points.

2734

},

2735

},

2736

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2737

# All of them must belong to the same conference.

2738

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2739

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2740

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2741

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2742

# Optional.

2743

"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.

2744

"A String",

2745

],

2746

"entryPointType": "A String", # The type of the conference entry point.

2747

# Possible values are:

2748

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2749

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2750

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2751

# - "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.

2752

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2753

# Examples:

2754

# - for video: meet.google.com/aaa-bbbb-ccc

2755

# - for phone: +1 123 268 2601

2756

# - for sip: 12345678@altostrat.com

2757

# - for more: should not be filled

2758

# Optional.

2759

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2760

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2761

# Optional.

2762

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2763

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2764

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2765

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2766

# Optional.

2767

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2768

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2769

# Optional.

2770

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2771

# Calendar backend will populate this field only for EntryPointType.PHONE.

2772

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2773

# Format:

2774

# - for video, http: or https: schema is required.

2775

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2776

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2777

# - for more, http: or https: schema is required.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2778

},

2779

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2780

"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.

2781

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2782

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2787

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2788

"signature": "A String", # The signature of the conference data.

2789

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2790

# Unset for a conference with a failed create request.

2791

# Optional for a conference with a pending create request.

2792

},

2793

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2794

"creator": { # The creator of the event. Read-only.

2795

"displayName": "A String", # The creator's name, if available.

2796

"email": "A String", # The creator's email address, if available.

2797

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2798

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2799

},

2800

"description": "A String", # Description of the event. Can contain HTML. Optional.

2801

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2802

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2803

"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.

2804

"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.

2805

},

2806

"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.

2807

"etag": "A String", # ETag of the resource.

2808

"extendedProperties": { # Extended properties of the event.

2809

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2810

"a_key": "A String", # The name of the private property and the corresponding value.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2811

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2812

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2813

"a_key": "A String", # The name of the shared property and the corresponding value.

2814

},

2815

},

2816

"gadget": { # A gadget that extends this event.

2817

"display": "A String", # The gadget's display mode. Optional. Possible values are:

2818

# - "icon" - The gadget displays next to the event's title in the calendar view.

2819

# - "chip" - The gadget displays when the event is clicked.

2820

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

2821

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

2822

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

2823

"preferences": { # Preferences.

2824

"a_key": "A String", # The preference name and corresponding value.

2825

},

2826

"title": "A String", # The gadget's title.

2827

"type": "A String", # The gadget's type.

2828

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

2829

},

2830

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2831

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2832

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2833

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2834

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2835

"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.

2836

# 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.

2837

"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:

2838

# - 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

2839

# - the length of the ID must be between 5 and 1024 characters

2840

# - 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.

2841

# If you do not specify an ID, it will be automatically generated by the server.

2842

# 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.

2843

"kind": "calendar#event", # Type of the resource ("calendar#event").

2844

"location": "A String", # Geographic location of the event as free-form text. Optional.

2845

"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.

2846

"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.

2847

"displayName": "A String", # The organizer's name, if available.

2848

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2849

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2850

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2851

},

2852

"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.

2853

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2854

"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.

2855

"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.

2856

},

2857

"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.

2858

"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.

2859

"A String",

2860

],

2861

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2862

"reminders": { # Information about the event's reminders for the authenticated user.

2863

"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2864

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2865

"method": "A String", # The method used by this reminder. Possible values are:

2866

# - "email" - Reminders are sent via email.

2867

# - "popup" - Reminders are sent via a UI popup.

2868

# Required when adding a reminder.

2869

"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).

2870

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2871

},

2872

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2873

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2874

},

2875

"sequence": 42, # Sequence number as per iCalendar.

2876

"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.

2877

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2878

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2879

},

2880

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2881

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2882

"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.

2883

"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.

2884

},

2885

"status": "A String", # Status of the event. Optional. Possible values are:

2886

# - "confirmed" - The event is confirmed. This is the default status.

2887

# - "tentative" - The event is tentatively confirmed.

2888

# - "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.

2889

# A cancelled status represents two different states depending on the event type:

2890

# - 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.

2891

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2892

# - 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.

2893

# 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.

2894

# 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.

2895

"summary": "A String", # Title of the event.

2896

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2897

# - "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.

2898

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2899

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2900

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2901

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2902

# - "public" - The event is public and event details are visible to all readers of the calendar.

2903

# - "private" - The event is private and only event attendees may view event details.

2904

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2905

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2909

<code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None, sendUpdates=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2910

<pre>Creates an event based on a simple text string.

2911

2912

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2913

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2914

text: string, The text describing the event to be created. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2915

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2916

2917

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.

2918

sendUpdates: string, Guests who should receive notifications about the creation of the new event.

2919

Allowed values

2920

all - Notifications are sent to all guests.

2921

externalOnly - Notifications are sent to non-Google Calendar guests only.

2922

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2923

2924

Returns:

2925

An object of the form:

2926

2927

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2928

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2929

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2930

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2931

# There can be at most 25 attachments per event,

2932

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2933

"fileId": "A String", # ID of the attached file. Read-only.

2934

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2935

"fileUrl": "A String", # URL link to the attachment.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2936

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2937

# Required when adding an attachment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2938

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2939

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2940

"title": "A String", # Attachment title.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2941

},

2942

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2943

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2944

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2945

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

2946

"comment": "A String", # The attendee's response comment. Optional.

2947

"displayName": "A String", # The attendee's name, if available. Optional.

2948

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2949

# Required when adding an attendee.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2950

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2951

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2952

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2953

"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.

2954

"responseStatus": "A String", # The attendee's response status. Possible values are:

2955

# - "needsAction" - The attendee has not responded to the invitation.

2956

# - "declined" - The attendee has declined the invitation.

2957

# - "tentative" - The attendee has tentatively accepted the invitation.

2958

# - "accepted" - The attendee has accepted the invitation.

2959

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2960

},

2961

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2962

"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.

2963

"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.

2964

"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.

2965

"conferenceId": "A String", # The ID of the conference.

2966

# Can be used by developers to keep track of conferences, should not be displayed to users.

2967

# Values for solution types:

2968

# - "eventHangout": unset.

2969

# - "eventNamedHangout": the name of the Hangout.

2970

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2971

# - "addOn": defined by 3P conference provider. Optional.

2972

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2973

# Unset for a conference with a failed create request.

2974

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2975

"iconUri": "A String", # The user-visible icon for this solution.

2976

"key": { # The key which can uniquely identify the conference solution for this event.

2977

"type": "A String", # The conference solution type.

2978

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2979

# The possible values are:

2980

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2981

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2982

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2983

# - "addOn" for 3P conference providers

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2984

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2985

"name": "A String", # The user-visible name of this solution. Not localized.

2986

},

2987

"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.

2988

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2989

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2990

"type": "A String", # The conference solution type.

2991

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2992

# The possible values are:

2993

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2994

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2995

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2996

# - "addOn" for 3P conference providers

2997

},

2998

"requestId": "A String", # The client-generated unique ID for this request.

2999

# 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.

3000

"status": { # The status of the conference create request.

3001

"statusCode": "A String", # The current status of the conference create request. Read-only.

3002

# The possible values are:

3003

# - "pending": the conference create request is still being processed.

3004

# - "success": the conference create request succeeded, the entry points are populated.

3005

# - "failure": the conference create request failed, there are no entry points.

3006

},

3007

},

3008

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3009

# All of them must belong to the same conference.

3010

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3011

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3012

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3013

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3014

# Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3015

"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.

3016

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3017

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3018

"entryPointType": "A String", # The type of the conference entry point.

3019

# Possible values are:

3020

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3021

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3022

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3023

# - "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.

3024

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3025

# Examples:

3026

# - for video: meet.google.com/aaa-bbbb-ccc

3027

# - for phone: +1 123 268 2601

3028

# - for sip: 12345678@altostrat.com

3029

# - for more: should not be filled

3030

# Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3031

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3032

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3033

# Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3034

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3035

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3036

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3037

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3038

# Optional.

3039

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3040

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3041

# Optional.

3042

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3043

# Calendar backend will populate this field only for EntryPointType.PHONE.

3044

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3045

# Format:

3046

# - for video, http: or https: schema is required.

3047

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3048

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3049

# - for more, http: or https: schema is required.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3050

},

3051

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3052

"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.

3053

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3054

"addOnParameters": { # Additional add-on specific data.

3055

"parameters": {

3056

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3057

},

3058

},

3059

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3060

"signature": "A String", # The signature of the conference data.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3061

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3062

# Unset for a conference with a failed create request.

3063

# Optional for a conference with a pending create request.

3064

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3065

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3066

"creator": { # The creator of the event. Read-only.

3067

"displayName": "A String", # The creator's name, if available.

3068

"email": "A String", # The creator's email address, if available.

3069

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3070

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3071

},

3072

"description": "A String", # Description of the event. Can contain HTML. Optional.

3073

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3074

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3075

"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.

3076

"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.

3077

},

3078

"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.

3079

"etag": "A String", # ETag of the resource.

3080

"extendedProperties": { # Extended properties of the event.

3081

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3082

"a_key": "A String", # The name of the private property and the corresponding value.

3083

},

3084

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3085

"a_key": "A String", # The name of the shared property and the corresponding value.

3086

},

3087

},

3088

"gadget": { # A gadget that extends this event.

3089

"display": "A String", # The gadget's display mode. Optional. Possible values are:

3090

# - "icon" - The gadget displays next to the event's title in the calendar view.

3091

# - "chip" - The gadget displays when the event is clicked.

3092

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

3093

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

3094

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

3095

"preferences": { # Preferences.

3096

"a_key": "A String", # The preference name and corresponding value.

3097

},

3098

"title": "A String", # The gadget's title.

3099

"type": "A String", # The gadget's type.

3100

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

3101

},

3102

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3103

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3104

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3105

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3106

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3107

"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.

3108

# 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.

3109

"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:

3110

# - 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

3111

# - the length of the ID must be between 5 and 1024 characters

3112

# - 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.

3113

# If you do not specify an ID, it will be automatically generated by the server.

3114

# 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.

3115

"kind": "calendar#event", # Type of the resource ("calendar#event").

3116

"location": "A String", # Geographic location of the event as free-form text. Optional.

3117

"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.

3118

"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.

3119

"displayName": "A String", # The organizer's name, if available.

3120

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3121

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3122

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3123

},

3124

"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.

3125

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3126

"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.

3127

"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.

3128

},

3129

"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.

3130

"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.

3131

"A String",

3132

],

3133

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3134

"reminders": { # Information about the event's reminders for the authenticated user.

3135

"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.

3136

{

3137

"method": "A String", # The method used by this reminder. Possible values are:

3138

# - "email" - Reminders are sent via email.

3139

# - "popup" - Reminders are sent via a UI popup.

3140

# Required when adding a reminder.

3141

"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).

3142

# Required when adding a reminder.

3143

},

3144

],

3145

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3146

},

3147

"sequence": 42, # Sequence number as per iCalendar.

3148

"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.

3149

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3150

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3151

},

3152

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3153

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3154

"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.

3155

"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.

3156

},

3157

"status": "A String", # Status of the event. Optional. Possible values are:

3158

# - "confirmed" - The event is confirmed. This is the default status.

3159

# - "tentative" - The event is tentatively confirmed.

3160

# - "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.

3161

# A cancelled status represents two different states depending on the event type:

3162

# - 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.

3163

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3164

# - 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.

3165

# 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.

3166

# 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.

3167

"summary": "A String", # Title of the event.

3168

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3169

# - "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.

3170

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3171

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3172

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3173

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3174

# - "public" - The event is public and event details are visible to all readers of the calendar.

3175

# - "private" - The event is private and only event attendees may view event details.

3176

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3177

}</pre>

3178

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3179

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3180

3181

<code class="details" id="update">update(calendarId, eventId, body=None, alwaysIncludeEmail=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)</code>

3182

<pre>Updates an event.

3183

3184

Args:

3185

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

3186

eventId: string, Event identifier. (required)

3187

body: object, The request body.

3188

The object takes the form of:

3189

3190

{

3191

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3192

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3193

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3194

# There can be at most 25 attachments per event,

3195

{

3196

"fileId": "A String", # ID of the attached file. Read-only.

3197

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3198

"fileUrl": "A String", # URL link to the attachment.

3199

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3200

# Required when adding an attachment.

3201

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3202

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3203

"title": "A String", # Attachment title.

3204

},

3205

],

3206

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

3207

{

3208

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3209

"comment": "A String", # The attendee's response comment. Optional.

3210

"displayName": "A String", # The attendee's name, if available. Optional.

3211

"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.

3212

# Required when adding an attendee.

3213

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3214

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3215

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3216

"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.

3217

"responseStatus": "A String", # The attendee's response status. Possible values are:

3218

# - "needsAction" - The attendee has not responded to the invitation.

3219

# - "declined" - The attendee has declined the invitation.

3220

# - "tentative" - The attendee has tentatively accepted the invitation.

3221

# - "accepted" - The attendee has accepted the invitation.

3222

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3223

},

3224

],

3225

"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.

3226

"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.

3227

"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.

3228

"conferenceId": "A String", # The ID of the conference.

3229

# Can be used by developers to keep track of conferences, should not be displayed to users.

3230

# Values for solution types:

3231

# - "eventHangout": unset.

3232

# - "eventNamedHangout": the name of the Hangout.

3233

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3234

# - "addOn": defined by 3P conference provider. Optional.

3235

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3236

# Unset for a conference with a failed create request.

3237

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3238

"iconUri": "A String", # The user-visible icon for this solution.

3239

"key": { # The key which can uniquely identify the conference solution for this event.

3240

"type": "A String", # The conference solution type.

3241

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3242

# The possible values are:

3243

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3244

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3245

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3246

# - "addOn" for 3P conference providers

3247

},

3248

"name": "A String", # The user-visible name of this solution. Not localized.

3249

},

3250

"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.

3251

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3252

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3253

"type": "A String", # The conference solution type.

3254

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3255

# The possible values are:

3256

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3257

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3258

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3259

# - "addOn" for 3P conference providers

3260

},

3261

"requestId": "A String", # The client-generated unique ID for this request.

3262

# 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.

3263

"status": { # The status of the conference create request.

3264

"statusCode": "A String", # The current status of the conference create request. Read-only.

3265

# The possible values are:

3266

# - "pending": the conference create request is still being processed.

3267

# - "success": the conference create request succeeded, the entry points are populated.

3268

# - "failure": the conference create request failed, there are no entry points.

3269

},

3270

},

3271

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3272

# All of them must belong to the same conference.

3273

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3274

{

3275

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3276

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3277

# Optional.

3278

"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.

3279

"A String",

3280

],

3281

"entryPointType": "A String", # The type of the conference entry point.

3282

# Possible values are:

3283

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3284

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3285

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3286

# - "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.

3287

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3288

# Examples:

3289

# - for video: meet.google.com/aaa-bbbb-ccc

3290

# - for phone: +1 123 268 2601

3291

# - for sip: 12345678@altostrat.com

3292

# - for more: should not be filled

3293

# Optional.

3294

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3295

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3296

# Optional.

3297

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3298

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3299

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3300

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3301

# Optional.

3302

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3303

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3304

# Optional.

3305

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3306

# Calendar backend will populate this field only for EntryPointType.PHONE.

3307

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3308

# Format:

3309

# - for video, http: or https: schema is required.

3310

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3311

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3312

# - for more, http: or https: schema is required.

3313

},

3314

],

3315

"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.

3316

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3317

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"signature": "A String", # The signature of the conference data.

3324

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3325

# Unset for a conference with a failed create request.

3326

# Optional for a conference with a pending create request.

3327

},

3328

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3329

"creator": { # The creator of the event. Read-only.

3330

"displayName": "A String", # The creator's name, if available.

3331

"email": "A String", # The creator's email address, if available.

3332

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3333

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3334

},

3335

"description": "A String", # Description of the event. Can contain HTML. Optional.

3336

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3337

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3338

"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.

3339

"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.

3340

},

3341

"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.

3342

"etag": "A String", # ETag of the resource.

3343

"extendedProperties": { # Extended properties of the event.

3344

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3345

"a_key": "A String", # The name of the private property and the corresponding value.

3346

},

3347

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3348

"a_key": "A String", # The name of the shared property and the corresponding value.

3349

},

3350

},

3351

"gadget": { # A gadget that extends this event.

3352

"display": "A String", # The gadget's display mode. Optional. Possible values are:

3353

# - "icon" - The gadget displays next to the event's title in the calendar view.

3354

# - "chip" - The gadget displays when the event is clicked.

3355

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

3356

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

3357

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

3358

"preferences": { # Preferences.

3359

"a_key": "A String", # The preference name and corresponding value.

3360

},

3361

"title": "A String", # The gadget's title.

3362

"type": "A String", # The gadget's type.

3363

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

3364

},

3365

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3366

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3367

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3368

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3369

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3370

"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.

3371

# 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.

3372

"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:

3373

# - 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

3374

# - the length of the ID must be between 5 and 1024 characters

3375

# - 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.

3376

# If you do not specify an ID, it will be automatically generated by the server.

3377

# 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.

3378

"kind": "calendar#event", # Type of the resource ("calendar#event").

3379

"location": "A String", # Geographic location of the event as free-form text. Optional.

3380

"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.

3381

"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.

3382

"displayName": "A String", # The organizer's name, if available.

3383

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3384

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3385

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3386

},

3387

"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.

3388

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3389

"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.

3390

"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.

3391

},

3392

"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.

3393

"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.

3394

"A String",

3395

],

3396

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3397

"reminders": { # Information about the event's reminders for the authenticated user.

3398

"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.

3399

{

3400

"method": "A String", # The method used by this reminder. Possible values are:

3401

# - "email" - Reminders are sent via email.

3402

# - "popup" - Reminders are sent via a UI popup.

3403

# Required when adding a reminder.

3404

"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).

3405

# Required when adding a reminder.

3406

},

3407

],

3408

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3409

},

3410

"sequence": 42, # Sequence number as per iCalendar.

3411

"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.

3412

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3413

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3414

},

3415

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3416

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3417

"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.

3418

"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.

3419

},

3420

"status": "A String", # Status of the event. Optional. Possible values are:

3421

# - "confirmed" - The event is confirmed. This is the default status.

3422

# - "tentative" - The event is tentatively confirmed.

3423

# - "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.

3424

# A cancelled status represents two different states depending on the event type:

3425

# - 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.

3426

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3427

# - 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.

3428

# 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.

3429

# 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.

3430

"summary": "A String", # Title of the event.

3431

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3432

# - "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.

3433

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3434

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3435

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3436

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3437

# - "public" - The event is public and event details are visible to all readers of the calendar.

3438

# - "private" - The event is private and only event attendees may view event details.

3439

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3440

}

3441

3442

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

3443

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.

3444

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3445

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

3446

3447

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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3448

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

3449

Allowed values

3450

all - Notifications are sent to all guests.

3451

externalOnly - Notifications are sent to non-Google Calendar guests only.

3452

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3453

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3454

3455

Returns:

3456

An object of the form:

3457

3458

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3459

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3460

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3461

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3462

# There can be at most 25 attachments per event,

3463

{

3464

"fileId": "A String", # ID of the attached file. Read-only.

3465

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3466

"fileUrl": "A String", # URL link to the attachment.

3467

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3468

# Required when adding an attachment.

3469

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3470

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3471

"title": "A String", # Attachment title.

3472

},

3473

],

3474

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

3475

{

3476

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3477

"comment": "A String", # The attendee's response comment. Optional.

3478

"displayName": "A String", # The attendee's name, if available. Optional.

3479

"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.

3480

# Required when adding an attendee.

3481

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3482

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3483

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3484

"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.

3485

"responseStatus": "A String", # The attendee's response status. Possible values are:

3486

# - "needsAction" - The attendee has not responded to the invitation.

3487

# - "declined" - The attendee has declined the invitation.

3488

# - "tentative" - The attendee has tentatively accepted the invitation.

3489

# - "accepted" - The attendee has accepted the invitation.

3490

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3491

},

3492

],

3493

"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.

3494

"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.

3495

"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.

3496

"conferenceId": "A String", # The ID of the conference.

3497

# Can be used by developers to keep track of conferences, should not be displayed to users.

3498

# Values for solution types:

3499

# - "eventHangout": unset.

3500

# - "eventNamedHangout": the name of the Hangout.

3501

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3502

# - "addOn": defined by 3P conference provider. Optional.

3503

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3504

# Unset for a conference with a failed create request.

3505

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3506

"iconUri": "A String", # The user-visible icon for this solution.

3507

"key": { # The key which can uniquely identify the conference solution for this event.

3508

"type": "A String", # The conference solution type.

3509

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3510

# The possible values are:

3511

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3512

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3513

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3514

# - "addOn" for 3P conference providers

3515

},

3516

"name": "A String", # The user-visible name of this solution. Not localized.

3517

},

3518

"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.

3519

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3520

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3521

"type": "A String", # The conference solution type.

3522

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3523

# The possible values are:

3524

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3525

# - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3526

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3527

# - "addOn" for 3P conference providers

3528

},

3529

"requestId": "A String", # The client-generated unique ID for this request.

3530

# 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.

3531

"status": { # The status of the conference create request.

3532

"statusCode": "A String", # The current status of the conference create request. Read-only.

3533

# The possible values are:

3534

# - "pending": the conference create request is still being processed.

3535

# - "success": the conference create request succeeded, the entry points are populated.

3536

# - "failure": the conference create request failed, there are no entry points.

3537

},

3538

},

3539

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3540

# All of them must belong to the same conference.

3541

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

3542

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3543

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3544

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3545

# Optional.

3546

"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.

3547

"A String",

3548

],

3549

"entryPointType": "A String", # The type of the conference entry point.

3550

# Possible values are:

3551

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3552

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3553

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3554

# - "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.

3555

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3556

# Examples:

3557

# - for video: meet.google.com/aaa-bbbb-ccc

3558

# - for phone: +1 123 268 2601

3559

# - for sip: 12345678@altostrat.com

3560

# - for more: should not be filled

3561

# Optional.

3562

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3563

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3564

# Optional.

3565

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3566

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3567

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3568

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3569

# Optional.

3570

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3571

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3572

# Optional.

3573

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3574

# Calendar backend will populate this field only for EntryPointType.PHONE.

3575

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3576

# Format:

3577

# - for video, http: or https: schema is required.

3578

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3579

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3580

# - for more, http: or https: schema is required.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

3581

},

3582

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3583

"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.

3584

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3585

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3590

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3591

"signature": "A String", # The signature of the conference data.

3592

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3593

# Unset for a conference with a failed create request.

3594

# Optional for a conference with a pending create request.

3595

},

3596

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3597

"creator": { # The creator of the event. Read-only.

3598

"displayName": "A String", # The creator's name, if available.

3599

"email": "A String", # The creator's email address, if available.

3600

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3601

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3602

},

3603

"description": "A String", # Description of the event. Can contain HTML. Optional.

3604

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3605

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3606

"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.

3607

"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.

3608

},

3609

"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.

3610

"etag": "A String", # ETag of the resource.

3611

"extendedProperties": { # Extended properties of the event.

3612

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3613

"a_key": "A String", # The name of the private property and the corresponding value.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3614

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3615

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3616

"a_key": "A String", # The name of the shared property and the corresponding value.

3617

},

3618

},

3619

"gadget": { # A gadget that extends this event.

3620

"display": "A String", # The gadget's display mode. Optional. Possible values are:

3621

# - "icon" - The gadget displays next to the event's title in the calendar view.

3622

# - "chip" - The gadget displays when the event is clicked.

3623

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional.

3624

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS.

3625

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS.

3626

"preferences": { # Preferences.

3627

"a_key": "A String", # The preference name and corresponding value.

3628

},

3629

"title": "A String", # The gadget's title.

3630

"type": "A String", # The gadget's type.

3631

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional.

3632

},

3633

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3634

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3635

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3636

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3637

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3638

"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.

3639

# 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.

3640

"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:

3641

# - 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

3642

# - the length of the ID must be between 5 and 1024 characters

3643

# - 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.

3644

# If you do not specify an ID, it will be automatically generated by the server.

3645

# 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.

3646

"kind": "calendar#event", # Type of the resource ("calendar#event").

3647

"location": "A String", # Geographic location of the event as free-form text. Optional.

3648

"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.

3649

"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.

3650

"displayName": "A String", # The organizer's name, if available.

3651

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3652

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3653

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3654

},

3655

"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.

3656

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3657

"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.

3658

"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.

3659

},

3660

"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.

3661

"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.

3662

"A String",

3663

],

3664

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3665

"reminders": { # Information about the event's reminders for the authenticated user.

3666

"overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3667

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3668

"method": "A String", # The method used by this reminder. Possible values are:

3669

# - "email" - Reminders are sent via email.

3670

# - "popup" - Reminders are sent via a UI popup.

3671

# Required when adding a reminder.

3672

"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).

3673

# Required when adding a reminder.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3674

},

3675

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3676

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3677

},

3678

"sequence": 42, # Sequence number as per iCalendar.

3679

"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.

3680

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3681

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3682

},

3683

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3684

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3685

"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.

3686

"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.

3687

},

3688

"status": "A String", # Status of the event. Optional. Possible values are:

3689

# - "confirmed" - The event is confirmed. This is the default status.

3690

# - "tentative" - The event is tentatively confirmed.

3691

# - "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.

3692

# A cancelled status represents two different states depending on the event type:

3693

# - 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.

3694

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3695

# - 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.

3696

# 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.

3697

# 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.

3698

"summary": "A String", # Title of the event.

3699

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3700

# - "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.

3701

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3702

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3703

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3704

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3705

# - "public" - The event is public and event details are visible to all readers of the calendar.

3706

# - "private" - The event is private and only event attendees may view event details.

3707

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3708

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3712

<code class="details" id="watch">watch(calendarId, body=None, 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]

3713

<pre>Watch for changes to Events resources.

3714

3715

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3716

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3717

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3718

The object takes the form of:

3719

3720

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3721

"address": "A String", # The address where notifications are delivered for this channel.

3722

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

3723

"id": "A String", # A UUID or similar unique string that identifies this channel.

3724

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

3725

"params": { # Additional parameters controlling delivery channel behavior. Optional.

3726

"a_key": "A String", # Declares a new parameter by name.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3727

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3728

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

3729

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

3730

"resourceUri": "A String", # A version-specific identifier for the watched resource.

3731

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

3732

"type": "A String", # The type of delivery mechanism used for this channel.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3733

}

3734

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3735

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).

3736

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

3737

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.

3738

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3739

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

3740

Allowed values

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3741

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3742

updated - Order by last modification time (ascending).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3743

pageToken: string, Token specifying which result page to return. Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3744

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)

3745

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3746

sharedExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3747

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.

3748

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

3749

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

2014-08-14 00:47:23 -0700

[diff] [blame]

3750

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.

3751

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

3757

- q

3758

- sharedExtendedProperty

3759

- timeMin

3760

- timeMax

3761

- 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.

3762

Learn more about incremental synchronization.

3763

Optional. The default is to return all entries.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3764

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.

3765

timeMin: string, Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3766

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3767

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