Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-133839143.7 KB
acl

Watch for changes to ACL resources.

post/calendars/{calendarId}/acl/watch

Path parameters

calendarIdstring required

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

Query parameters

maxResultsinteger

Maximum 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.

pageTokenstring

Token specifying which result page to return. Optional.

showDeletedboolean

Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

syncTokenstring

Token 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. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. 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.

Request body

expirationstring int64

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

typestring

The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.

addressstring

The address where notifications are delivered for this channel.

resourceIdstring

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

idstring

A UUID or similar unique string that identifies this channel.

kindstring

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

payloadboolean

A Boolean value to indicate whether payload is wanted. Optional.

resourceUristring

A version-specific identifier for the watched resource.

paramsobject

Additional parameters controlling delivery channel behavior. Optional.

tokenstring

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

Response

Successful response