Watch
|
|||||
|
|
||||
Watch for changes to Settings resources
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- See, edit, share, and permanently delete all the calendars you can access using Google Calendar
- View your calendars
- View your Calendar settings
Input
This building block consumes 14 input parameters
| Name | Format | Description |
|---|---|---|
maxResults |
INTEGER |
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 |
pageToken |
STRING |
Token specifying which result page to return. Optional |
syncToken |
STRING |
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. 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 |
address |
STRING |
The address where notifications are delivered for this channel |
expiration |
INTEGER |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional |
id |
STRING |
A UUID or similar unique string that identifies this channel |
kind |
STRING |
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel" |
params |
OBJECT |
Additional parameters controlling delivery channel behavior. Optional |
params.customKey.value Required |
STRING |
Additional parameters controlling delivery channel behavior. Optional |
payload |
BOOLEAN |
A Boolean value to indicate whether payload is wanted. Optional |
resourceId |
STRING |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions |
resourceUri |
STRING |
A version-specific identifier for the watched resource |
token |
STRING |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional |
type |
STRING |
The type of delivery mechanism used for this channel |
= Parameter name
= Format
|
maxResults INTEGER 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 |
|
pageToken STRING Token specifying which result page to return. Optional |
|
syncToken STRING 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. 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 |
|
address STRING The address where notifications are delivered for this channel |
|
expiration INTEGER Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional |
|
id STRING A UUID or similar unique string that identifies this channel |
|
kind STRING Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel" |
|
params OBJECT Additional parameters controlling delivery channel behavior. Optional |
|
params.customKey.value STRING Required Additional parameters controlling delivery channel behavior. Optional |
|
payload BOOLEAN A Boolean value to indicate whether payload is wanted. Optional |
|
resourceId STRING An opaque ID that identifies the resource being watched on this channel. Stable across different API versions |
|
resourceUri STRING A version-specific identifier for the watched resource |
|
token STRING An arbitrary string delivered to the target address with each notification delivered over this channel. Optional |
|
type STRING The type of delivery mechanism used for this channel |
Output
This building block provides 11 output parameters
| Name | Format | Description |
|---|---|---|
address |
STRING |
The address where notifications are delivered for this channel |
expiration |
INTEGER |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional |
id |
STRING |
A UUID or similar unique string that identifies this channel |
kind |
STRING |
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel" |
params |
OBJECT |
Additional parameters controlling delivery channel behavior. Optional |
params.customKey.value |
STRING |
Additional parameters controlling delivery channel behavior. Optional |
payload |
BOOLEAN |
A Boolean value to indicate whether payload is wanted. Optional |
resourceId |
STRING |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions |
resourceUri |
STRING |
A version-specific identifier for the watched resource |
token |
STRING |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional |
type |
STRING |
The type of delivery mechanism used for this channel |
= Parameter name
= Format
|
address STRING The address where notifications are delivered for this channel |
|
expiration INTEGER Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional |
|
id STRING A UUID or similar unique string that identifies this channel |
|
kind STRING Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel" |
|
params OBJECT Additional parameters controlling delivery channel behavior. Optional |
|
params.customKey.value STRING Additional parameters controlling delivery channel behavior. Optional |
|
payload BOOLEAN A Boolean value to indicate whether payload is wanted. Optional |
|
resourceId STRING An opaque ID that identifies the resource being watched on this channel. Stable across different API versions |
|
resourceUri STRING A version-specific identifier for the watched resource |
|
token STRING An arbitrary string delivered to the target address with each notification delivered over this channel. Optional |
|
type STRING The type of delivery mechanism used for this channel |