Google: Calendar calendars schemas
8 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
autoAcceptInvitations | boolean | Optional | Whether this calendar automatically accepts invitations. Only valid for resource calendars. |
conferenceProperties | Model | Optional | Expand Returns metadata for a calendar — response body — conference Properties Conferencing properties for this calendar, for example what types of conferences are allowed. |
dataOwner | string | Optional | The email of the owner of the calendar. Set only for secondary calendars. Read-only. |
description | string | Optional | Description of the calendar. Optional. |
etag | string | Optional | ETag of the resource. |
id | string | Optional | Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
kind | string | Optional | Type of the resource ("calendar#calendar"). Default: calendar#calendar |
labelProperties | Model | Optional | Expand 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. |
location | string | Optional | Geographic location of the calendar as free-form text. Optional. |
summary | string | Required within parent | Title of the calendar. |
timeZone | string | Optional | The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
workingHours | Model | Optional | Expand Updates metadata for a calendar — request body — body working Hours |
Referenced models: Returns metadata for a calendar — response body — conference Properties, Returns metadata for a calendar — response body — label Properties, Updates metadata for a calendar — request body — body working Hours
Returns metadata for a calendar — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
autoAcceptInvitations | boolean | Optional | Whether this calendar automatically accepts invitations. Only valid for resource calendars. |
conferenceProperties | Model | Optional | Expand Returns metadata for a calendar — response body — conference Properties Conferencing properties for this calendar, for example what types of conferences are allowed. |
dataOwner | string | Optional | The email of the owner of the calendar. Set only for secondary calendars. Read-only. |
description | string | Optional | Description of the calendar. Optional. |
etag | string | Optional | ETag of the resource. |
id | string | Optional | Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
kind | string | Optional | Type of the resource ("calendar#calendar"). Default: calendar#calendar |
labelProperties | Model | Optional | Expand 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. |
location | string | Optional | Geographic location of the calendar as free-form text. Optional. |
summary | string | Optional | Title of the calendar. |
timeZone | string | Optional | The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
workingHours | object | Optional | Represents the information about the user's working hours. Only available for primary calendars of Google Workspace users. To update the working hours, the entire working hours object must be passed. If not specified (or passed as null or an empty object), the existing working hours remain unchanged. To disable working hours or clear the schedule, set workingHoursEnabled to false (and omit availableTimes or pass an empty list). |
workingHours.availableTimes | array | Optional | Working hours. Each availability period represents the user's working hours block during one day. |
workingHours.availableTimes[] | object | Each item | |
workingHours.availableTimes[].dayOfWeek | string | Optional | Day of the week. Required. Possible values are: - "monday" - "tuesday" - "wednesday" - "thursday" - "friday" - "saturday" - "sunday" |
workingHours.availableTimes[].periodEnd | JSON | Optional | |
workingHours.availableTimes[].periodEnd (anyOf 1) | integer | Alternative | Period end, in minutes from the start of the day, exclusive. Required. Format: int32 |
workingHours.availableTimes[].periodEnd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workingHours.availableTimes[].periodStart | JSON | Optional | |
workingHours.availableTimes[].periodStart (anyOf 1) | integer | Alternative | Period start, in minutes from the start of the day, inclusive. Required. Format: int32 |
workingHours.availableTimes[].periodStart (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workingHours.workingHoursEnabled | boolean | Optional | Whether the working hours are enabled for this calendar. Cannot be set to true when availableTimes is empty. |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowedConferenceSolutionTypes | array | Optional | The types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional. |
allowedConferenceSolutionTypes[] | string | Each item |
Returns metadata for a calendar — response body — label Properties
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
eventLabels | array | Optional | Event 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[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
backgroundColor | string | Optional | Background color of the label in hexadecimal format, such as "#039be5". Events with this label are displayed in this color. Required. |
id | string | Optional | The 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. |
name | string | Optional | Name of the label. Optional. If provided this must have at most 50 characters. |
Updates metadata for a calendar — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
autoAcceptInvitations | boolean | Optional | Whether this calendar automatically accepts invitations. Only valid for resource calendars. |
conferenceProperties | Model | Optional | Expand Returns metadata for a calendar — response body — conference Properties Conferencing properties for this calendar, for example what types of conferences are allowed. |
dataOwner | string | Optional | The email of the owner of the calendar. Set only for secondary calendars. Read-only. |
description | string | Optional | Description of the calendar. Optional. |
etag | string | Optional | ETag of the resource. |
id | string | Optional | Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
kind | string | Optional | Type of the resource ("calendar#calendar"). Default: calendar#calendar |
labelProperties | Model | Optional | Expand 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. |
location | string | Optional | Geographic location of the calendar as free-form text. Optional. |
summary | string | Optional | Title of the calendar. |
timeZone | string | Optional | The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
workingHours | Model | Optional | Expand Updates metadata for a calendar — request body — body working Hours |
Referenced models: Returns metadata for a calendar — response body — conference Properties, Returns metadata for a calendar — response body — label Properties, Updates metadata for a calendar — request body — body working Hours
Updates metadata for a calendar — request body — body working Hours
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the information about the user's working hours. Only available for primary calendars of Google Workspace users. To update the working hours, the entire working hours object must be passed. If not specified (or passed as null or an empty object), the existing working hours remain unchanged. To disable working hours or clear the schedule, set workingHoursEnabled to false (and omit availableTimes or pass an empty list). |
availableTimes | array | Optional | Working hours. Each availability period represents the user's working hours block during one day. |
availableTimes[] | Model | Each item | Expand Updates metadata for a calendar — request body — body working Hours available Times item |
workingHoursEnabled | boolean | Optional | Whether the working hours are enabled for this calendar. Cannot be set to true when availableTimes is empty. |
Referenced models: Updates metadata for a calendar — request body — body working Hours available Times item
Updates metadata for a calendar — request body — body working Hours available Times item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dayOfWeek | string | Optional | Day of the week. Required. Possible values are: - "monday" - "tuesday" - "wednesday" - "thursday" - "friday" - "saturday" - "sunday" |
periodEnd | integer | Optional | Period end, in minutes from the start of the day, exclusive. Required. Format: int32 |
periodStart | integer | Optional | Period start, in minutes from the start of the day, inclusive. Required. Format: int32 |