Skip to content

Google: Calendar calendars schemas

5 Google schemas with complete fields and constraints.

← Calendar calendars operations · All schemas

Creates a secondary calendar.
The authenticated user for the request is made the data owner of the new calendar.

Note: We recommend to authenticate as the intended data owner of the calendar You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user Don't use a service account for authentication If you use a service account for authentication, the service account is the data owner, which can lead to unexpected behavior For example, if a service account is the data owner, data ownership cannot be transferred — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
autoAcceptInvitationsbooleanOptionalWhether this calendar automatically accepts invitations. Only valid for resource calendars.
conferencePropertiesModelOptionalExpand Returns metadata for a calendar — response body — conference Properties
Conferencing properties for this calendar, for example what types of conferences are allowed.
dataOwnerstringOptionalThe email of the owner of the calendar. Set only for secondary calendars. Read-only.
descriptionstringOptionalDescription of the calendar. Optional.
etagstringOptionalETag of the resource.
idstringOptionalIdentifier of the calendar. To retrieve IDs call the calendarList.list() method.
kindstringOptionalType of the resource ("calendar#calendar").
Default: calendar#calendar
labelPropertiesModelOptionalExpand Returns metadata for a calendar — response body — label Properties
Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged.
locationstringOptionalGeographic location of the calendar as free-form text. Optional.
summarystringRequired within parentTitle of the calendar.
timeZonestringOptionalThe time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.

Referenced models: Returns metadata for a calendar — response body — conference Properties, Returns metadata for a calendar — response body — label Properties

Returns metadata for a calendar — response body

FieldTypePresenceDescription and constraints
$objectRoot
autoAcceptInvitationsbooleanOptionalWhether this calendar automatically accepts invitations. Only valid for resource calendars.
conferencePropertiesModelOptionalExpand Returns metadata for a calendar — response body — conference Properties
Conferencing properties for this calendar, for example what types of conferences are allowed.
dataOwnerstringOptionalThe email of the owner of the calendar. Set only for secondary calendars. Read-only.
descriptionstringOptionalDescription of the calendar. Optional.
etagstringOptionalETag of the resource.
idstringOptionalIdentifier of the calendar. To retrieve IDs call the calendarList.list() method.
kindstringOptionalType of the resource ("calendar#calendar").
Default: calendar#calendar
labelPropertiesModelOptionalExpand Returns metadata for a calendar — response body — label Properties
Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged.
locationstringOptionalGeographic location of the calendar as free-form text. Optional.
summarystringOptionalTitle of the calendar.
timeZonestringOptionalThe time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.

Referenced models: Returns metadata for a calendar — response body — conference Properties, Returns metadata for a calendar — response body — label Properties

Returns metadata for a calendar — response body — conference Properties

FieldTypePresenceDescription and constraints
$objectRoot
allowedConferenceSolutionTypesarrayOptionalThe types of conference solutions that are supported for this calendar.
The possible values are:
- "eventHangout"
- "eventNamedHangout"
- "hangoutsMeet" Optional.
allowedConferenceSolutionTypes[]stringEach item

Returns metadata for a calendar — response body — label Properties

FieldTypePresenceDescription and constraints
$objectRoot
eventLabelsarrayOptionalEvent labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels.
Extend the list to add a new event label, and remove entities from the list to delete a label from calendar.
Each calendar can have a maximum of 200 labels.
eventLabels[]ModelEach itemExpand Returns metadata for a calendar — response body — label Properties event Labels item

Referenced models: Returns metadata for a calendar — response body — label Properties event Labels item

Returns metadata for a calendar — response body — label Properties event Labels item

FieldTypePresenceDescription and constraints
$objectRoot
backgroundColorstringOptionalBackground color of the label in hexadecimal format, such as "#039be5". Events with this label are displayed in this color. Required.
idstringOptionalThe ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label.
If provided, the ID must be unique within the calendar and follow UUID format.
namestringOptionalName of the label. Optional.
If provided this must have at most 50 characters.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.