List
|
|||||
|
|
||||
Returns all user settings for the authenticated user
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 3 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 |
= 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 |
Output
This building block provides 9 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
Etag of the collection |
items[] |
OBJECT |
|
items[].etag |
STRING |
ETag of the resource |
items[].id |
STRING |
The id of the user setting |
items[].kind |
STRING |
Type of the resource ("calendar#setting") |
items[].value |
STRING |
Value 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 |
kind |
STRING |
Type of the collection ("calendar#settings") |
nextPageToken |
STRING |
Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided |
nextSyncToken |
STRING |
Token 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 |
= Parameter name
= Format
|
etag STRING Etag of the collection |
|
items[] OBJECT |
|
items[].etag STRING ETag of the resource |
|
items[].id STRING The id of the user setting |
|
items[].kind STRING Type of the resource ("calendar#setting") |
|
items[].value STRING Value 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 |
|
kind STRING Type of the collection ("calendar#settings") |
|
nextPageToken STRING Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided |
|
nextSyncToken STRING Token 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 |