Google: Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push)

← Drive files operations · Get started

Operation google.drive_files_watch

Provider route: POST /drive/v3/files/{fileId}/watch. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["driveFiles"]["driveFilesWatch"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.driveFiles.driveFilesWatch(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.drive_files.drive_files_watch(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.fileId	string	Required within parent	The ID of the file.
query	Model	Optional	Expand Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — request body — query
body	Model	Required within parent	Expand Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — response body

Referenced models: Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — response body, Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — request body — query

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — response body

Referenced models: Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — response body

Schemas

Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — response body

Field	Type	Presence	Description and constraints
$	object	Root	A notification channel used to watch for resource changes.
address	string	Optional	The address where notifications are delivered for this channel.
expiration	string	Optional	Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. Format: int64
id	string	Optional	A UUID or similar unique string that identifies this channel.
kind	string	Optional	Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. Default: api#channel
params	object	Optional	Additional parameters controlling delivery channel behavior. Optional. Additional keys: see wildcard field
params.*	string	Additional keys
payload	boolean	Optional	A Boolean value to indicate whether payload is wanted. Optional.
resourceId	string	Optional	An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
resourceUri	string	Optional	A version-specific identifier for the watched resource.
token	string	Optional	An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
type	string	Optional	The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".

Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Optional	Selector specifying which fields to include in a partial response.
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
acknowledgeAbuse	boolean	Optional	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. Default: false
includeLabels	string	Optional	A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView	string	Optional	Specifies which additional view's permissions to include in the response. Only `published` is supported.
supportsAllDrives	boolean	Optional	Whether the requesting application supports both My Drives and shared drives. Default: false
supportsTeamDrives	boolean	Optional	Deprecated: Use `supportsAllDrives` instead. Default: false

Policy, approvals and errors

SDK function policy ID: google.drive_files_watch. Catalog operation: drive.files.watch. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["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"]

Official provider source