Subscribe to changes for a user.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

• https://www.googleapis.com/auth/drive
• https://www.googleapis.com/auth/drive.appdata
• https://www.googleapis.com/auth/drive.apps.readonly
• https://www.googleapis.com/auth/drive.file
• 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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/drive. You can set the scope for this method like this: drive2 --scope <scope> changes watch ...

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Channel:
  address: string
  expiration: string
  id: string
  kind: string
  params: { string: string }
  payload: boolean
  resource-id: string
  resource-uri: string
  token: string
  type: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . address=et
  • The address where notifications are delivered for this channel.
• expiration=magna
  • Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
• id=no
  • A UUID or similar unique string that identifies this channel.
• kind=ipsum
  • Identifies this as a notification channel used to watch for changes to a resource, which is api#channel.
• params=key=voluptua.
  • Additional parameters controlling delivery channel behavior. Optional.
  • the value will be associated with the given key
• payload=false
  • A Boolean value to indicate whether payload is wanted. Optional.
• resource-id=amet.
  • An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
• resource-uri=takimata
  • A version-specific identifier for the watched resource.
• token=amet.
  • An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
• type=duo
  • The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p drive-id=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.

• -p include-corpus-removals=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.

• -p include-deleted=boolean

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

• -p include-items-from-all-drives=boolean

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

• -p include-labels=string

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

• -p include-permissions-for-view=string

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

• -p include-subscribed=boolean

  • Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.

• -p include-team-drive-items=boolean

  • Deprecated: Use includeItemsFromAllDrives instead.

• -p max-results=integer

  • Maximum number of changes to return.

• -p page-token=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.

• -p spaces=string

  • A comma-separated list of spaces to query. Supported values are drive, appDataFolder and photos.

• -p start-change-id=string

  • Deprecated: Use pageToken instead.

• -p supports-all-drives=boolean

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

• -p supports-team-drives=boolean

  • Deprecated: Use supportsAllDrives instead.

• -p team-drive-id=string

  • Deprecated: Use driveId instead.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

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

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").