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

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

[diff] [blame]

91

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

92

Yoshi Automation Bot

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

[diff] [blame^]

93

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

John Asmuth

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

[diff] [blame]

94

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

95

96

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

97

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

98

Yoshi Automation Bot

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

[diff] [blame^]

99

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

John Asmuth

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

[diff] [blame]

100

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

101

102

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

103

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

104

Yoshi Automation Bot

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

[diff] [blame^]

105

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

John Asmuth

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

[diff] [blame]

106

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

107

Yoshi Automation Bot

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

[diff] [blame^]

108

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

John Asmuth

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

[diff] [blame]

109

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

110

Yoshi Automation Bot

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

[diff] [blame^]

111

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

John Asmuth

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

[diff] [blame]

112

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

113

Yoshi Automation Bot

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

[diff] [blame^]

114

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

John Asmuth

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

[diff] [blame]

115

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

116

Yoshi Automation Bot

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

[diff] [blame^]

117

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

John Asmuth

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

[diff] [blame]

118

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

119

<h3>Method Details</h3>

120

Dmitry Frenkel

3e17f89

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

[diff] [blame]

121

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

122

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

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

[diff] [blame^]

126

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

John Asmuth

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

[diff] [blame]

127

<pre>Deletes an event.

128

129

Args:

Bu Sun Kim

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

[diff] [blame]

130

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

John Asmuth

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

[diff] [blame]

131

eventId: string, Event identifier. (required)

Yoshi Automation Bot

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

[diff] [blame^]

132

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

133

134

Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.

Bu Sun Kim

715bd7f

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

[diff] [blame]

135

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

136

Allowed values

137

all - Notifications are sent to all guests.

138

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

139

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

John Asmuth

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

[diff] [blame]

</pre>

</div>

Yoshi Automation Bot

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

[diff] [blame^]

144

<code class="details" id="get">get(calendarId, eventId, maxAttendees=None, timeZone=None, alwaysIncludeEmail=None)</code>

John Asmuth

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

[diff] [blame]

145

<pre>Returns an event.

146

147

Args:

Bu Sun Kim

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

[diff] [blame]

148

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

John Asmuth

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

[diff] [blame]

149

eventId: string, Event identifier. (required)

Yoshi Automation Bot

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

[diff] [blame^]

150

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

Yoshi Automation Bot

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

[diff] [blame]

151

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

Yoshi Automation Bot

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

[diff] [blame]

152

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

John Asmuth

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

[diff] [blame]

153

154

Returns:

155

An object of the form:

156

157

{

Yoshi Automation Bot

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

[diff] [blame^]

158

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

159

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

160

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

161

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

162

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

Bu Sun Kim

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

[diff] [blame]

163

},

Yoshi Automation Bot

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

[diff] [blame^]

164

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

165

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

Yoshi Automation Bot

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

[diff] [blame]

166

},

Yoshi Automation Bot

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

[diff] [blame]

167

},

Yoshi Automation Bot

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

[diff] [blame^]

168

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

169

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

170

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

171

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

172

# Values for solution types:

173

# - "eventHangout": unset.

174

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

175

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

176

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

177

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

178

# All of them must belong to the same conference.

179

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

180

{

181

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

182

# Possible values are:

183

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

184

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

185

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

186

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

187

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

188

# Examples:

189

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

190

# - for phone: +1 123 268 2601

191

# - for sip: 12345678@altostrat.com

192

# - for more: should not be filled

193

# Optional.

194

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

195

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

196

# Optional.

197

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

198

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

199

# Optional.

200

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

201

"A String",

202

],

203

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

204

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

205

# Optional.

206

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

207

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

208

# Optional.

209

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

210

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

211

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

212

# Format:

213

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

214

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

215

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

216

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

217

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

218

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

219

},

220

],

221

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

222

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

223

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

224

# Unset for a conference with a failed create request.

225

# Optional for a conference with a pending create request.

226

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

227

# Unset for a conference with a failed create request.

228

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

229

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

230

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

231

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

232

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

233

# The possible values are:

234

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

235

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

236

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

237

# - "addOn" for 3P conference providers

238

},

239

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

240

},

241

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

242

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

"parameters": {

"a_key": "A String",

},

},

},

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

249

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

250

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

251

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

252

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

253

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

254

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

255

# The possible values are:

256

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

257

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

258

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

259

# - "addOn" for 3P conference providers

260

},

261

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

262

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

263

# The possible values are:

264

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

265

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

266

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

Yoshi Automation Bot

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

[diff] [blame]

267

},

268

},

269

},

Yoshi Automation Bot

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

[diff] [blame^]

270

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

271

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

272

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

273

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

274

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

Yoshi Automation Bot

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

[diff] [blame]

275

},

Yoshi Automation Bot

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

[diff] [blame^]

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

"preferences": { # Preferences.

286

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

287

},

288

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

289

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

290

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

291

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

292

},

293

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

294

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

295

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

296

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

297

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

298

},

299

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

300

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

301

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

302

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

303

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

304

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

305

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

Bu Sun Kim

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

[diff] [blame]

306

{

Yoshi Automation Bot

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

[diff] [blame^]

307

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

308

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

309

# Required when adding an attendee.

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

Bu Sun Kim

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

[diff] [blame]

322

},

323

],

Yoshi Automation Bot

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

[diff] [blame^]

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

{

338

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

339

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

340

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

341

# Required when adding a reminder.

342

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

343

# Required when adding a reminder.

344

},

345

],

346

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

347

},

348

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

349

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

350

# There can be at most 25 attachments per event,

351

{

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

# Required when adding an attachment.

360

},

361

],

362

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

363

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

364

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

365

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

366

},

367

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

368

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

369

"A String",

370

],

371

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

372

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

373

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

374

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

375

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

376

},

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

},

388

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

389

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

390

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

391

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

392

},

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

411

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

John Asmuth

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

[diff] [blame]

412

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

413

414

Args:

Bu Sun Kim

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

[diff] [blame]

415

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

Dan O'Meara

dd49464

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

[diff] [blame]

416

body: object, The request body.

John Asmuth

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

[diff] [blame]

417

The object takes the form of:

418

419

{

Yoshi Automation Bot

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

[diff] [blame^]

420

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

421

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

Yoshi Automation Bot

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

[diff] [blame]

422

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

423

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

424

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

425

},

426

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

427

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

428

},

Yoshi Automation Bot

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

[diff] [blame]

429

},

Yoshi Automation Bot

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

[diff] [blame^]

430

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

Yoshi Automation Bot

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

[diff] [blame]

431

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

Yoshi Automation Bot

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

[diff] [blame]

432

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

433

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

434

# Values for solution types:

435

# - "eventHangout": unset.

436

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

437

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

438

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

439

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

440

# All of them must belong to the same conference.

441

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

Yoshi Automation Bot

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

[diff] [blame]

442

{

Yoshi Automation Bot

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

[diff] [blame^]

443

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

444

# Possible values are:

445

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

446

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

447

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

448

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

Yoshi Automation Bot

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

[diff] [blame]

449

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

450

# Examples:

451

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

452

# - for phone: +1 123 268 2601

453

# - for sip: 12345678@altostrat.com

454

# - for more: should not be filled

455

# Optional.

Yoshi Automation Bot

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

[diff] [blame^]

456

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

457

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

458

# Optional.

459

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

460

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

461

# Optional.

Yoshi Automation Bot

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

[diff] [blame]

462

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

463

"A String",

464

],

Yoshi Automation Bot

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

[diff] [blame^]

465

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

466

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

467

# Optional.

468

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

Yoshi Automation Bot

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

[diff] [blame]

469

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

470

# Optional.

471

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

472

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

473

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

474

# Format:

475

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

476

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

477

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

478

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

Yoshi Automation Bot

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

[diff] [blame^]

479

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

480

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

Yoshi Automation Bot

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

[diff] [blame]

481

},

482

],

Yoshi Automation Bot

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

[diff] [blame]

483

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

Yoshi Automation Bot

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

[diff] [blame^]

484

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

485

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

486

# Unset for a conference with a failed create request.

487

# Optional for a conference with a pending create request.

488

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

489

# Unset for a conference with a failed create request.

490

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

491

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

492

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

493

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

494

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

495

# The possible values are:

496

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

497

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

498

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

499

# - "addOn" for 3P conference providers

500

},

501

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

502

},

503

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

504

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

"parameters": {

"a_key": "A String",

},

},

},

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

511

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

512

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

513

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

514

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

515

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

516

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

517

# The possible values are:

518

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

519

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

520

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

521

# - "addOn" for 3P conference providers

522

},

523

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

524

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

525

# The possible values are:

526

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

527

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

528

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

529

},

530

},

Yoshi Automation Bot

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

[diff] [blame]

531

},

Yoshi Automation Bot

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

[diff] [blame^]

532

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

533

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

534

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

535

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

536

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

537

},

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

"preferences": { # Preferences.

548

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

549

},

550

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

551

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

552

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

553

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

554

},

555

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

556

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

557

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

558

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

559

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

560

},

561

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

Yoshi Automation Bot

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

[diff] [blame]

562

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

563

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

564

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

Yoshi Automation Bot

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

[diff] [blame]

565

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

Yoshi Automation Bot

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

[diff] [blame^]

566

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

567

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

568

{

569

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

570

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

571

# Required when adding an attendee.

572

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

573

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

574

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

575

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

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

},

585

],

Yoshi Automation Bot

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

[diff] [blame]

586

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

587

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

588

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

589

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

590

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

591

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

Yoshi Automation Bot

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

[diff] [blame^]

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

{

600

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

601

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

602

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

603

# Required when adding a reminder.

604

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

605

# Required when adding a reminder.

606

},

607

],

608

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

609

},

610

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

611

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

612

# There can be at most 25 attachments per event,

613

{

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

# Required when adding an attachment.

622

},

623

],

624

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

625

"timeZone": "A String", # The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.

626

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

627

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

628

},

629

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

630

"recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.

631

"A String",

632

],

633

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

634

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

635

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

636

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

637

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

638

},

639

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

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

},

650

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

651

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

652

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

653

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

654

},

655

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

656

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

657

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

658

# - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.

659

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

660

# - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.

661

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

662

# - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.

663

# Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.

664

# If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.

665

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

666

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

667

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

668

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

669

}

670

671

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

672

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

673

674

Returns:

675

An object of the form:

676

677

{

678

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

679

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

680

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

681

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

682

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

683

},

684

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

685

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

686

},

687

},

688

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

689

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

690

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

691

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

692

# Values for solution types:

693

# - "eventHangout": unset.

694

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

695

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

696

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

697

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

698

# All of them must belong to the same conference.

699

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

700

{

701

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

702

# Possible values are:

703

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

704

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

705

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

706

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

707

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

708

# Examples:

709

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

710

# - for phone: +1 123 268 2601

711

# - for sip: 12345678@altostrat.com

712

# - for more: should not be filled

713

# Optional.

714

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

715

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

716

# Optional.

717

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

718

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

719

# Optional.

720

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

721

"A String",

722

],

723

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

724

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

725

# Optional.

726

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

727

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

728

# Optional.

729

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

730

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

731

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

732

# Format:

733

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

734

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

735

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

736

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

737

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

738

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

739

},

740

],

741

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

742

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

743

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

744

# Unset for a conference with a failed create request.

745

# Optional for a conference with a pending create request.

746

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

747

# Unset for a conference with a failed create request.

748

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

749

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

750

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

751

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

752

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

753

# The possible values are:

754

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

755

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

756

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

757

# - "addOn" for 3P conference providers

758

},

759

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

760

},

761

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

762

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

"parameters": {

"a_key": "A String",

},

},

},

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

769

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

770

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

771

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

772

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

773

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

774

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

775

# The possible values are:

776

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

777

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

778

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

779

# - "addOn" for 3P conference providers

780

},

781

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

782

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

783

# The possible values are:

784

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

785

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

786

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

},

},

},

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

791

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

792

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

793

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

794

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

795

},

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

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

804

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

805

"preferences": { # Preferences.

806

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

807

},

808

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

809

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

810

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

811

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

812

},

813

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

814

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

815

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

816

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

817

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

818

},

819

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

820

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

821

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

822

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

823

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

824

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

825

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

826

{

827

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

828

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

829

# Required when adding an attendee.

830

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

831

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

832

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

833

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

834

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

835

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

836

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

837

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

838

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

839

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

840

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

841

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

842

},

843

],

844

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

845

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

846

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

847

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

848

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

849

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

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

{

858

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

859

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

860

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

861

# Required when adding a reminder.

862

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

863

# Required when adding a reminder.

864

},

865

],

866

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

867

},

868

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

869

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

870

# There can be at most 25 attachments per event,

871

{

872

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

873

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

874

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

875

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

876

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

877

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

878

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

879

# Required when adding an attachment.

880

},

881

],

882

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

883

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

884

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

885

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

886

},

887

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

888

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

889

"A String",

890

],

891

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

892

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

893

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

894

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

895

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

896

},

897

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

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

},

908

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

909

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

910

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

911

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

912

},

913

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

914

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

915

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

916

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

917

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

918

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

919

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

920

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

921

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

922

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

923

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

924

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

925

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

926

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

927

}</pre>

Bu Sun Kim

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

[diff] [blame]

928

</div>

John Asmuth

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

[diff] [blame]

929

Bu Sun Kim

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

[diff] [blame]

930

Yoshi Automation Bot

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

[diff] [blame^]

931

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

Bu Sun Kim

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

[diff] [blame]

932

<pre>Creates an event.

933

934

Args:

935

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

936

body: object, The request body.

937

The object takes the form of:

938

939

{

Yoshi Automation Bot

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

[diff] [blame^]

940

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

941

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

Yoshi Automation Bot

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

[diff] [blame]

942

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

943

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

944

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

945

},

946

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

947

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

948

},

Yoshi Automation Bot

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

[diff] [blame]

949

},

Yoshi Automation Bot

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

[diff] [blame^]

950

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

Yoshi Automation Bot

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

[diff] [blame]

951

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

Yoshi Automation Bot

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

[diff] [blame]

952

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

953

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

954

# Values for solution types:

955

# - "eventHangout": unset.

956

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

957

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

958

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

959

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

960

# All of them must belong to the same conference.

961

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

Yoshi Automation Bot

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

[diff] [blame]

962

{

Yoshi Automation Bot

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

[diff] [blame^]

963

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

964

# Possible values are:

965

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

966

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

967

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

968

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

Yoshi Automation Bot

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

[diff] [blame]

969

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

970

# Examples:

971

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

972

# - for phone: +1 123 268 2601

973

# - for sip: 12345678@altostrat.com

974

# - for more: should not be filled

975

# Optional.

Yoshi Automation Bot

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

[diff] [blame^]

976

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

977

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

978

# Optional.

979

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

980

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

981

# Optional.

Yoshi Automation Bot

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

[diff] [blame]

982

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

983

"A String",

984

],

Yoshi Automation Bot

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

[diff] [blame^]

985

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

986

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

987

# Optional.

988

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

Yoshi Automation Bot

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

[diff] [blame]

989

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

990

# Optional.

991

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

992

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

993

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

994

# Format:

995

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

996

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

997

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

998

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

Yoshi Automation Bot

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

[diff] [blame^]

999

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

1000

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

Yoshi Automation Bot

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

[diff] [blame]

1001

},

1002

],

Yoshi Automation Bot

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

[diff] [blame]

1003

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

Yoshi Automation Bot

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

[diff] [blame^]

1004

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

1005

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

1006

# Unset for a conference with a failed create request.

1007

# Optional for a conference with a pending create request.

1008

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

1009

# Unset for a conference with a failed create request.

1010

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

1011

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

1012

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

1013

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

1014

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

1015

# The possible values are:

1016

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

1017

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

1018

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

1019

# - "addOn" for 3P conference providers

1020

},

1021

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

1022

},

1023

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

1024

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

"parameters": {

"a_key": "A String",

},

},

},

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

# The possible values are:

1038

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

1039

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

1040

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

1041

# - "addOn" for 3P conference providers

1042

},

1043

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

1044

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

1045

# The possible values are:

1046

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

1047

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

1048

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

1049

},

1050

},

Yoshi Automation Bot

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

[diff] [blame]

1051

},

Yoshi Automation Bot

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

[diff] [blame^]

1052

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

1053

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

1054

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

1055

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

1056

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

1057

},

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

"preferences": { # Preferences.

1068

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

1069

},

1070

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

1071

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

1072

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

1073

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

1074

},

1075

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

1076

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

1077

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

1078

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

1079

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

1080

},

1081

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

Yoshi Automation Bot

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

[diff] [blame]

1082

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

1083

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

1084

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

Yoshi Automation Bot

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

[diff] [blame]

1085

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

Yoshi Automation Bot

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

[diff] [blame^]

1086

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

1087

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

1088

{

1089

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

1090

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

1091

# Required when adding an attendee.

1092

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

1093

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

1094

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

1095

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

1096

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

1097

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

1098

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

1099

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

1100

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

1101

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

1102

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

1103

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

1104

},

1105

],

Yoshi Automation Bot

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

[diff] [blame]

1106

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

1107

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

1108

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

1109

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

1110

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

1111

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1112

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1113

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1114

# - "public" - The event is public and event details are visible to all readers of the calendar.

1115

# - "private" - The event is private and only event attendees may view event details.

1116

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1117

"reminders": { # Information about the event's reminders for the authenticated user.

1118

"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.

1119

{

1120

"method": "A String", # The method used by this reminder. Possible values are:

1121

# - "email" - Reminders are sent via email.

1122

# - "popup" - Reminders are sent via a UI popup.

1123

# Required when adding a reminder.

1124

"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).

1125

# Required when adding a reminder.

1126

},

1127

],

1128

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1129

},

1130

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1131

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1132

# There can be at most 25 attachments per event,

1133

{

1134

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1135

"title": "A String", # Attachment title.

1136

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1137

"fileId": "A String", # ID of the attached file. Read-only.

1138

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1139

"fileUrl": "A String", # URL link to the attachment.

1140

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1141

# Required when adding an attachment.

1142

},

1143

],

1144

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1145

"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.

1146

"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.

1147

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1148

},

1149

"etag": "A String", # ETag of the resource.

1150

"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.

1151

"A String",

1152

],

1153

"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.

1154

"displayName": "A String", # The organizer's name, if available.

1155

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1156

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1157

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1158

},

1159

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1160

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1161

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1162

"location": "A String", # Geographic location of the event as free-form text. Optional.

1163

"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.

1164

"creator": { # The creator of the event. Read-only.

1165

"displayName": "A String", # The creator's name, if available.

1166

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1167

"email": "A String", # The creator's email address, if available.

1168

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1169

},

1170

"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.

1171

"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.

1172

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1173

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1174

},

1175

"status": "A String", # Status of the event. Optional. Possible values are:

1176

# - "confirmed" - The event is confirmed. This is the default status.

1177

# - "tentative" - The event is tentatively confirmed.

1178

# - "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.

1179

# A cancelled status represents two different states depending on the event type:

1180

# - 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.

1181

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1182

# - 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.

1183

# 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.

1184

# 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.

1185

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1186

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1187

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1188

"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.

1189

}

1190

1191

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

1192

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.

1193

Allowed values

1194

all - Notifications are sent to all guests.

1195

externalOnly - Notifications are sent to non-Google Calendar guests only.

1196

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).

1197

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

1198

1199

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.

1200

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

1201

conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

1202

1203

Returns:

1204

An object of the form:

1205

1206

{

1207

"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.

1208

# 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.

1209

"extendedProperties": { # Extended properties of the event.

1210

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1211

"a_key": "A String", # The name of the private property and the corresponding value.

1212

},

1213

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1214

"a_key": "A String", # The name of the shared property and the corresponding value.

1215

},

1216

},

1217

"summary": "A String", # Title of the event.

1218

"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.

1219

"conferenceId": "A String", # The ID of the conference.

1220

# Can be used by developers to keep track of conferences, should not be displayed to users.

1221

# Values for solution types:

1222

# - "eventHangout": unset.

1223

# - "eventNamedHangout": the name of the Hangout.

1224

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1225

# - "addOn": defined by 3P conference provider. Optional.

1226

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1227

# All of them must belong to the same conference.

1228

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1229

{

1230

"entryPointType": "A String", # The type of the conference entry point.

1231

# Possible values are:

1232

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1233

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1234

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1235

# - "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.

1236

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1237

# Examples:

1238

# - for video: meet.google.com/aaa-bbbb-ccc

1239

# - for phone: +1 123 268 2601

1240

# - for sip: 12345678@altostrat.com

1241

# - for more: should not be filled

1242

# Optional.

1243

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1244

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1245

# Optional.

1246

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1247

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1248

# Optional.

1249

"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.

1250

"A String",

1251

],

1252

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1253

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1254

# Optional.

1255

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1256

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1257

# Optional.

1258

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1259

# Calendar backend will populate this field only for EntryPointType.PHONE.

1260

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1261

# Format:

1262

# - for video, http: or https: schema is required.

1263

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1264

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1265

# - for more, http: or https: schema is required.

1266

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1267

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1268

},

1269

],

1270

"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.

1271

"signature": "A String", # The signature of the conference data.

1272

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1273

# Unset for a conference with a failed create request.

1274

# Optional for a conference with a pending create request.

1275

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1276

# Unset for a conference with a failed create request.

1277

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1278

"name": "A String", # The user-visible name of this solution. Not localized.

1279

"key": { # The key which can uniquely identify the conference solution for this event.

1280

"type": "A String", # The conference solution type.

1281

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1282

# The possible values are:

1283

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1284

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1285

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1286

# - "addOn" for 3P conference providers

1287

},

1288

"iconUri": "A String", # The user-visible icon for this solution.

1289

},

1290

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1291

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

1298

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1299

"requestId": "A String", # The client-generated unique ID for this request.

1300

# 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.

1301

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1302

"type": "A String", # The conference solution type.

1303

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1304

# The possible values are:

1305

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1306

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1307

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1308

# - "addOn" for 3P conference providers

1309

},

1310

"status": { # The status of the conference create request.

1311

"statusCode": "A String", # The current status of the conference create request. Read-only.

1312

# The possible values are:

1313

# - "pending": the conference create request is still being processed.

1314

# - "success": the conference create request succeeded, the entry points are populated.

1315

# - "failure": the conference create request failed, there are no entry points.

},

},

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1320

"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.

1321

"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.

1322

"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.

1323

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1324

},

1325

"kind": "calendar#event", # Type of the resource ("calendar#event").

1326

"sequence": 42, # Sequence number as per iCalendar.

1327

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1328

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1329

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1330

# - "icon" - The gadget displays next to the event's title in the calendar view.

1331

# - "chip" - The gadget displays when the event is clicked.

1332

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1333

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1334

"preferences": { # Preferences.

1335

"a_key": "A String", # The preference name and corresponding value.

1336

},

1337

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1338

"type": "A String", # The gadget's type. Deprecated.

1339

"title": "A String", # The gadget's title. Deprecated.

1340

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1341

},

1342

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1343

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1344

"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.

1345

"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.

1346

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1347

},

1348

"description": "A String", # Description of the event. Can contain HTML. Optional.

1349

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1350

# - "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.

1351

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1352

"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.

1353

"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.

1354

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

1355

{

1356

"displayName": "A String", # The attendee's name, if available. Optional.

1357

"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.

1358

# Required when adding an attendee.

1359

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1360

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1361

"responseStatus": "A String", # The attendee's response status. Possible values are:

1362

# - "needsAction" - The attendee has not responded to the invitation.

1363

# - "declined" - The attendee has declined the invitation.

1364

# - "tentative" - The attendee has tentatively accepted the invitation.

1365

# - "accepted" - The attendee has accepted the invitation.

1366

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1367

"comment": "A String", # The attendee's response comment. Optional.

1368

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1369

"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.

1370

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1371

},

1372

],

1373

"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:

1374

# - 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

1375

# - the length of the ID must be between 5 and 1024 characters

1376

# - 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.

1377

# If you do not specify an ID, it will be automatically generated by the server.

1378

# 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.

1379

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1380

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1381

# - "public" - The event is public and event details are visible to all readers of the calendar.

1382

# - "private" - The event is private and only event attendees may view event details.

1383

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1384

"reminders": { # Information about the event's reminders for the authenticated user.

1385

"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.

1386

{

1387

"method": "A String", # The method used by this reminder. Possible values are:

1388

# - "email" - Reminders are sent via email.

1389

# - "popup" - Reminders are sent via a UI popup.

1390

# Required when adding a reminder.

1391

"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).

1392

# Required when adding a reminder.

1393

},

1394

],

1395

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1396

},

1397

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1398

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1399

# There can be at most 25 attachments per event,

1400

{

1401

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1402

"title": "A String", # Attachment title.

1403

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1404

"fileId": "A String", # ID of the attached file. Read-only.

1405

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1406

"fileUrl": "A String", # URL link to the attachment.

1407

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1408

# Required when adding an attachment.

1409

},

1410

],

1411

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1412

"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.

1413

"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.

1414

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1415

},

1416

"etag": "A String", # ETag of the resource.

1417

"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.

1418

"A String",

1419

],

1420

"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.

1421

"displayName": "A String", # The organizer's name, if available.

1422

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1423

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1424

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1425

},

1426

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1427

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1428

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1429

"location": "A String", # Geographic location of the event as free-form text. Optional.

1430

"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.

1431

"creator": { # The creator of the event. Read-only.

1432

"displayName": "A String", # The creator's name, if available.

1433

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1434

"email": "A String", # The creator's email address, if available.

1435

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1436

},

1437

"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.

1438

"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.

1439

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1440

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1441

},

1442

"status": "A String", # Status of the event. Optional. Possible values are:

1443

# - "confirmed" - The event is confirmed. This is the default status.

1444

# - "tentative" - The event is tentatively confirmed.

1445

# - "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.

1446

# A cancelled status represents two different states depending on the event type:

1447

# - 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.

1448

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1449

# - 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.

1450

# 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.

1451

# 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.

1452

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1453

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1454

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1455

"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.

1456

}</pre>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1460

<code class="details" id="instances">instances(calendarId, eventId, maxResults=None, timeMin=None, alwaysIncludeEmail=None, timeMax=None, pageToken=None, timeZone=None, showDeleted=None, maxAttendees=None, originalStart=None)</code>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1461

<pre>Returns instances of the specified recurring event.

1462

1463

Args:

1464

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

1465

eventId: string, Recurring event identifier. (required)

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1466

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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1467

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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1468

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).

1469

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.

1470

pageToken: string, Token specifying which result page to return. Optional.

1471

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1472

showDeleted: boolean, Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.

1473

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1474

originalStart: string, The original start time of the instance in the result. Optional.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1475

1476

Returns:

1477

An object of the form:

1478

1479

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1480

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1481

# - "none" - The user has no access.

1482

# - "freeBusyReader" - The user has read access to free/busy information.

1483

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1484

# - "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.

1485

# - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1486

"description": "A String", # Description of the calendar. Read-only.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1487

"summary": "A String", # Title of the calendar. Read-only.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1488

"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.

1489

"timeZone": "A String", # The time zone of the calendar. Read-only.

1490

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

1491

"kind": "calendar#events", # Type of the collection ("calendar#events").

1492

"etag": "A String", # ETag of the collection.

1493

"items": [ # List of events on the calendar.

1494

{

1495

"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.

1496

# 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.

1497

"extendedProperties": { # Extended properties of the event.

1498

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1499

"a_key": "A String", # The name of the private property and the corresponding value.

1500

},

1501

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1502

"a_key": "A String", # The name of the shared property and the corresponding value.

1503

},

1504

},

1505

"summary": "A String", # Title of the event.

1506

"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.

1507

"conferenceId": "A String", # The ID of the conference.

1508

# Can be used by developers to keep track of conferences, should not be displayed to users.

1509

# Values for solution types:

1510

# - "eventHangout": unset.

1511

# - "eventNamedHangout": the name of the Hangout.

1512

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1513

# - "addOn": defined by 3P conference provider. Optional.

1514

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1515

# All of them must belong to the same conference.

1516

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1517

{

1518

"entryPointType": "A String", # The type of the conference entry point.

1519

# Possible values are:

1520

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1521

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1522

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1523

# - "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.

1524

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1525

# Examples:

1526

# - for video: meet.google.com/aaa-bbbb-ccc

1527

# - for phone: +1 123 268 2601

1528

# - for sip: 12345678@altostrat.com

1529

# - for more: should not be filled

1530

# Optional.

1531

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1532

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1533

# Optional.

1534

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1535

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1536

# Optional.

1537

"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.

1538

"A String",

1539

],

1540

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1541

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1542

# Optional.

1543

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1544

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1545

# Optional.

1546

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1547

# Calendar backend will populate this field only for EntryPointType.PHONE.

1548

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1549

# Format:

1550

# - for video, http: or https: schema is required.

1551

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1552

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1553

# - for more, http: or https: schema is required.

1554

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1555

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1556

},

1557

],

1558

"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.

1559

"signature": "A String", # The signature of the conference data.

1560

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1561

# Unset for a conference with a failed create request.

1562

# Optional for a conference with a pending create request.

1563

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1564

# Unset for a conference with a failed create request.

1565

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1566

"name": "A String", # The user-visible name of this solution. Not localized.

1567

"key": { # The key which can uniquely identify the conference solution for this event.

1568

"type": "A String", # The conference solution type.

1569

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1570

# The possible values are:

1571

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1572

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1573

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1574

# - "addOn" for 3P conference providers

1575

},

1576

"iconUri": "A String", # The user-visible icon for this solution.

1577

},

1578

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1579

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

1586

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1587

"requestId": "A String", # The client-generated unique ID for this request.

1588

# 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.

1589

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1590

"type": "A String", # The conference solution type.

1591

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1592

# The possible values are:

1593

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1594

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1595

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1596

# - "addOn" for 3P conference providers

1597

},

1598

"status": { # The status of the conference create request.

1599

"statusCode": "A String", # The current status of the conference create request. Read-only.

1600

# The possible values are:

1601

# - "pending": the conference create request is still being processed.

1602

# - "success": the conference create request succeeded, the entry points are populated.

1603

# - "failure": the conference create request failed, there are no entry points.

},

},

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1608

"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.

1609

"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.

1610

"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.

1611

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1612

},

1613

"kind": "calendar#event", # Type of the resource ("calendar#event").

1614

"sequence": 42, # Sequence number as per iCalendar.

1615

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1616

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1617

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1618

# - "icon" - The gadget displays next to the event's title in the calendar view.

1619

# - "chip" - The gadget displays when the event is clicked.

1620

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1621

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1622

"preferences": { # Preferences.

1623

"a_key": "A String", # The preference name and corresponding value.

1624

},

1625

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1626

"type": "A String", # The gadget's type. Deprecated.

1627

"title": "A String", # The gadget's title. Deprecated.

1628

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1629

},

1630

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1631

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1632

"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.

1633

"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.

1634

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1635

},

1636

"description": "A String", # Description of the event. Can contain HTML. Optional.

1637

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1638

# - "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.

1639

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1640

"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.

1641

"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.

1642

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

1643

{

1644

"displayName": "A String", # The attendee's name, if available. Optional.

1645

"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.

1646

# Required when adding an attendee.

1647

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1648

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1649

"responseStatus": "A String", # The attendee's response status. Possible values are:

1650

# - "needsAction" - The attendee has not responded to the invitation.

1651

# - "declined" - The attendee has declined the invitation.

1652

# - "tentative" - The attendee has tentatively accepted the invitation.

1653

# - "accepted" - The attendee has accepted the invitation.

1654

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1655

"comment": "A String", # The attendee's response comment. Optional.

1656

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1657

"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.

1658

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1659

},

1660

],

1661

"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:

1662

# - 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

1663

# - the length of the ID must be between 5 and 1024 characters

1664

# - 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.

1665

# If you do not specify an ID, it will be automatically generated by the server.

1666

# 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.

1667

"visibility": "default", # Visibility of the event. Optional. Possible values are:

1668

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

1669

# - "public" - The event is public and event details are visible to all readers of the calendar.

1670

# - "private" - The event is private and only event attendees may view event details.

1671

# - "confidential" - The event is private. This value is provided for compatibility reasons.

1672

"reminders": { # Information about the event's reminders for the authenticated user.

1673

"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.

1674

{

1675

"method": "A String", # The method used by this reminder. Possible values are:

1676

# - "email" - Reminders are sent via email.

1677

# - "popup" - Reminders are sent via a UI popup.

1678

# Required when adding a reminder.

1679

"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).

1680

# Required when adding a reminder.

1681

},

1682

],

1683

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

1684

},

1685

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

1686

# In order to modify attachments the supportsAttachments request parameter should be set to true.

1687

# There can be at most 25 attachments per event,

1688

{

1689

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

1690

"title": "A String", # Attachment title.

1691

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

1692

"fileId": "A String", # ID of the attached file. Read-only.

1693

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

1694

"fileUrl": "A String", # URL link to the attachment.

1695

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

1696

# Required when adding an attachment.

1697

},

1698

],

1699

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

1700

"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.

1701

"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.

1702

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1703

},

1704

"etag": "A String", # ETag of the resource.

1705

"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.

1706

"A String",

1707

],

1708

"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

1709

"displayName": "A String", # The organizer's name, if available.

1710

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

1711

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1712

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1713

},

1714

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

1715

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

1716

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

1717

"location": "A String", # Geographic location of the event as free-form text. Optional.

1718

"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.

1719

"creator": { # The creator of the event. Read-only.

1720

"displayName": "A String", # The creator's name, if available.

1721

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1722

"email": "A String", # The creator's email address, if available.

1723

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

1724

},

1725

"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.

1726

"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.

1727

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

1728

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

1729

},

1730

"status": "A String", # Status of the event. Optional. Possible values are:

1731

# - "confirmed" - The event is confirmed. This is the default status.

1732

# - "tentative" - The event is tentatively confirmed.

1733

# - "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.

1734

# A cancelled status represents two different states depending on the event type:

1735

# - 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.

1736

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

1737

# - 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.

1738

# 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.

1739

# 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.

1740

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

1741

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

1742

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

1743

"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.

1744

},

1745

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1746

"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).

1747

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1748

"method": "A String", # The method used by this reminder. Possible values are:

1749

# - "email" - Reminders are sent via email.

1750

# - "popup" - Reminders are sent via a UI popup.

1751

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1752

"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).

1753

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1754

},

1755

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1756

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="instances_next">instances_next(previous_request, previous_response)</code>

1762

<pre>Retrieves the next page of results.

1763

1764

Args:

1765

previous_request: The request for the previous page. (required)

1766

previous_response: The response from the request for the previous page. (required)

1767

1768

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1769

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1770

page. Returns None if there are no more items in the collection.

</pre>

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1775

<code class="details" id="list">list(calendarId, q=None, pageToken=None, updatedMin=None, timeMin=None, showHiddenInvitations=None, iCalUID=None, privateExtendedProperty=None, timeMax=None, singleEvents=None, sharedExtendedProperty=None, syncToken=None, alwaysIncludeEmail=None, timeZone=None, maxResults=None, showDeleted=None, maxAttendees=None, orderBy=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1776

<pre>Returns events on the specified calendar.

1777

1778

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1779

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1780

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1781

pageToken: string, Token specifying which result page to return. Optional.

1782

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.

1783

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.

1784

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

1785

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

1786

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)

1787

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.

1788

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.

1789

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)

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

1790

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.

1791

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

1797

- q

1798

- sharedExtendedProperty

1799

- timeMin

1800

- timeMax

1801

- 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.

1802

Learn more about incremental synchronization.

1803

Optional. The default is to return all entries.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1804

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

1805

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

1806

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.

1807

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.

1808

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.

1809

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

1810

Allowed values

1811

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

1812

updated - Order by last modification time (ascending).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1813

1814

Returns:

1815

An object of the form:

1816

1817

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1818

"accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:

1819

# - "none" - The user has no access.

1820

# - "freeBusyReader" - The user has read access to free/busy information.

1821

# - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

1822

# - "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.

1823

# - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1824

"description": "A String", # Description of the calendar. Read-only.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1825

"summary": "A String", # Title of the calendar. Read-only.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

1826

"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.

1827

"timeZone": "A String", # The time zone of the calendar. Read-only.

1828

"updated": "A String", # Last modification time of the calendar (as a RFC3339 timestamp). Read-only.

1829

"kind": "calendar#events", # Type of the collection ("calendar#events").

1830

"etag": "A String", # ETag of the collection.

1831

"items": [ # List of events on the calendar.

1832

{

1833

"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.

1834

# 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.

1835

"extendedProperties": { # Extended properties of the event.

1836

"private": { # Properties that are private to the copy of the event that appears on this calendar.

1837

"a_key": "A String", # The name of the private property and the corresponding value.

1838

},

1839

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

1840

"a_key": "A String", # The name of the shared property and the corresponding value.

1841

},

1842

},

1843

"summary": "A String", # Title of the event.

1844

"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.

1845

"conferenceId": "A String", # The ID of the conference.

1846

# Can be used by developers to keep track of conferences, should not be displayed to users.

1847

# Values for solution types:

1848

# - "eventHangout": unset.

1849

# - "eventNamedHangout": the name of the Hangout.

1850

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

1851

# - "addOn": defined by 3P conference provider. Optional.

1852

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

1853

# All of them must belong to the same conference.

1854

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1855

{

1856

"entryPointType": "A String", # The type of the conference entry point.

1857

# Possible values are:

1858

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

1859

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

1860

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

1861

# - "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.

1862

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

1863

# Examples:

1864

# - for video: meet.google.com/aaa-bbbb-ccc

1865

# - for phone: +1 123 268 2601

1866

# - for sip: 12345678@altostrat.com

1867

# - for more: should not be filled

1868

# Optional.

1869

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

1870

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1871

# Optional.

1872

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

1873

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1874

# Optional.

1875

"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.

1876

"A String",

1877

],

1878

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

1879

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1880

# Optional.

1881

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

1882

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1883

# Optional.

1884

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

1885

# Calendar backend will populate this field only for EntryPointType.PHONE.

1886

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

1887

# Format:

1888

# - for video, http: or https: schema is required.

1889

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

1890

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

1891

# - for more, http: or https: schema is required.

1892

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

1893

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

1894

},

1895

],

1896

"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.

1897

"signature": "A String", # The signature of the conference data.

1898

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

1899

# Unset for a conference with a failed create request.

1900

# Optional for a conference with a pending create request.

1901

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

1902

# Unset for a conference with a failed create request.

1903

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1904

"name": "A String", # The user-visible name of this solution. Not localized.

1905

"key": { # The key which can uniquely identify the conference solution for this event.

1906

"type": "A String", # The conference solution type.

1907

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1908

# The possible values are:

1909

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1910

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1911

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1912

# - "addOn" for 3P conference providers

1913

},

1914

"iconUri": "A String", # The user-visible icon for this solution.

1915

},

1916

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

1917

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

1924

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

1925

"requestId": "A String", # The client-generated unique ID for this request.

1926

# 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.

1927

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

1928

"type": "A String", # The conference solution type.

1929

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

1930

# The possible values are:

1931

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

1932

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

1933

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

1934

# - "addOn" for 3P conference providers

1935

},

1936

"status": { # The status of the conference create request.

1937

"statusCode": "A String", # The current status of the conference create request. Read-only.

1938

# The possible values are:

1939

# - "pending": the conference create request is still being processed.

1940

# - "success": the conference create request succeeded, the entry points are populated.

1941

# - "failure": the conference create request failed, there are no entry points.

},

},

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

1946

"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.

1947

"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.

1948

"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.

1949

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1950

},

1951

"kind": "calendar#event", # Type of the resource ("calendar#event").

1952

"sequence": 42, # Sequence number as per iCalendar.

1953

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

1954

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

1955

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

1956

# - "icon" - The gadget displays next to the event's title in the calendar view.

1957

# - "chip" - The gadget displays when the event is clicked.

1958

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

1959

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

1960

"preferences": { # Preferences.

1961

"a_key": "A String", # The preference name and corresponding value.

1962

},

1963

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

1964

"type": "A String", # The gadget's type. Deprecated.

1965

"title": "A String", # The gadget's title. Deprecated.

1966

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

1967

},

1968

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

1969

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

1970

"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.

1971

"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.

1972

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

1973

},

1974

"description": "A String", # Description of the event. Can contain HTML. Optional.

1975

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

1976

# - "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.

1977

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

1978

"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.

1979

"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.

1980

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

1981

{

1982

"displayName": "A String", # The attendee's name, if available. Optional.

1983

"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.

1984

# Required when adding an attendee.

1985

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

1986

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

1987

"responseStatus": "A String", # The attendee's response status. Possible values are:

1988

# - "needsAction" - The attendee has not responded to the invitation.

1989

# - "declined" - The attendee has declined the invitation.

1990

# - "tentative" - The attendee has tentatively accepted the invitation.

1991

# - "accepted" - The attendee has accepted the invitation.

1992

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

1993

"comment": "A String", # The attendee's response comment. Optional.

1994

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

1995

"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.

1996

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

1997

},

1998

],

1999

"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:

2000

# - 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

2001

# - the length of the ID must be between 5 and 1024 characters

2002

# - 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.

2003

# If you do not specify an ID, it will be automatically generated by the server.

2004

# 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.

2005

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2006

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2007

# - "public" - The event is public and event details are visible to all readers of the calendar.

2008

# - "private" - The event is private and only event attendees may view event details.

2009

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2010

"reminders": { # Information about the event's reminders for the authenticated user.

2011

"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.

2012

{

2013

"method": "A String", # The method used by this reminder. Possible values are:

2014

# - "email" - Reminders are sent via email.

2015

# - "popup" - Reminders are sent via a UI popup.

2016

# Required when adding a reminder.

2017

"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).

2018

# Required when adding a reminder.

2019

},

2020

],

2021

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2022

},

2023

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2024

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2025

# There can be at most 25 attachments per event,

2026

{

2027

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2028

"title": "A String", # Attachment title.

2029

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2030

"fileId": "A String", # ID of the attached file. Read-only.

2031

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2032

"fileUrl": "A String", # URL link to the attachment.

2033

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2034

# Required when adding an attachment.

2035

},

2036

],

2037

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2038

"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.

2039

"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.

2040

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2041

},

2042

"etag": "A String", # ETag of the resource.

2043

"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.

2044

"A String",

2045

],

2046

"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.

2047

"displayName": "A String", # The organizer's name, if available.

2048

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2049

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2050

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2051

},

2052

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2053

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2054

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2055

"location": "A String", # Geographic location of the event as free-form text. Optional.

2056

"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.

2057

"creator": { # The creator of the event. Read-only.

2058

"displayName": "A String", # The creator's name, if available.

2059

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2060

"email": "A String", # The creator's email address, if available.

2061

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2062

},

2063

"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.

2064

"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.

2065

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2066

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2067

},

2068

"status": "A String", # Status of the event. Optional. Possible values are:

2069

# - "confirmed" - The event is confirmed. This is the default status.

2070

# - "tentative" - The event is tentatively confirmed.

2071

# - "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.

2072

# A cancelled status represents two different states depending on the event type:

2073

# - 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.

2074

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2075

# - 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.

2076

# 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.

2077

# 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.

2078

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2079

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2080

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2081

"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.

2082

},

2083

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2084

"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).

2085

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2086

"method": "A String", # The method used by this reminder. Possible values are:

2087

# - "email" - Reminders are sent via email.

2088

# - "popup" - Reminders are sent via a UI popup.

2089

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2090

"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).

2091

# Required when adding a reminder.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2092

},

2093

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2094

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2100

<pre>Retrieves the next page of results.

2101

2102

Args:

2103

previous_request: The request for the previous page. (required)

2104

previous_response: The response from the request for the previous page. (required)

2105

2106

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2107

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2108

page. Returns None if there are no more items in the collection.

</pre>

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2113

<code class="details" id="move">move(calendarId, eventId, destination, sendUpdates=None, sendNotifications=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2114

<pre>Moves an event to another calendar, i.e. changes an event's organizer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2115

2116

Args:

2117

calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)

2118

eventId: string, Event identifier. (required)

2119

destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2120

sendUpdates: string, Guests who should receive notifications about the change of the event's organizer.

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

2121

Allowed values

2122

all - Notifications are sent to all guests.

2123

externalOnly - Notifications are sent to non-Google Calendar guests only.

2124

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2125

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2126

2127

Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2128

2129

Returns:

2130

An object of the form:

2131

2132

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2133

"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.

2134

# 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.

2135

"extendedProperties": { # Extended properties of the event.

2136

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2137

"a_key": "A String", # The name of the private property and the corresponding value.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2138

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2139

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2140

"a_key": "A String", # The name of the shared property and the corresponding value.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2141

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2142

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2143

"summary": "A String", # Title of the event.

2144

"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.

2145

"conferenceId": "A String", # The ID of the conference.

2146

# Can be used by developers to keep track of conferences, should not be displayed to users.

2147

# Values for solution types:

2148

# - "eventHangout": unset.

2149

# - "eventNamedHangout": the name of the Hangout.

2150

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2151

# - "addOn": defined by 3P conference provider. Optional.

2152

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2153

# All of them must belong to the same conference.

2154

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2155

{

2156

"entryPointType": "A String", # The type of the conference entry point.

2157

# Possible values are:

2158

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2159

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2160

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2161

# - "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.

2162

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2163

# Examples:

2164

# - for video: meet.google.com/aaa-bbbb-ccc

2165

# - for phone: +1 123 268 2601

2166

# - for sip: 12345678@altostrat.com

2167

# - for more: should not be filled

2168

# Optional.

2169

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2170

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2171

# Optional.

2172

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2173

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2174

# Optional.

2175

"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.

2176

"A String",

2177

],

2178

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2179

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2180

# Optional.

2181

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2182

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2183

# Optional.

2184

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2185

# Calendar backend will populate this field only for EntryPointType.PHONE.

2186

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2187

# Format:

2188

# - for video, http: or https: schema is required.

2189

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2190

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2191

# - for more, http: or https: schema is required.

2192

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2193

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2194

},

2195

],

2196

"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.

2197

"signature": "A String", # The signature of the conference data.

2198

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2199

# Unset for a conference with a failed create request.

2200

# Optional for a conference with a pending create request.

2201

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2202

# Unset for a conference with a failed create request.

2203

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2204

"name": "A String", # The user-visible name of this solution. Not localized.

2205

"key": { # The key which can uniquely identify the conference solution for this event.

2206

"type": "A String", # The conference solution type.

2207

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2208

# The possible values are:

2209

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2210

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2211

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2212

# - "addOn" for 3P conference providers

2213

},

2214

"iconUri": "A String", # The user-visible icon for this solution.

2215

},

2216

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2217

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

2224

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2225

"requestId": "A String", # The client-generated unique ID for this request.

2226

# 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.

2227

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2228

"type": "A String", # The conference solution type.

2229

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2230

# The possible values are:

2231

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2232

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2233

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2234

# - "addOn" for 3P conference providers

2235

},

2236

"status": { # The status of the conference create request.

2237

"statusCode": "A String", # The current status of the conference create request. Read-only.

2238

# The possible values are:

2239

# - "pending": the conference create request is still being processed.

2240

# - "success": the conference create request succeeded, the entry points are populated.

2241

# - "failure": the conference create request failed, there are no entry points.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2242

},

2243

},

2244

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2245

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2246

"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.

2247

"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.

2248

"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.

2249

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2250

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2251

"kind": "calendar#event", # Type of the resource ("calendar#event").

2252

"sequence": 42, # Sequence number as per iCalendar.

2253

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2254

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2255

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2256

# - "icon" - The gadget displays next to the event's title in the calendar view.

2257

# - "chip" - The gadget displays when the event is clicked.

2258

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2259

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2260

"preferences": { # Preferences.

2261

"a_key": "A String", # The preference name and corresponding value.

2262

},

2263

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2264

"type": "A String", # The gadget's type. Deprecated.

2265

"title": "A String", # The gadget's title. Deprecated.

2266

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2267

},

2268

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2269

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2270

"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.

2271

"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.

2272

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2273

},

2274

"description": "A String", # Description of the event. Can contain HTML. Optional.

2275

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2276

# - "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.

2277

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2278

"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.

2279

"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.

2280

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2281

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2282

"displayName": "A String", # The attendee's name, if available. Optional.

2283

"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.

2284

# Required when adding an attendee.

2285

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2286

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2287

"responseStatus": "A String", # The attendee's response status. Possible values are:

2288

# - "needsAction" - The attendee has not responded to the invitation.

2289

# - "declined" - The attendee has declined the invitation.

2290

# - "tentative" - The attendee has tentatively accepted the invitation.

2291

# - "accepted" - The attendee has accepted the invitation.

2292

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2293

"comment": "A String", # The attendee's response comment. Optional.

2294

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2295

"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.

2296

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2297

},

2298

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2299

"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:

2300

# - 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

2301

# - the length of the ID must be between 5 and 1024 characters

2302

# - 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.

2303

# If you do not specify an ID, it will be automatically generated by the server.

2304

# 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.

2305

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2306

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2307

# - "public" - The event is public and event details are visible to all readers of the calendar.

2308

# - "private" - The event is private and only event attendees may view event details.

2309

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2310

"reminders": { # Information about the event's reminders for the authenticated user.

2311

"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.

2312

{

2313

"method": "A String", # The method used by this reminder. Possible values are:

2314

# - "email" - Reminders are sent via email.

2315

# - "popup" - Reminders are sent via a UI popup.

2316

# Required when adding a reminder.

2317

"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).

2318

# Required when adding a reminder.

2319

},

2320

],

2321

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2322

},

2323

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2324

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2325

# There can be at most 25 attachments per event,

2326

{

2327

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2328

"title": "A String", # Attachment title.

2329

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2330

"fileId": "A String", # ID of the attached file. Read-only.

2331

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2332

"fileUrl": "A String", # URL link to the attachment.

2333

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2334

# Required when adding an attachment.

2335

},

2336

],

2337

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2338

"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.

2339

"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.

2340

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2341

},

2342

"etag": "A String", # ETag of the resource.

2343

"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.

2344

"A String",

2345

],

2346

"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.

2347

"displayName": "A String", # The organizer's name, if available.

2348

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2349

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2350

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2351

},

2352

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2353

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2354

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2355

"location": "A String", # Geographic location of the event as free-form text. Optional.

2356

"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.

2357

"creator": { # The creator of the event. Read-only.

2358

"displayName": "A String", # The creator's name, if available.

2359

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2360

"email": "A String", # The creator's email address, if available.

2361

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2362

},

2363

"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.

2364

"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.

2365

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2366

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2367

},

2368

"status": "A String", # Status of the event. Optional. Possible values are:

2369

# - "confirmed" - The event is confirmed. This is the default status.

2370

# - "tentative" - The event is tentatively confirmed.

2371

# - "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.

2372

# A cancelled status represents two different states depending on the event type:

2373

# - 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.

2374

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2375

# - 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.

2376

# 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.

2377

# 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.

2378

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2379

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2380

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2381

"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.

2382

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2383

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2384

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2385

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2386

<code class="details" id="patch">patch(calendarId, eventId, body=None, supportsAttachments=None, alwaysIncludeEmail=None, sendNotifications=None, maxAttendees=None, sendUpdates=None, conferenceDataVersion=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2387

<pre>Updates an event. This method supports patch semantics.

2388

2389

Args:

2390

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

2391

eventId: string, Event identifier. (required)

2392

body: object, The request body.

2393

The object takes the form of:

2394

2395

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2396

"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.

2397

# 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.

2398

"extendedProperties": { # Extended properties of the event.

2399

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2400

"a_key": "A String", # The name of the private property and the corresponding value.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2401

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2402

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2403

"a_key": "A String", # The name of the shared property and the corresponding value.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2404

},

2405

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2406

"summary": "A String", # Title of the event.

2407

"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.

2408

"conferenceId": "A String", # The ID of the conference.

2409

# Can be used by developers to keep track of conferences, should not be displayed to users.

2410

# Values for solution types:

2411

# - "eventHangout": unset.

2412

# - "eventNamedHangout": the name of the Hangout.

2413

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2414

# - "addOn": defined by 3P conference provider. Optional.

2415

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2416

# All of them must belong to the same conference.

2417

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2418

{

2419

"entryPointType": "A String", # The type of the conference entry point.

2420

# Possible values are:

2421

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2422

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2423

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2424

# - "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.

2425

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2426

# Examples:

2427

# - for video: meet.google.com/aaa-bbbb-ccc

2428

# - for phone: +1 123 268 2601

2429

# - for sip: 12345678@altostrat.com

2430

# - for more: should not be filled

2431

# Optional.

2432

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2433

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2434

# Optional.

2435

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2436

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2437

# Optional.

2438

"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.

2439

"A String",

2440

],

2441

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2442

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2443

# Optional.

2444

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2445

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2446

# Optional.

2447

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2448

# Calendar backend will populate this field only for EntryPointType.PHONE.

2449

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2450

# Format:

2451

# - for video, http: or https: schema is required.

2452

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2453

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2454

# - for more, http: or https: schema is required.

2455

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2456

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2457

},

2458

],

2459

"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.

2460

"signature": "A String", # The signature of the conference data.

2461

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2462

# Unset for a conference with a failed create request.

2463

# Optional for a conference with a pending create request.

2464

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2465

# Unset for a conference with a failed create request.

2466

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2467

"name": "A String", # The user-visible name of this solution. Not localized.

2468

"key": { # The key which can uniquely identify the conference solution for this event.

2469

"type": "A String", # The conference solution type.

2470

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2471

# The possible values are:

2472

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2473

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2474

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2475

# - "addOn" for 3P conference providers

2476

},

2477

"iconUri": "A String", # The user-visible icon for this solution.

2478

},

2479

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2480

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

2487

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2488

"requestId": "A String", # The client-generated unique ID for this request.

2489

# 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.

2490

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2491

"type": "A String", # The conference solution type.

2492

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2493

# The possible values are:

2494

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2495

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2496

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2497

# - "addOn" for 3P conference providers

2498

},

2499

"status": { # The status of the conference create request.

2500

"statusCode": "A String", # The current status of the conference create request. Read-only.

2501

# The possible values are:

2502

# - "pending": the conference create request is still being processed.

2503

# - "success": the conference create request succeeded, the entry points are populated.

2504

# - "failure": the conference create request failed, there are no entry points.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2505

},

2506

},

2507

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2508

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2509

"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.

2510

"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.

2511

"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.

2512

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2513

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2514

"kind": "calendar#event", # Type of the resource ("calendar#event").

2515

"sequence": 42, # Sequence number as per iCalendar.

2516

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2517

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2518

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2519

# - "icon" - The gadget displays next to the event's title in the calendar view.

2520

# - "chip" - The gadget displays when the event is clicked.

2521

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2522

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2523

"preferences": { # Preferences.

2524

"a_key": "A String", # The preference name and corresponding value.

2525

},

2526

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2527

"type": "A String", # The gadget's type. Deprecated.

2528

"title": "A String", # The gadget's title. Deprecated.

2529

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2530

},

2531

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2532

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2533

"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.

2534

"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.

2535

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2536

},

2537

"description": "A String", # Description of the event. Can contain HTML. Optional.

2538

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2539

# - "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.

2540

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2541

"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.

2542

"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.

2543

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2544

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2545

"displayName": "A String", # The attendee's name, if available. Optional.

2546

"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.

2547

# Required when adding an attendee.

2548

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2549

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2550

"responseStatus": "A String", # The attendee's response status. Possible values are:

2551

# - "needsAction" - The attendee has not responded to the invitation.

2552

# - "declined" - The attendee has declined the invitation.

2553

# - "tentative" - The attendee has tentatively accepted the invitation.

2554

# - "accepted" - The attendee has accepted the invitation.

2555

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2556

"comment": "A String", # The attendee's response comment. Optional.

2557

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2558

"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.

2559

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2560

},

2561

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2562

"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:

2563

# - 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

2564

# - the length of the ID must be between 5 and 1024 characters

2565

# - 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.

2566

# If you do not specify an ID, it will be automatically generated by the server.

2567

# 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.

2568

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2569

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2570

# - "public" - The event is public and event details are visible to all readers of the calendar.

2571

# - "private" - The event is private and only event attendees may view event details.

2572

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2573

"reminders": { # Information about the event's reminders for the authenticated user.

2574

"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.

2575

{

2576

"method": "A String", # The method used by this reminder. Possible values are:

2577

# - "email" - Reminders are sent via email.

2578

# - "popup" - Reminders are sent via a UI popup.

2579

# Required when adding a reminder.

2580

"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).

2581

# Required when adding a reminder.

2582

},

2583

],

2584

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2585

},

2586

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2587

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2588

# There can be at most 25 attachments per event,

2589

{

2590

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2591

"title": "A String", # Attachment title.

2592

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2593

"fileId": "A String", # ID of the attached file. Read-only.

2594

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2595

"fileUrl": "A String", # URL link to the attachment.

2596

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2597

# Required when adding an attachment.

2598

},

2599

],

2600

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2601

"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.

2602

"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.

2603

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2604

},

2605

"etag": "A String", # ETag of the resource.

2606

"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.

2607

"A String",

2608

],

2609

"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.

2610

"displayName": "A String", # The organizer's name, if available.

2611

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2612

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2613

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2614

},

2615

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2616

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2617

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2618

"location": "A String", # Geographic location of the event as free-form text. Optional.

2619

"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.

2620

"creator": { # The creator of the event. Read-only.

2621

"displayName": "A String", # The creator's name, if available.

2622

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2623

"email": "A String", # The creator's email address, if available.

2624

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2625

},

2626

"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.

2627

"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.

2628

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2629

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2630

},

2631

"status": "A String", # Status of the event. Optional. Possible values are:

2632

# - "confirmed" - The event is confirmed. This is the default status.

2633

# - "tentative" - The event is tentatively confirmed.

2634

# - "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.

2635

# A cancelled status represents two different states depending on the event type:

2636

# - 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.

2637

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2638

# - 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.

2639

# 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.

2640

# 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.

2641

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2642

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2643

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2644

"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.

2645

}

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2646

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2647

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

2648

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2649

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2650

2651

Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.

2652

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2653

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

2654

Allowed values

2655

all - Notifications are sent to all guests.

2656

externalOnly - Notifications are sent to non-Google Calendar guests only.

2657

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).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2658

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.

2659

2660

Returns:

2661

An object of the form:

2662

2663

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2664

"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.

2665

# 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.

2666

"extendedProperties": { # Extended properties of the event.

2667

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2668

"a_key": "A String", # The name of the private property and the corresponding value.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2669

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2670

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2671

"a_key": "A String", # The name of the shared property and the corresponding value.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2672

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2673

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2674

"summary": "A String", # Title of the event.

2675

"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.

2676

"conferenceId": "A String", # The ID of the conference.

2677

# Can be used by developers to keep track of conferences, should not be displayed to users.

2678

# Values for solution types:

2679

# - "eventHangout": unset.

2680

# - "eventNamedHangout": the name of the Hangout.

2681

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2682

# - "addOn": defined by 3P conference provider. Optional.

2683

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2684

# All of them must belong to the same conference.

2685

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2686

{

2687

"entryPointType": "A String", # The type of the conference entry point.

2688

# Possible values are:

2689

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2690

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2691

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2692

# - "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.

2693

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2694

# Examples:

2695

# - for video: meet.google.com/aaa-bbbb-ccc

2696

# - for phone: +1 123 268 2601

2697

# - for sip: 12345678@altostrat.com

2698

# - for more: should not be filled

2699

# Optional.

2700

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2701

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2702

# Optional.

2703

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2704

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2705

# Optional.

2706

"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.

2707

"A String",

2708

],

2709

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2710

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2711

# Optional.

2712

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2713

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2714

# Optional.

2715

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2716

# Calendar backend will populate this field only for EntryPointType.PHONE.

2717

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2718

# Format:

2719

# - for video, http: or https: schema is required.

2720

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2721

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2722

# - for more, http: or https: schema is required.

2723

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2724

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2725

},

2726

],

2727

"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.

2728

"signature": "A String", # The signature of the conference data.

2729

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

2730

# Unset for a conference with a failed create request.

2731

# Optional for a conference with a pending create request.

2732

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

2733

# Unset for a conference with a failed create request.

2734

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2735

"name": "A String", # The user-visible name of this solution. Not localized.

2736

"key": { # The key which can uniquely identify the conference solution for this event.

2737

"type": "A String", # The conference solution type.

2738

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2739

# The possible values are:

2740

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2741

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2742

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2743

# - "addOn" for 3P conference providers

2744

},

2745

"iconUri": "A String", # The user-visible icon for this solution.

2746

},

2747

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

2748

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

2755

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2756

"requestId": "A String", # The client-generated unique ID for this request.

2757

# 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.

2758

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

2759

"type": "A String", # The conference solution type.

2760

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

2761

# The possible values are:

2762

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

2763

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

2764

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

2765

# - "addOn" for 3P conference providers

2766

},

2767

"status": { # The status of the conference create request.

2768

"statusCode": "A String", # The current status of the conference create request. Read-only.

2769

# The possible values are:

2770

# - "pending": the conference create request is still being processed.

2771

# - "success": the conference create request succeeded, the entry points are populated.

2772

# - "failure": the conference create request failed, there are no entry points.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2773

},

2774

},

2775

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2776

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

2777

"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.

2778

"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.

2779

"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.

2780

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2781

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2782

"kind": "calendar#event", # Type of the resource ("calendar#event").

2783

"sequence": 42, # Sequence number as per iCalendar.

2784

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

2785

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

2786

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

2787

# - "icon" - The gadget displays next to the event's title in the calendar view.

2788

# - "chip" - The gadget displays when the event is clicked.

2789

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

2790

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

2791

"preferences": { # Preferences.

2792

"a_key": "A String", # The preference name and corresponding value.

2793

},

2794

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

2795

"type": "A String", # The gadget's type. Deprecated.

2796

"title": "A String", # The gadget's title. Deprecated.

2797

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

2798

},

2799

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

2800

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

2801

"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.

2802

"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.

2803

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2804

},

2805

"description": "A String", # Description of the event. Can contain HTML. Optional.

2806

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

2807

# - "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.

2808

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

2809

"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.

2810

"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.

2811

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2812

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2813

"displayName": "A String", # The attendee's name, if available. Optional.

2814

"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.

2815

# Required when adding an attendee.

2816

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

2817

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

2818

"responseStatus": "A String", # The attendee's response status. Possible values are:

2819

# - "needsAction" - The attendee has not responded to the invitation.

2820

# - "declined" - The attendee has declined the invitation.

2821

# - "tentative" - The attendee has tentatively accepted the invitation.

2822

# - "accepted" - The attendee has accepted the invitation.

2823

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

2824

"comment": "A String", # The attendee's response comment. Optional.

2825

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2826

"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.

2827

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2828

},

2829

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2830

"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:

2831

# - 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

2832

# - the length of the ID must be between 5 and 1024 characters

2833

# - 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.

2834

# If you do not specify an ID, it will be automatically generated by the server.

2835

# 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.

2836

"visibility": "default", # Visibility of the event. Optional. Possible values are:

2837

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

2838

# - "public" - The event is public and event details are visible to all readers of the calendar.

2839

# - "private" - The event is private and only event attendees may view event details.

2840

# - "confidential" - The event is private. This value is provided for compatibility reasons.

2841

"reminders": { # Information about the event's reminders for the authenticated user.

2842

"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.

2843

{

2844

"method": "A String", # The method used by this reminder. Possible values are:

2845

# - "email" - Reminders are sent via email.

2846

# - "popup" - Reminders are sent via a UI popup.

2847

# Required when adding a reminder.

2848

"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).

2849

# Required when adding a reminder.

2850

},

2851

],

2852

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

2853

},

2854

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

2855

# In order to modify attachments the supportsAttachments request parameter should be set to true.

2856

# There can be at most 25 attachments per event,

2857

{

2858

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

2859

"title": "A String", # Attachment title.

2860

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

2861

"fileId": "A String", # ID of the attached file. Read-only.

2862

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

2863

"fileUrl": "A String", # URL link to the attachment.

2864

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

2865

# Required when adding an attachment.

2866

},

2867

],

2868

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

2869

"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.

2870

"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.

2871

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

2872

},

2873

"etag": "A String", # ETag of the resource.

2874

"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.

2875

"A String",

2876

],

2877

"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.

2878

"displayName": "A String", # The organizer's name, if available.

2879

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

2880

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2881

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2882

},

2883

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

2884

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

2885

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

2886

"location": "A String", # Geographic location of the event as free-form text. Optional.

2887

"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.

2888

"creator": { # The creator of the event. Read-only.

2889

"displayName": "A String", # The creator's name, if available.

2890

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

2891

"email": "A String", # The creator's email address, if available.

2892

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

2893

},

2894

"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.

2895

"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.

2896

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

2897

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

2898

},

2899

"status": "A String", # Status of the event. Optional. Possible values are:

2900

# - "confirmed" - The event is confirmed. This is the default status.

2901

# - "tentative" - The event is tentatively confirmed.

2902

# - "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.

2903

# A cancelled status represents two different states depending on the event type:

2904

# - 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.

2905

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

2906

# - 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.

2907

# 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.

2908

# 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.

2909

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

2910

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

2911

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

2912

"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.

2913

}</pre>

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2917

<code class="details" id="quickAdd">quickAdd(calendarId, text, sendNotifications=None, sendUpdates=None)</code>

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2918

<pre>Creates an event based on a simple text string.

2919

2920

Args:

2921

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

2922

text: string, The text describing the event to be created. (required)

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2923

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

2924

2925

Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2926

sendUpdates: string, Guests who should receive notifications about the creation of the new event.

2927

Allowed values

2928

all - Notifications are sent to all guests.

2929

externalOnly - Notifications are sent to non-Google Calendar guests only.

2930

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2931

2932

Returns:

2933

An object of the form:

2934

2935

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2936

"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.

2937

# 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.

2938

"extendedProperties": { # Extended properties of the event.

2939

"private": { # Properties that are private to the copy of the event that appears on this calendar.

2940

"a_key": "A String", # The name of the private property and the corresponding value.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2941

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2942

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

2943

"a_key": "A String", # The name of the shared property and the corresponding value.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

2944

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2945

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

2946

"summary": "A String", # Title of the event.

2947

"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.

2948

"conferenceId": "A String", # The ID of the conference.

2949

# Can be used by developers to keep track of conferences, should not be displayed to users.

2950

# Values for solution types:

2951

# - "eventHangout": unset.

2952

# - "eventNamedHangout": the name of the Hangout.

2953

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

2954

# - "addOn": defined by 3P conference provider. Optional.

2955

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

2956

# All of them must belong to the same conference.

2957

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

2958

{

2959

"entryPointType": "A String", # The type of the conference entry point.

2960

# Possible values are:

2961

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

2962

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

2963

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

2964

# - "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.

2965

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

2966

# Examples:

2967

# - for video: meet.google.com/aaa-bbbb-ccc

2968

# - for phone: +1 123 268 2601

2969

# - for sip: 12345678@altostrat.com

2970

# - for more: should not be filled

2971

# Optional.

2972

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

2973

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2974

# Optional.

2975

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

2976

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2977

# Optional.

2978

"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.

2979

"A String",

2980

],

2981

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

2982

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2983

# Optional.

2984

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

2985

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2986

# Optional.

2987

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

2988

# Calendar backend will populate this field only for EntryPointType.PHONE.

2989

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

2990

# Format:

2991

# - for video, http: or https: schema is required.

2992

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

2993

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

2994

# - for more, http: or https: schema is required.

2995

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

2996

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

2997

},

2998

],

2999

"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.

3000

"signature": "A String", # The signature of the conference data.

3001

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3002

# Unset for a conference with a failed create request.

3003

# Optional for a conference with a pending create request.

3004

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3005

# Unset for a conference with a failed create request.

3006

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3007

"name": "A String", # The user-visible name of this solution. Not localized.

3008

"key": { # The key which can uniquely identify the conference solution for this event.

3009

"type": "A String", # The conference solution type.

3010

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3011

# The possible values are:

3012

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3013

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3014

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3015

# - "addOn" for 3P conference providers

3016

},

3017

"iconUri": "A String", # The user-visible icon for this solution.

3018

},

3019

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3020

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

3027

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3028

"requestId": "A String", # The client-generated unique ID for this request.

3029

# 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.

3030

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3031

"type": "A String", # The conference solution type.

3032

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3033

# The possible values are:

3034

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3035

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3036

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3037

# - "addOn" for 3P conference providers

3038

},

3039

"status": { # The status of the conference create request.

3040

"statusCode": "A String", # The current status of the conference create request. Read-only.

3041

# The possible values are:

3042

# - "pending": the conference create request is still being processed.

3043

# - "success": the conference create request succeeded, the entry points are populated.

3044

# - "failure": the conference create request failed, there are no entry points.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3045

},

3046

},

3047

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3048

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3049

"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.

3050

"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.

3051

"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.

3052

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3053

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3054

"kind": "calendar#event", # Type of the resource ("calendar#event").

3055

"sequence": 42, # Sequence number as per iCalendar.

3056

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3057

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3058

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3059

# - "icon" - The gadget displays next to the event's title in the calendar view.

3060

# - "chip" - The gadget displays when the event is clicked.

3061

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3062

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3063

"preferences": { # Preferences.

3064

"a_key": "A String", # The preference name and corresponding value.

3065

},

3066

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3067

"type": "A String", # The gadget's type. Deprecated.

3068

"title": "A String", # The gadget's title. Deprecated.

3069

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3070

},

3071

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3072

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3073

"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.

3074

"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.

3075

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3076

},

3077

"description": "A String", # Description of the event. Can contain HTML. Optional.

3078

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3079

# - "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.

3080

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3081

"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.

3082

"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.

3083

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3084

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3085

"displayName": "A String", # The attendee's name, if available. Optional.

3086

"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.

3087

# Required when adding an attendee.

3088

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3089

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3090

"responseStatus": "A String", # The attendee's response status. Possible values are:

3091

# - "needsAction" - The attendee has not responded to the invitation.

3092

# - "declined" - The attendee has declined the invitation.

3093

# - "tentative" - The attendee has tentatively accepted the invitation.

3094

# - "accepted" - The attendee has accepted the invitation.

3095

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3096

"comment": "A String", # The attendee's response comment. Optional.

3097

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3098

"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.

3099

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3100

},

3101

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3102

"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:

3103

# - 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

3104

# - the length of the ID must be between 5 and 1024 characters

3105

# - 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.

3106

# If you do not specify an ID, it will be automatically generated by the server.

3107

# 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.

3108

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3109

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3110

# - "public" - The event is public and event details are visible to all readers of the calendar.

3111

# - "private" - The event is private and only event attendees may view event details.

3112

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3113

"reminders": { # Information about the event's reminders for the authenticated user.

3114

"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.

3115

{

3116

"method": "A String", # The method used by this reminder. Possible values are:

3117

# - "email" - Reminders are sent via email.

3118

# - "popup" - Reminders are sent via a UI popup.

3119

# Required when adding a reminder.

3120

"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).

3121

# Required when adding a reminder.

3122

},

3123

],

3124

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3125

},

3126

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3127

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3128

# There can be at most 25 attachments per event,

3129

{

3130

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3131

"title": "A String", # Attachment title.

3132

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3133

"fileId": "A String", # ID of the attached file. Read-only.

3134

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3135

"fileUrl": "A String", # URL link to the attachment.

3136

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3137

# Required when adding an attachment.

3138

},

3139

],

3140

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3141

"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.

3142

"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.

3143

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3144

},

3145

"etag": "A String", # ETag of the resource.

3146

"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.

3147

"A String",

3148

],

3149

"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.

3150

"displayName": "A String", # The organizer's name, if available.

3151

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3152

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3153

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3154

},

3155

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3156

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3157

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3158

"location": "A String", # Geographic location of the event as free-form text. Optional.

3159

"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.

3160

"creator": { # The creator of the event. Read-only.

3161

"displayName": "A String", # The creator's name, if available.

3162

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3163

"email": "A String", # The creator's email address, if available.

3164

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3165

},

3166

"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.

3167

"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.

3168

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3169

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3170

},

3171

"status": "A String", # Status of the event. Optional. Possible values are:

3172

# - "confirmed" - The event is confirmed. This is the default status.

3173

# - "tentative" - The event is tentatively confirmed.

3174

# - "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.

3175

# A cancelled status represents two different states depending on the event type:

3176

# - 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.

3177

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3178

# - 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.

3179

# 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.

3180

# 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.

3181

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3182

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3183

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3184

"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.

3185

}</pre>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3189

<code class="details" id="update">update(calendarId, eventId, body=None, alwaysIncludeEmail=None, sendNotifications=None, conferenceDataVersion=None, supportsAttachments=None, maxAttendees=None, sendUpdates=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3190

<pre>Updates an event.

3191

3192

Args:

3193

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

3194

eventId: string, Event identifier. (required)

3195

body: object, The request body.

3196

The object takes the form of:

3197

3198

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3199

"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.

3200

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3201

"extendedProperties": { # Extended properties of the event.

3202

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3203

"a_key": "A String", # The name of the private property and the corresponding value.

3204

},

3205

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3206

"a_key": "A String", # The name of the shared property and the corresponding value.

3207

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

3208

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3209

"summary": "A String", # Title of the event.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3210

"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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3211

"conferenceId": "A String", # The ID of the conference.

3212

# Can be used by developers to keep track of conferences, should not be displayed to users.

3213

# Values for solution types:

3214

# - "eventHangout": unset.

3215

# - "eventNamedHangout": the name of the Hangout.

3216

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3217

# - "addOn": defined by 3P conference provider. Optional.

3218

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3219

# All of them must belong to the same conference.

3220

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3221

{

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3222

"entryPointType": "A String", # The type of the conference entry point.

3223

# Possible values are:

3224

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3225

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3226

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3227

# - "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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3228

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3229

# Examples:

3230

# - for video: meet.google.com/aaa-bbbb-ccc

3231

# - for phone: +1 123 268 2601

3232

# - for sip: 12345678@altostrat.com

3233

# - for more: should not be filled

3234

# Optional.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3235

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3236

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3237

# Optional.

3238

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3239

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3240

# Optional.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3241

"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.

3242

"A String",

3243

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3244

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3245

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3246

# Optional.

3247

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3248

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3249

# Optional.

3250

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3251

# Calendar backend will populate this field only for EntryPointType.PHONE.

3252

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3253

# Format:

3254

# - for video, http: or https: schema is required.

3255

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3256

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3257

# - for more, http: or https: schema is required.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3258

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3259

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3260

},

3261

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3262

"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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3263

"signature": "A String", # The signature of the conference data.

3264

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3265

# Unset for a conference with a failed create request.

3266

# Optional for a conference with a pending create request.

3267

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3268

# Unset for a conference with a failed create request.

3269

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3270

"name": "A String", # The user-visible name of this solution. Not localized.

3271

"key": { # The key which can uniquely identify the conference solution for this event.

3272

"type": "A String", # The conference solution type.

3273

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3274

# The possible values are:

3275

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3276

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3277

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3278

# - "addOn" for 3P conference providers

3279

},

3280

"iconUri": "A String", # The user-visible icon for this solution.

3281

},

3282

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3283

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

3290

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3291

"requestId": "A String", # The client-generated unique ID for this request.

3292

# 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.

3293

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3294

"type": "A String", # The conference solution type.

3295

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3296

# The possible values are:

3297

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3298

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3299

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3300

# - "addOn" for 3P conference providers

3301

},

3302

"status": { # The status of the conference create request.

3303

"statusCode": "A String", # The current status of the conference create request. Read-only.

3304

# The possible values are:

3305

# - "pending": the conference create request is still being processed.

3306

# - "success": the conference create request succeeded, the entry points are populated.

3307

# - "failure": the conference create request failed, there are no entry points.

3308

},

3309

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

3310

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3311

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3312

"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.

3313

"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.

3314

"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.

3315

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3316

},

3317

"kind": "calendar#event", # Type of the resource ("calendar#event").

3318

"sequence": 42, # Sequence number as per iCalendar.

3319

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3320

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3321

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3322

# - "icon" - The gadget displays next to the event's title in the calendar view.

3323

# - "chip" - The gadget displays when the event is clicked.

3324

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3325

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3326

"preferences": { # Preferences.

3327

"a_key": "A String", # The preference name and corresponding value.

3328

},

3329

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3330

"type": "A String", # The gadget's type. Deprecated.

3331

"title": "A String", # The gadget's title. Deprecated.

3332

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3333

},

3334

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3335

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3336

"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.

3337

"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.

3338

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3339

},

3340

"description": "A String", # Description of the event. Can contain HTML. Optional.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3341

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3342

# - "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.

3343

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3344

"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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3345

"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.

3346

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

3347

{

3348

"displayName": "A String", # The attendee's name, if available. Optional.

3349

"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.

3350

# Required when adding an attendee.

3351

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3352

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3353

"responseStatus": "A String", # The attendee's response status. Possible values are:

3354

# - "needsAction" - The attendee has not responded to the invitation.

3355

# - "declined" - The attendee has declined the invitation.

3356

# - "tentative" - The attendee has tentatively accepted the invitation.

3357

# - "accepted" - The attendee has accepted the invitation.

3358

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3359

"comment": "A String", # The attendee's response comment. Optional.

3360

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3361

"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.

3362

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3363

},

3364

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3365

"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:

3366

# - 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

3367

# - the length of the ID must be between 5 and 1024 characters

3368

# - 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.

3369

# If you do not specify an ID, it will be automatically generated by the server.

3370

# Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3371

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3372

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3373

# - "public" - The event is public and event details are visible to all readers of the calendar.

3374

# - "private" - The event is private and only event attendees may view event details.

3375

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3376

"reminders": { # Information about the event's reminders for the authenticated user.

3377

"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.

3378

{

3379

"method": "A String", # The method used by this reminder. Possible values are:

3380

# - "email" - Reminders are sent via email.

3381

# - "popup" - Reminders are sent via a UI popup.

3382

# Required when adding a reminder.

3383

"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).

3384

# Required when adding a reminder.

3385

},

3386

],

3387

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3388

},

3389

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3390

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3391

# There can be at most 25 attachments per event,

3392

{

3393

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3394

"title": "A String", # Attachment title.

3395

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3396

"fileId": "A String", # ID of the attached file. Read-only.

3397

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3398

"fileUrl": "A String", # URL link to the attachment.

3399

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3400

# Required when adding an attachment.

3401

},

3402

],

3403

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3404

"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.

3405

"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.

3406

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3407

},

3408

"etag": "A String", # ETag of the resource.

3409

"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.

3410

"A String",

3411

],

3412

"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.

3413

"displayName": "A String", # The organizer's name, if available.

3414

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3415

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3416

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3417

},

3418

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3419

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3420

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3421

"location": "A String", # Geographic location of the event as free-form text. Optional.

3422

"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.

3423

"creator": { # The creator of the event. Read-only.

3424

"displayName": "A String", # The creator's name, if available.

3425

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3426

"email": "A String", # The creator's email address, if available.

3427

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3428

},

3429

"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.

3430

"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.

3431

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3432

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3433

},

3434

"status": "A String", # Status of the event. Optional. Possible values are:

3435

# - "confirmed" - The event is confirmed. This is the default status.

3436

# - "tentative" - The event is tentatively confirmed.

3437

# - "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.

3438

# A cancelled status represents two different states depending on the event type:

3439

# - 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.

3440

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3441

# - 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.

3442

# 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.

3443

# 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.

3444

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3445

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3446

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3447

"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.

3448

}

3449

3450

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).

3451

sendNotifications: boolean, Deprecated. Please use sendUpdates instead.

3452

3453

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.

3454

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.

3455

supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False.

3456

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

3457

sendUpdates: string, Guests who should receive notifications about the event update (for example, title changes, etc.).

3458

Allowed values

3459

all - Notifications are sent to all guests.

3460

externalOnly - Notifications are sent to non-Google Calendar guests only.

3461

none - No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

3462

3463

Returns:

3464

An object of the form:

3465

3466

{

3467

"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.

3468

# 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.

3469

"extendedProperties": { # Extended properties of the event.

3470

"private": { # Properties that are private to the copy of the event that appears on this calendar.

3471

"a_key": "A String", # The name of the private property and the corresponding value.

3472

},

3473

"shared": { # Properties that are shared between copies of the event on other attendees' calendars.

3474

"a_key": "A String", # The name of the shared property and the corresponding value.

3475

},

3476

},

3477

"summary": "A String", # Title of the event.

3478

"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.

3479

"conferenceId": "A String", # The ID of the conference.

3480

# Can be used by developers to keep track of conferences, should not be displayed to users.

3481

# Values for solution types:

3482

# - "eventHangout": unset.

3483

# - "eventNamedHangout": the name of the Hangout.

3484

# - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".

3485

# - "addOn": defined by 3P conference provider. Optional.

3486

"entryPoints": [ # Information about individual conference entry points, such as URLs or phone numbers.

3487

# All of them must belong to the same conference.

3488

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3489

{

3490

"entryPointType": "A String", # The type of the conference entry point.

3491

# Possible values are:

3492

# - "video" - joining a conference over HTTP. A conference can have zero or one video entry point.

3493

# - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.

3494

# - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.

3495

# - "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.

3496

"label": "A String", # The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

3497

# Examples:

3498

# - for video: meet.google.com/aaa-bbbb-ccc

3499

# - for phone: +1 123 268 2601

3500

# - for sip: 12345678@altostrat.com

3501

# - for more: should not be filled

3502

# Optional.

3503

"accessCode": "A String", # The access code to access the conference. The maximum length is 128 characters.

3504

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3505

# Optional.

3506

"pin": "A String", # The PIN to access the conference. The maximum length is 128 characters.

3507

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3508

# Optional.

3509

"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.

3510

"A String",

3511

],

3512

"password": "A String", # The password to access the conference. The maximum length is 128 characters.

3513

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3514

# Optional.

3515

"meetingCode": "A String", # The meeting code to access the conference. The maximum length is 128 characters.

3516

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3517

# Optional.

3518

"regionCode": "A String", # The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.

3519

# Calendar backend will populate this field only for EntryPointType.PHONE.

3520

"uri": "A String", # The URI of the entry point. The maximum length is 1300 characters.

3521

# Format:

3522

# - for video, http: or https: schema is required.

3523

# - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).

3524

# - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.

3525

# - for more, http: or https: schema is required.

3526

"passcode": "A String", # The passcode to access the conference. The maximum length is 128 characters.

3527

# When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

3528

},

3529

],

3530

"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.

3531

"signature": "A String", # The signature of the conference data.

3532

# Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

3533

# Unset for a conference with a failed create request.

3534

# Optional for a conference with a pending create request.

3535

"conferenceSolution": { # The conference solution, such as Hangouts or Google Meet.

3536

# Unset for a conference with a failed create request.

3537

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3538

"name": "A String", # The user-visible name of this solution. Not localized.

3539

"key": { # The key which can uniquely identify the conference solution for this event.

3540

"type": "A String", # The conference solution type.

3541

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3542

# The possible values are:

3543

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3544

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3545

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3546

# - "addOn" for 3P conference providers

3547

},

3548

"iconUri": "A String", # The user-visible icon for this solution.

3549

},

3550

"parameters": { # Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.

3551

"addOnParameters": { # Additional add-on specific data.

"parameters": {

"a_key": "A String",

},

},

},

"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.

3558

# Either conferenceSolution and at least one entryPoint, or createRequest is required.

3559

"requestId": "A String", # The client-generated unique ID for this request.

3560

# 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.

3561

"conferenceSolutionKey": { # The conference solution, such as Hangouts or Google Meet.

3562

"type": "A String", # The conference solution type.

3563

# If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

3564

# The possible values are:

3565

# - "eventHangout" for Hangouts for consumers (http://hangouts.google.com)

3566

# - "eventNamedHangout" for classic Hangouts for Google Workspace users (http://hangouts.google.com)

3567

# - "hangoutsMeet" for Google Meet (http://meet.google.com)

3568

# - "addOn" for 3P conference providers

3569

},

3570

"status": { # The status of the conference create request.

3571

"statusCode": "A String", # The current status of the conference create request. Read-only.

3572

# The possible values are:

3573

# - "pending": the conference create request is still being processed.

3574

# - "success": the conference create request succeeded, the entry points are populated.

3575

# - "failure": the conference create request failed, there are no entry points.

},

},

},

"created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only.

3580

"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.

3581

"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.

3582

"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.

3583

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3584

},

3585

"kind": "calendar#event", # Type of the resource ("calendar#event").

3586

"sequence": 42, # Sequence number as per iCalendar.

3587

"hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.

3588

"gadget": { # A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.

3589

"display": "A String", # The gadget's display mode. Deprecated. Possible values are:

3590

# - "icon" - The gadget displays next to the event's title in the calendar view.

3591

# - "chip" - The gadget displays when the event is clicked.

3592

"height": 42, # The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.

3593

"iconLink": "A String", # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.

3594

"preferences": { # Preferences.

3595

"a_key": "A String", # The preference name and corresponding value.

3596

},

3597

"link": "A String", # The gadget's URL. The URL scheme must be HTTPS. Deprecated.

3598

"type": "A String", # The gadget's type. Deprecated.

3599

"title": "A String", # The gadget's title. Deprecated.

3600

"width": 42, # The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.

3601

},

3602

"anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

3603

"end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

3604

"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.

3605

"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.

3606

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3607

},

3608

"description": "A String", # Description of the event. Can contain HTML. Optional.

3609

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are:

3610

# - "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.

3611

# - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

3612

"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.

3613

"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.

3614

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.

3615

{

3616

"displayName": "A String", # The attendee's name, if available. Optional.

3617

"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.

3618

# Required when adding an attendee.

3619

"optional": false, # Whether this is an optional attendee. Optional. The default is False.

3620

"organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.

3621

"responseStatus": "A String", # The attendee's response status. Possible values are:

3622

# - "needsAction" - The attendee has not responded to the invitation.

3623

# - "declined" - The attendee has declined the invitation.

3624

# - "tentative" - The attendee has tentatively accepted the invitation.

3625

# - "accepted" - The attendee has accepted the invitation.

3626

"self": false, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.

3627

"comment": "A String", # The attendee's response comment. Optional.

3628

"id": "A String", # The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3629

"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.

3630

"additionalGuests": 0, # Number of additional guests. Optional. The default is 0.

3631

},

3632

],

3633

"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:

3634

# - 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

3635

# - the length of the ID must be between 5 and 1024 characters

3636

# - 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.

3637

# If you do not specify an ID, it will be automatically generated by the server.

3638

# 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.

3639

"visibility": "default", # Visibility of the event. Optional. Possible values are:

3640

# - "default" - Uses the default visibility for events on the calendar. This is the default value.

3641

# - "public" - The event is public and event details are visible to all readers of the calendar.

3642

# - "private" - The event is private and only event attendees may view event details.

3643

# - "confidential" - The event is private. This value is provided for compatibility reasons.

3644

"reminders": { # Information about the event's reminders for the authenticated user.

3645

"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.

3646

{

3647

"method": "A String", # The method used by this reminder. Possible values are:

3648

# - "email" - Reminders are sent via email.

3649

# - "popup" - Reminders are sent via a UI popup.

3650

# Required when adding a reminder.

3651

"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).

3652

# Required when adding a reminder.

3653

},

3654

],

3655

"useDefault": True or False, # Whether the default reminders of the calendar apply to the event.

3656

},

3657

"attachments": [ # File attachments for the event. Currently only Google Drive attachments are supported.

3658

# In order to modify attachments the supportsAttachments request parameter should be set to true.

3659

# There can be at most 25 attachments per event,

3660

{

3661

"iconLink": "A String", # URL link to the attachment's icon. Read-only.

3662

"title": "A String", # Attachment title.

3663

"mimeType": "A String", # Internet media type (MIME type) of the attachment.

3664

"fileId": "A String", # ID of the attached file. Read-only.

3665

# For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

3666

"fileUrl": "A String", # URL link to the attachment.

3667

# For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

3668

# Required when adding an attachment.

3669

},

3670

],

3671

"start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

3672

"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.

3673

"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.

3674

"date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.

3675

},

3676

"etag": "A String", # ETag of the resource.

3677

"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.

3678

"A String",

3679

],

3680

"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.

3681

"displayName": "A String", # The organizer's name, if available.

3682

"email": "A String", # The organizer's email address, if available. It must be a valid email address as per RFC5322.

3683

"id": "A String", # The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3684

"self": false, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3685

},

3686

"guestsCanModify": false, # Whether attendees other than the organizer can modify the event. Optional. The default is False.

3687

"guestsCanSeeOtherGuests": true, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

3688

"updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only.

3689

"location": "A String", # Geographic location of the event as free-form text. Optional.

3690

"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.

3691

"creator": { # The creator of the event. Read-only.

3692

"displayName": "A String", # The creator's name, if available.

3693

"id": "A String", # The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API

3694

"email": "A String", # The creator's email address, if available.

3695

"self": false, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.

3696

},

3697

"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.

3698

"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.

3699

"url": "A String", # URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

3700

"title": "A String", # Title of the source; for example a title of a web page or an email subject.

3701

},

3702

"status": "A String", # Status of the event. Optional. Possible values are:

3703

# - "confirmed" - The event is confirmed. This is the default status.

3704

# - "tentative" - The event is tentatively confirmed.

3705

# - "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.

3706

# A cancelled status represents two different states depending on the event type:

3707

# - 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.

3708

# Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

3709

# - 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.

3710

# 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.

3711

# 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.

3712

"recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

3713

"htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.

3714

"guestsCanInviteOthers": true, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

3715

"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.

3716

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3720

<code class="details" id="watch">watch(calendarId, body=None, showDeleted=None, maxAttendees=None, updatedMin=None, privateExtendedProperty=None, singleEvents=None, timeMax=None, q=None, showHiddenInvitations=None, alwaysIncludeEmail=None, timeZone=None, iCalUID=None, pageToken=None, orderBy=None, maxResults=None, sharedExtendedProperty=None, timeMin=None, syncToken=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3721

<pre>Watch for changes to Events resources.

3722

3723

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3724

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

3725

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3726

The object takes the form of:

3727

3728

{

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3729

"id": "A String", # A UUID or similar unique string that identifies this channel.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3730

"resourceUri": "A String", # A version-specific identifier for the watched resource.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3731

"address": "A String", # The address where notifications are delivered for this channel.

3732

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3733

"type": "A String", # The type of delivery mechanism used for this channel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3734

"params": { # Additional parameters controlling delivery channel behavior. Optional.

3735

"a_key": "A String", # Declares a new parameter by name.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3736

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3737

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

3738

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

3739

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

3740

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3741

}

3742

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3743

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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3744

maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3745

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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3746

privateExtendedProperty: string, Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. (repeated)

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3747

singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

3748

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.

3749

q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

3750

showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.

3751

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).

3752

timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.

3753

iCalUID: string, Specifies event ID in the iCalendar format to be included in the response. Optional.

3754

pageToken: string, Token specifying which result page to return. Optional.

3755

orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.

3756

Allowed values

3757

startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)

3758

updated - Order by last modification time (ascending).

3759

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.

3760

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)

3761

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.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

3762

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.

3763

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

- iCalUID

- orderBy

- privateExtendedProperty

3769

- q

3770

- sharedExtendedProperty

3771

- timeMin

3772

- timeMax

3773

- 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.

3774

Learn more about incremental synchronization.

3775

Optional. The default is to return all entries.

John Asmuth