Skip to content

Google: Calendar settings schemas

4 Google schemas with complete fields and constraints.

← Calendar settings operations · All schemas

Returns a single user setting — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldsstringOptionalSelector specifying which fields to include in a partial response.
prettyPrintbooleanOptionalReturns response with indentations and line breaks.
Default: true
quotaUserstringOptionalAn opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIpstringOptionalDeprecated. Please use quotaUser instead.

Returns a single user setting — response body

FieldTypePresenceDescription and constraints
$objectRoot
etagstringOptionalETag of the resource.
idstringOptionalThe id of the user setting.
kindstringOptionalType of the resource ("calendar#setting").
Default: calendar#setting
valuestringOptionalValue of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.

Returns all user settings for the authenticated user — response body

FieldTypePresenceDescription and constraints
$objectRoot
etagstringOptionalEtag of the collection.
itemsarrayOptionalList of user settings.
items[]ModelEach itemExpand Returns a single user setting — response body
kindstringOptionalType of the collection ("calendar#settings").
Default: calendar#settings
nextPageTokenstringOptionalToken used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
nextSyncTokenstringOptionalToken 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.

Referenced models: Returns a single user setting — response body

Watch for changes to Settings resources — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldsstringOptionalSelector specifying which fields to include in a partial response.
prettyPrintbooleanOptionalReturns response with indentations and line breaks.
Default: true
quotaUserstringOptionalAn opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIpstringOptionalDeprecated. Please use quotaUser instead.
maxResultsintegerOptionalMaximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
Format: int32
Minimum: 1
pageTokenstringOptionalToken specifying which result page to return. Optional.
syncTokenstringOptionalToken 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.
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.
Learn more about incremental synchronization.
Optional. The default is to return all entries.

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.