Method: files.watch
Stay organized with collections
Save and categorize content based on your preferences.
Subscribes to changes to a file.
HTTP request
POST https://www.googleapis.com/drive/v2/files/{fileId}/watch
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
fileId |
string
The ID for the file in question.
|
Query parameters
Parameters |
supportsAllDrives |
boolean
Whether the requesting application supports both My Drives and shared drives.
|
supportsTeamDrives (deprecated) |
boolean
Deprecated: Use supportsAllDrives instead.
|
acknowledgeAbuse |
boolean
Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides.
|
includePermissionsForView |
string
Specifies which additional view's permissions to include in the response. Only published is supported.
|
revisionId |
string
Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
|
updateViewedDate (deprecated) |
boolean
Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
|
projection (deprecated) |
enum (Projection )
Deprecated: This parameter has no function.
|
includeLabels |
string
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
|
Request body
The request body contains an instance of Channel
.
Response body
If successful, the response body contains an instance of Channel
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/docs
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.meet.readonly
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.photos.readonly
https://www.googleapis.com/auth/drive.readonly
Some scopes are restricted and require a security assessment for your app to use them. For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-03 UTC.
[null,null,["Last updated 2025-04-03 UTC."],[],[],null,["# Method: files.watch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nSubscribes to changes to a file.\n\n### HTTP request\n\n`POST https://www.googleapis.com/drive/v2/files/{fileId}/watch`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------|\n| `fileId` | `string` The ID for the file in question. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `supportsAllDrives` | `boolean` Whether the requesting application supports both My Drives and shared drives. |\n| `supportsTeamDrives` **(deprecated)** | `boolean` Deprecated: Use `supportsAllDrives` instead. |\n| `acknowledgeAbuse` | `boolean` Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. |\n| `includePermissionsForView` | `string` Specifies which additional view's permissions to include in the response. Only `published` is supported. |\n| `revisionId` | `string` Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. |\n| `updateViewedDate` **(deprecated)** | `boolean` Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. |\n| `projection` **(deprecated)** | `enum (`[Projection](/workspace/drive/api/reference/rest/v2/Projection)`)` Deprecated: This parameter has no function. |\n| `includeLabels` | `string` A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. |\n\n### Request body\n\nThe request body contains an instance of [Channel](/workspace/drive/api/reference/rest/v2/channels#Channel).\n\n### Response body\n\nIf successful, the response body contains an instance of [Channel](/workspace/drive/api/reference/rest/v2/channels#Channel).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/docs`\n- `\n https://www.googleapis.com/auth/drive`\n- `\n https://www.googleapis.com/auth/drive.appdata`\n- `\n https://www.googleapis.com/auth/drive.file`\n- `\n https://www.googleapis.com/auth/drive.meet.readonly`\n- `\n https://www.googleapis.com/auth/drive.metadata`\n- `\n https://www.googleapis.com/auth/drive.metadata.readonly`\n- `\n https://www.googleapis.com/auth/drive.photos.readonly`\n- `\n https://www.googleapis.com/auth/drive.readonly`\n\nSome scopes are restricted and require a security assessment for your app to use them. For more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]