Files: watch

Subscribes to changes to a file. While you can establish a channel for changes to a file on a shared drive, a change to a shared drive file won't create a notification.

Request

HTTP request

POST https://www.googleapis.com/drive/v3/files/fileId/watch

Parameters

Parameter name	Value	Description
Path parameters
`fileId`	`string`	The ID of the file.
Optional query parameters
`acknowledgeAbuse`	`boolean`	Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. (Default: `false`)
`fields`	`string`	The paths of the fields you want included in the response. If not specified, the response includes a default set of fields specific to this method. For development you can use the special value `*` to return all fields, but you'll achieve greater performance by only selecting the fields you need. For more information, see Return specific fields for a file.
`includeLabels`	`string`	A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
`supportsAllDrives`	`boolean`	Whether the requesting application supports both My Drives and shared drives. (Default: `false`)
`supportsTeamDrives`	`boolean`	Warning: This item is deprecated. Deprecated use supportsAllDrives instead. (Default: `false`)

Authorization

This request allows authorization with at least one of the following scopes:

Scope
`https://www.googleapis.com/auth/drive`
`https://www.googleapis.com/auth/drive.file`
`https://www.googleapis.com/auth/drive.readonly`
`https://www.googleapis.com/auth/drive.metadata.readonly`
`https://www.googleapis.com/auth/drive.appdata`
`https://www.googleapis.com/auth/drive.metadata`
`https://www.googleapis.com/auth/drive.photos.readonly`

Some scopes are restricted and require a security assessment for your app to use them. For more information, see the authentication and authorization page.

Request body

In the request body, supply data with the following structure:

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    (key): string
  }
}

Property name	Value	Description
`kind`	`string`	Identifies this as a notification channel used to watch for changes to a resource, which is "`api#channel`".
`id`	`string`	A UUID or similar unique string that identifies this channel.
`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.
`expiration`	`long`	Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
`type`	`string`	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.
`address`	`string`	The address where notifications are delivered for this channel.
`payload`	`boolean`	A Boolean value to indicate whether payload is wanted. Optional.
`params`	`object`	Additional parameters controlling delivery channel behavior. Optional.
`params.(key)`	`string`	Declares a new parameter by name.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    (key): string
  }
}

Property name	Value	Description
`kind`	`string`	Identifies this as a notification channel used to watch for changes to a resource, which is "`api#channel`".
`id`	`string`	A UUID or similar unique string that identifies this channel.
`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.
`expiration`	`long`	Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
`type`	`string`	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.
`address`	`string`	The address where notifications are delivered for this channel.
`payload`	`boolean`	A Boolean value to indicate whether payload is wanted. Optional.
`params`	`object`	Additional parameters controlling delivery channel behavior. Optional.
`params.(key)`	`string`	Declares a new parameter by name.