Model tree
Event
Google Calendar Event resource.| Field | Type | Description |
|---|---|---|
start * | EventDateTime | The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
end * | EventDateTime | The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
anyoneCanAddSelf | boolean | Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. |
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. |
description | string | Description of the event. Can contain HTML. Optional. |
eventType | EventTypes | Specific type of the event. This cannot be modified after the event is created. Possible values are: “birthday” - A special all-day event with an annual recurrence. “default” - A regular event or not further specified. “focusTime” - A focus-time event. “fromGmail” - An event from Gmail. This type of event cannot be created. “outOfOffice” - An out-of-office event. “workingLocation” - A working location event. |
guestsCanInviteOthers | boolean | Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
guestsCanModify | boolean | Whether attendees other than the organizer can modify the event. Optional. The default is False. |
guestsCanSeeOtherGuests | boolean | Whether attendees other than the organizer can see who the event’s attendees are. Optional. The default is True. |
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. min length 5; max length 1024; matches ^[a-v0-9]+$ |
location | string | Geographic location of the event as free-form text. Optional. |
sequence | integer | Sequence number as per iCalendar. |
status | "confirmed" | "tentative" | "cancelled" | 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. |
summary | string | Title of the event. |
transparency | "opaque" | "transparent" | 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. |
visibility | "default" | "public" | "private" | "confidential" | 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. |
attachments | Attachment[] | 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. |
attendees | Attendee[] | 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. |
birthdayProperties | BirthdayProperties | Birthday or special event data. Used if eventType is “birthday”. Immutable. |
conferenceData | 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. |
extendedProperties | ExtendedProperties | Extended properties of the event. |
focusTimeProperties | FocusTimeProperties | Focus Time event data. Used if eventType is focusTime. |
gadget | EventGadget | A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
originalStartTime | EventDateTime | 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. |
outOfOfficeProperties | OutOfOfficeProperties | Out of office event data. Used if eventType is outOfOffice. |
recurrence | string[] | 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. |
reminders | Reminders | Information about the event’s reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. |
source | 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. |
workingLocationProperties | WorkingLocationProperties | Working location event data. |
iCalUID | string | Event unique identifier as defined in RFC5545. It is used to uniquely identify events across 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. |
EventDateTime
Represents the start or end of an event.| Field | Type | Description |
|---|---|---|
date | string | The date, in the format “yyyy-mm-dd”, if this is an all-day event. format date |
dateTime | 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. format date-time |
timeZone | 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. |
Attachment
| Field | Type | Description |
|---|---|---|
fileUrl * | string | URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment. |
iconLink | string | URL link to the attachment’s icon. This field can only be modified for custom third-party attachments. |
Attendee
| Field | Type | Description |
|---|---|---|
email * | 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. Required when adding an attendee. |
additionalGuests | integer | Number of additional guests. Optional. The default is 0. ≥ 0; defaults to 0 |
comment | string | The attendee’s response comment. Optional. |
displayName | string | The attendee’s name, if available. Optional. |
optional | boolean | Whether this is an optional attendee. Optional. The default is False. |
resource | boolean | 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. |
responseStatus | "needsAction" | "declined" | "tentative" | "accepted" | The attendee’s response status. Possible values are: “needsAction” - The attendee has not responded to the invitation (recommended for new events). “declined” - The attendee has declined the invitation. “tentative” - The attendee has tentatively accepted the invitation. “accepted” - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with certain settings might have their response reset to needsAction. Furthermore, if more than 200 guests are invited, response status is not propagated. |
BirthdayProperties
| Field | Type | Description |
|---|---|---|
type | string | Type of birthday or special event. Possible values are: “anniversary” - An anniversary other than birthday. Always has a contact. “birthday” - A birthday event. This is the default value. “custom” - A special date whose label is further specified in the customTypeName field. Always has a contact. “other” - A special date which does not fall into the other categories, and does not have a custom label. Always has a contact. “self” - Calendar owner’s own birthday. Cannot have a contact. The Calendar API only supports creating events with the type “birthday”. The type cannot be changed after the event is created. One of anniversary, birthday, custom, other, self. defaults to "birthday" |
ConferenceData
The conference-related information, such as details of a Google Meet conference.| Field | Type | Description |
|---|---|---|
conferenceId | string | The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. The ID value is formed differently for each conference solution type: eventHangout: ID is not set. (This conference type is deprecated.) eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.) hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc. addOn: ID is defined by the third-party provider. Optional. |
conferenceSolution | ConferenceSolution | The conference solution, such as Google Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required. |
createRequest | 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. Either conferenceSolution and at least one entryPoint, or createRequest is required. |
entryPoints | EntryPoint[] | Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either conferenceSolution and at least one entryPoint, or createRequest is required. |
notes | 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. |
ConferenceSolution
The conference solution, such as Google Meet.| Field | Type | Description |
|---|---|---|
iconUri | string | The user-visible icon for this solution. |
key | ConferenceSolutionKey | The key which can uniquely identify the conference solution for this event. |
name | string | The user-visible name of this solution. Not localized. |
ConferenceSolutionKey
| Field | Type | Description |
|---|---|---|
type | "eventHangout" | "eventNamedHangout" | "hangoutsMeet" | "addOn" | The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are: “eventHangout” - Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created). “eventNamedHangout” - Classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created). “hangoutsMeet” - Google Meet (http://meet.google.com). “addOn” - 3P conference providers. |
CreateRequest
A request to generate a new conference and attach it to the event.| Field | Type | Description |
|---|---|---|
conferenceSolutionKey | ConferenceSolutionKey | The conference solution, such as Hangouts or Google Meet. |
requestId | string | The client-generated unique ID for this request. 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. |
status | CreateRequestStatus | The status of the conference create request. |
CreateRequestStatus
The status of the conference create request. This object has no settable fields.EntryPoint
Information about individual conference entry points, such as URLs or phone numbers.| Field | Type | Description |
|---|---|---|
accessCode | string | The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. |
entryPointType | "video" | "phone" | "sip" | "more" | The type of the conference entry point. Possible values are: “video” - joining a conference over HTTP. A conference can have zero or one video entry point. “phone” - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. “sip” - joining a conference over SIP. A conference can have zero or one sip entry point. “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. |
label | string | The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples: for video: meet.google.com/aaa-bbbb-ccc; for phone: +1 123 268 2601; for sip: 12345678@altostrat.com; for more: should not be filled. Optional. |
meetingCode | string | The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. |
passcode | string | The passcode to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. |
password | string | The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. |
pin | string | The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional. |
uri | string | The URI of the entry point. The maximum length is 1300 characters. Format: for video, http: or https: schema is required. for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. for more, http: or https: schema is required. |
ExtendedProperties
| Field | Type | Description |
|---|---|---|
private | map of string | Properties that are private to the copy of the event that appears on this calendar. |
shared | map of string | Properties that are shared between copies of the event on other attendees’ calendars. |
FocusTimeProperties
Focus Time event data. Used if eventType is focusTime.| Field | Type | Description |
|---|---|---|
autoDeclineMode | "declineNone" | "declineAllConflictingInvitations" | "declineOnlyNewConflictingInvitations" | Whether to decline meeting invitations which overlap Focus Time events. Valid values are: “declineNone” - no meeting invitations are declined. “declineAllConflictingInvitations” - all conflicting meeting invitations that conflict with the event are declined. “declineOnlyNewConflictingInvitations” - only new conflicting meeting invitations which arrive while the Focus Time event is present are to be declined. |
chatStatus | "available" | "doNotDisturb" | The status to mark the user in Chat and related products. This can be available or doNotDisturb. |
declineMessage | string | Response message to set if an existing event or new invitation is automatically declined by Calendar. |
EventGadget
A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.| Field | Type | Description |
|---|---|---|
display | "icon" | "chip" | The gadget’s display mode. Deprecated. Possible values are: “icon” - The gadget displays next to the event’s title in the calendar view. “chip” - The gadget displays when the event is clicked. |
height | integer | The gadget’s height in pixels. The height must be an integer greater than 0. Optional. Deprecated. > 0 |
iconLink | string | The gadget’s icon URL. The URL scheme must be HTTPS. Deprecated. |
link | string | The gadget’s URL. The URL scheme must be HTTPS. Deprecated. |
preferences | map of string | Preferences. |
title | string | The gadget’s title. Deprecated. |
type | string | The gadget’s type. Deprecated. |
width | integer | The gadget’s width in pixels. The width must be an integer greater than 0. Optional. Deprecated. > 0 |
OutOfOfficeProperties
Out of office event data. Used if eventType is outOfOffice.| Field | Type | Description |
|---|---|---|
autoDeclineMode | "declineNone" | "declineAllConflictingInvitations" | "declineOnlyNewConflictingInvitations" | Whether to decline meeting invitations which overlap Out of office events. Valid values are: “declineNone” - no meeting invitations are declined. “declineAllConflictingInvitations” - all conflicting meeting invitations that conflict with the event are declined. “declineOnlyNewConflictingInvitations” - only new conflicting meeting invitations which arrive while the Out of office event is present are to be declined. |
declineMessage | string | Response message to set if an existing event or new invitation is automatically declined by Calendar. |
Reminders
| Field | Type | Description |
|---|---|---|
useDefault | boolean | Whether the default reminders of the calendar apply to the event. |
overrides * | ReminderOverride[] | 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. max 5 items |
ReminderOverride
| Field | Type | Description |
|---|---|---|
method * | "email" | "popup" | The method used by this reminder. Possible values are: “email” - Reminders are sent via email. “popup” - Reminders are sent via a UI popup. Required when adding a reminder. |
minutes * | integer | 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). Required when adding a reminder. ≥ 0; ≤ 40320 |
Source
| Field | Type | Description |
|---|---|---|
title | string | Title of the source; for example a title of a web page or an email subject. |
url | string | URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
WorkingLocationProperties
| Field | Type | Description |
|---|---|---|
type * | "homeOffice" | "officeLocation" | "customLocation" | Type of the working location. Possible values are: “homeOffice” - The user is working at home. “officeLocation” - The user is working from an office. “customLocation” - The user is working from a custom location. Any details are specified in a sub-field of the specified name, but this field may be missing if empty. Required when adding working location properties. |
customLocation | CustomLocation | If present, specifies that the user is working from a custom location. |
homeOffice | boolean | If present, specifies that the user is working at home. |
officeLocation | OfficeLocation | If present, specifies that the user is working from an office. |
CustomLocation
| Field | Type | Description |
|---|---|---|
label | string | An optional extra label for additional information. |
OfficeLocation
| Field | Type | Description |
|---|---|---|
buildingId | string | An optional building identifier. This should reference a building ID in the organization’s Resources database. |
deskId | string | An optional desk identifier. |
floorId | string | An optional floor identifier. |
floorSectionId | string | An optional floor section identifier. |
label | string | The office name that’s displayed in Calendar Web and Mobile clients. We recommend you reference a building name in the organization’s Resources database. |
PatchEvent
Event, with every field optional.| Field | Type | Description |
|---|---|---|
start | EventDateTime | The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. |
end | EventDateTime | The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. |
anyoneCanAddSelf | boolean | Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. |
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. |
description | string | Description of the event. Can contain HTML. Optional. |
eventType | EventTypes | Specific type of the event. This cannot be modified after the event is created. Possible values are: “birthday” - A special all-day event with an annual recurrence. “default” - A regular event or not further specified. “focusTime” - A focus-time event. “fromGmail” - An event from Gmail. This type of event cannot be created. “outOfOffice” - An out-of-office event. “workingLocation” - A working location event. |
guestsCanInviteOthers | boolean | Whether attendees other than the organizer can invite others to the event. Optional. The default is True. |
guestsCanModify | boolean | Whether attendees other than the organizer can modify the event. Optional. The default is False. |
guestsCanSeeOtherGuests | boolean | Whether attendees other than the organizer can see who the event’s attendees are. Optional. The default is True. |
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. min length 5; max length 1024; matches ^[a-v0-9]+$ |
location | string | Geographic location of the event as free-form text. Optional. |
sequence | integer | Sequence number as per iCalendar. |
status | "confirmed" | "tentative" | "cancelled" | 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. |
summary | string | Title of the event. |
transparency | "opaque" | "transparent" | 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. |
visibility | "default" | "public" | "private" | "confidential" | 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. |
attachments | Attachment[] | 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. |
attendees | Attendee[] | 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. |
birthdayProperties | BirthdayProperties | Birthday or special event data. Used if eventType is “birthday”. Immutable. |
conferenceData | 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. |
extendedProperties | ExtendedProperties | Extended properties of the event. |
focusTimeProperties | FocusTimeProperties | Focus Time event data. Used if eventType is focusTime. |
gadget | EventGadget | A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. |
originalStartTime | EventDateTime | 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. |
outOfOfficeProperties | OutOfOfficeProperties | Out of office event data. Used if eventType is outOfOffice. |
recurrence | string[] | 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. |
reminders | Reminders | Information about the event’s reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. |
source | 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. |
workingLocationProperties | WorkingLocationProperties | Working location event data. |
SendUpdates
| Value |
|---|
all |
externalOnly |
none |
EventTypes
| Value |
|---|
birthday |
default |
focusTime |
fromGmail |
outOfOffice |
workingLocation |
OrderBy
| Value |
|---|
startTime |
updated |