events

Overview

Name	events
Type	Resource
Id	googleworkspace.calendar.events

Fields

Name	Datatype	Description
id	string	Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - 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 - the length of the ID must be between 5 and 1024 characters - 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. If you do not specify an ID, it will be automatically generated by the server. 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.
description	string	Description of the event. Can contain HTML. Optional.
attendeesOmitted	boolean	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.
sequence	integer	Sequence number as per iCalendar.
guestsCanModify	boolean	Whether attendees other than the organizer can modify the event. Optional. The default is False.
start	object
reminders	object	Information about the event's reminders for the authenticated user.
status	string	Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "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. A cancelled status represents two different states depending on the event type: - 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. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - 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. 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. 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.
creator	object	The creator of the event. Read-only.
etag	string	ETag of the resource.
privateCopy	boolean	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.
recurringEventId	string	For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
hangoutLink	string	An absolute link to the Google Hangout associated with this event. Read-only.
anyoneCanAddSelf	boolean	Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.
kind	string	Type of the resource ("calendar#event").
conferenceData	object
attendees	array	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.
originalStartTime	object
endTimeUnspecified	boolean	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.
visibility	string	Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.
gadget	object	A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.
guestsCanSeeOtherGuests	boolean	Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
locked	boolean	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.
attachments	array	File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,
created	string	Creation time of the event (as a RFC3339 timestamp). Read-only.
colorId	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.
iCalUID	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. 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. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.
organizer	object	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.
guestsCanInviteOthers	boolean	Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
extendedProperties	object	Extended properties of the event.
eventType	string	Specific type of the event. Read-only. Possible values are: - "default" - A regular event or not further specified. - "outOfOffice" - An out-of-office event. - "focusTime" - A focus-time event.
recurrence	array	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.
htmlLink	string	An absolute link to this event in the Google Calendar Web UI. Read-only.
summary	string	Title of the event.
updated	string	Last modification time of the event (as a RFC3339 timestamp). Read-only.
source	object	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.
location	string	Geographic location of the event as free-form text. Optional.
transparency	string	Whether the event blocks time on the calendar. Optional. Possible values are: - "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. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
end	object

Methods

Name	Accessible by	Required Params	Description
get	SELECT	calendarId, eventId	Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.
list	SELECT	calendarId	Returns events on the specified calendar.
insert	INSERT	calendarId	Creates an event.
delete	DELETE	calendarId, eventId	Deletes an event.
import	EXEC	calendarId	Imports an event. This operation is used to add a private copy of an existing event to a calendar.
instances	EXEC	calendarId, eventId	Returns instances of the specified recurring event.
move	EXEC	calendarId, destination, eventId	Moves an event to another calendar, i.e. changes an event's organizer.
patch	EXEC	calendarId, eventId	Updates an event. This method supports patch semantics.
quickAdd	EXEC	calendarId, text	Creates an event based on a simple text string.
update	EXEC	calendarId, eventId	Updates an event.
watch	EXEC	calendarId	Watch for changes to Events resources.