changes

POST /changes/watch

Changed on

Subscribes to changes for a user. For more information, see Notifications for resource changes.

Request

  • Base URL
    https://www.googleapis.com/drive/v3
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.appdata
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.appdata
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.file
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.file
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.meet.readonly
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.meet.readonly
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.metadata
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.metadata
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.metadata.readonly
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.metadata.readonly
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.photos.readonly
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.photos.readonly
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.readonly
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.readonly

Query parameters

pageTokenstring 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.

driveIdstring

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.

includeCorpusRemovalsboolean

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.

includeItemsFromAllDrivesboolean

Whether both My Drive and shared drive items should be included in results.

includeLabelsstring

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

includePermissionsForViewstring

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

includeRemovedboolean

Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

includeTeamDriveItemsboolean

Deprecated: Use includeItemsFromAllDrives instead.

pageSizeinteger

The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

restrictToMyDriveboolean

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.

spacesstring

A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.

supportsAllDrivesboolean

Whether the requesting application supports both My Drives and shared drives.

supportsTeamDrivesboolean

Deprecated: Use supportsAllDrives instead.

teamDriveIdstring

Deprecated: Use driveId instead.

Request body

addressstring

The address where notifications are delivered for this channel.

expirationstring int64

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

idstring

A UUID or similar unique string that identifies this channel.

kindstring

Identifies this as a notification channel used to watch for changes to a resource, which is api#channel.

paramsobject

Additional parameters controlling delivery channel behavior. Optional.

payloadboolean

A Boolean value to indicate whether payload is wanted. Optional.

resourceIdstring

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

resourceUristring

A version-specific identifier for the watched resource.

tokenstring

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

typestring

The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".

Response

Successful response

addressstring

The address where notifications are delivered for this channel.

expirationstring int64

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

idstring

A UUID or similar unique string that identifies this channel.

kindstring

Identifies this as a notification channel used to watch for changes to a resource, which is api#channel.

paramsobject

Additional parameters controlling delivery channel behavior. Optional.

payloadboolean

A Boolean value to indicate whether payload is wanted. Optional.

resourceIdstring

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

resourceUristring

A version-specific identifier for the watched resource.

tokenstring

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

typestring

The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".

Changes

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2c