Watch
|
|||||
|
|
||||
Subscribes to changes for a user
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- See, edit, create, and delete all of your Google Drive files
- View and manage its own configuration data in your Google Drive
- View and manage Google Drive files and folders that you have opened or created with this app
- View and manage metadata of files in your Google Drive
- View metadata for files in your Google Drive
- View the photos, videos and albums in your Google Photos
- See and download all your Google Drive files
Input
This building block consumes 23 input parameters
| Name | Format | Description |
|---|---|---|
pageToken Required |
STRING |
The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method |
driveId |
STRING |
The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier |
includeCorpusRemovals |
BOOLEAN |
Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file |
includeItemsFromAllDrives |
BOOLEAN |
Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results |
includeRemoved |
BOOLEAN |
Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access |
includeTeamDriveItems |
BOOLEAN |
Deprecated use includeItemsFromAllDrives instead |
pageSize |
INTEGER |
The maximum number of changes to return per page |
restrictToMyDrive |
BOOLEAN |
Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive |
spaces |
STRING |
A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos' |
supportsAllDrives |
BOOLEAN |
Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives |
supportsTeamDrives |
BOOLEAN |
Deprecated use supportsAllDrives instead |
teamDriveId |
STRING |
Deprecated use driveId instead |
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. Value: the fixed string "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
|
pageToken STRING Required The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method |
|
driveId STRING The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier |
|
includeCorpusRemovals BOOLEAN Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file |
|
includeItemsFromAllDrives BOOLEAN Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results |
|
includeRemoved BOOLEAN Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access |
|
includeTeamDriveItems BOOLEAN Deprecated use includeItemsFromAllDrives instead |
|
pageSize INTEGER The maximum number of changes to return per page |
|
restrictToMyDrive BOOLEAN Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive |
|
spaces STRING A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos' |
|
supportsAllDrives BOOLEAN Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives |
|
supportsTeamDrives BOOLEAN Deprecated use supportsAllDrives instead |
|
teamDriveId STRING Deprecated use driveId instead |
|
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. Value: the fixed string "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. Value: the fixed string "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. Value: the fixed string "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 |