Google Changes API

openapi: 3.2.0
info:
  title: Google Drive Changes API
  description: The Google Drive API allows clients to access resources from Google Drive.
  version: v3
  contact:
    name: Google
    url: https://google.com
    x-twitter: youtube
  license:
    name: Creative Commons Attribution 3.0
    url: http://creativecommons.org/licenses/by/3.0/
  termsOfService: https://developers.google.com/terms/
servers:
- url: https://www.googleapis.com/drive/v3
  description: Google Drive API Server
tags:
- name: Changes
  description: Operations related to Changes
paths:
  /changes:
    get:
      tags:
      - Changes
      summary: Google Get Changes
      description: Lists the changes for a user or shared drive.
      operationId: googleDriveChangesList
      security:
      - Oauth2:
        - https://www.googleapis.com/auth/drive
        Oauth2c:
        - https://www.googleapis.com/auth/drive
      - Oauth2:
        - https://www.googleapis.com/auth/drive.appdata
        Oauth2c:
        - https://www.googleapis.com/auth/drive.appdata
      - Oauth2:
        - https://www.googleapis.com/auth/drive.file
        Oauth2c:
        - https://www.googleapis.com/auth/drive.file
      - Oauth2:
        - https://www.googleapis.com/auth/drive.metadata
        Oauth2c:
        - https://www.googleapis.com/auth/drive.metadata
      - Oauth2:
        - https://www.googleapis.com/auth/drive.metadata.readonly
        Oauth2c:
        - https://www.googleapis.com/auth/drive.metadata.readonly
      - Oauth2:
        - https://www.googleapis.com/auth/drive.photos.readonly
        Oauth2c:
        - https://www.googleapis.com/auth/drive.photos.readonly
      - Oauth2:
        - https://www.googleapis.com/auth/drive.readonly
        Oauth2c:
        - https://www.googleapis.com/auth/drive.readonly
      parameters:
      - description: 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.
        in: query
        name: pageToken
        required: true
        schema:
          type: string
      - description: 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.
        in: query
        name: driveId
        schema:
          type: string
      - description: 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.
        in: query
        name: includeCorpusRemovals
        schema:
          type: boolean
      - description: Whether both My Drive and shared drive items should be included in results.
        in: query
        name: includeItemsFromAllDrives
        schema:
          type: boolean
      - description: A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
        in: query
        name: includeLabels
        schema:
          type: string
      - description: Specifies which additional view's permissions to include in the response. Only 'published' is supported.
        in: query
        name: includePermissionsForView
        schema:
          type: string
      - description: Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
        in: query
        name: includeRemoved
        schema:
          type: boolean
      - description: 'Deprecated: Use `includeItemsFromAllDrives` instead.'
        in: query
        name: includeTeamDriveItems
        schema:
          type: boolean
      - description: The maximum number of changes to return per page.
        in: query
        name: pageSize
        schema:
          maximum: 1000
          minimum: 1
          type: integer
      - description: 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.
        in: query
        name: restrictToMyDrive
        schema:
          type: boolean
      - description: A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.
        in: query
        name: spaces
        schema:
          type: string
      - description: Whether the requesting application supports both My Drives and shared drives.
        in: query
        name: supportsAllDrives
        schema:
          type: boolean
      - description: 'Deprecated: Use `supportsAllDrives` instead.'
        in: query
        name: supportsTeamDrives
        schema:
          type: boolean
      - description: 'Deprecated: Use `driveId` instead.'
        in: query
        name: teamDriveId
        schema:
          type: string
      - in: header
        name: Authorization
        schema:
          type: string
      - description: V1 error format.
        in: query
        name: $.xgafv
        schema:
          enum:
          - '1'
          - '2'
          type: string
      - description: OAuth access token.
        in: query
        name: access_token
        schema:
          type: string
      - description: Data format for response.
        in: query
        name: alt
        schema:
          enum:
          - json
          - media
          - proto
          type: string
      - description: JSONP
        in: query
        name: callback
        schema:
          type: string
      - description: Selector specifying which fields to include in a partial response.
        in: query
        name: fields
        schema:
          type: string
      - description: 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.
        in: query
        name: key
        schema:
          type: string
      - description: OAuth 2.0 token for the current user.
        in: query
        name: oauth_token
        schema:
          type: string
      - description: Returns response with indentations and line breaks.
        in: query
        name: prettyPrint
        schema:
          type: boolean
      - description: 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.
        in: query
        name: quotaUser
        schema:
          type: string
      - description: Upload protocol for media (e.g. "raw", "multipart").
        in: query
        name: upload_protocol
        schema:
          type: string
      - description: Legacy upload protocol for media (e.g. "media", "multipart").
        in: query
        name: uploadType
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeList'
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SuccessExample
  /changes/startPageToken:
    get:
      tags:
      - Changes
      summary: Google Get Changes Startpagetoken
      description: Gets the starting pageToken for listing future changes.
      operationId: googleDriveChangesGetstartpagetoken
      security:
      - Oauth2:
        - https://www.googleapis.com/auth/drive
        Oauth2c:
        - https://www.googleapis.com/auth/drive
      - Oauth2:
        - https://www.googleapis.com/auth/drive.appdata
        Oauth2c:
        - https://www.googleapis.com/auth/drive.appdata
      - Oauth2:
        - https://www.googleapis.com/auth/drive.file
        Oauth2c:
        - https://www.googleapis.com/auth/drive.file
      - Oauth2:
        - https://www.googleapis.com/auth/drive.metadata
        Oauth2c:
        - https://www.googleapis.com/auth/drive.metadata
      - Oauth2:
        - https://www.googleapis.com/auth/drive.metadata.readonly
        Oauth2c:
        - https://www.googleapis.com/auth/drive.metadata.readonly
      - Oauth2:
        - https://www.googleapis.com/auth/drive.photos.readonly
        Oauth2c:
        - https://www.googleapis.com/auth/drive.photos.readonly
      - Oauth2:
        - https://www.googleapis.com/auth/drive.readonly
        Oauth2c:
        - https://www.googleapis.com/auth/drive.readonly
      parameters:
      - description: The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.
        in: query
        name: driveId
        schema:
          type: string
      - description: Whether the requesting application supports both My Drives and shared drives.
        in: query
        name: supportsAllDrives
        schema:
          type: boolean
      - description: 'Deprecated: Use `supportsAllDrives` instead.'
        in: query
        name: supportsTeamDrives
        schema:
          type: boolean
      - description: 'Deprecated: Use `driveId` instead.'
        in: query
        name: teamDriveId
        schema:
          type: string
      - in: header
        name: Authorization
        schema:
          type: string
      - description: V1 error format.
        in: query
        name: $.xgafv
        schema:
          enum:
          - '1'
          - '2'
          type: string
      - description: OAuth access token.
        in: query
        name: access_token
        schema:
          type: string
      - description: Data format for response.
        in: query
        name: alt
        schema:
          enum:
          - json
          - media
          - proto
          type: string
      - description: JSONP
        in: query
        name: callback
        schema:
          type: string
      - description: Selector specifying which fields to include in a partial response.
        in: query
        name: fields
        schema:
          type: string
      - description: 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.
        in: query
        name: key
        schema:
          type: string
      - description: OAuth 2.0 token for the current user.
        in: query
        name: oauth_token
        schema:
          type: string
      - description: Returns response with indentations and line breaks.
        in: query
        name: prettyPrint
        schema:
          type: boolean
      - description: 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.
        in: query
        name: quotaUser
        schema:
          type: string
      - description: Upload protocol for media (e.g. "raw", "multipart").
        in: query
        name: upload_protocol
        schema:
          type: string
      - description: Legacy upload protocol for media (e.g. "media", "multipart").
        in: query
        name: uploadType
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartPageToken'
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SuccessExample
  /changes/watch:
    post:
      tags:
      - Changes
      summary: Google Post Changes Watch
      description: Subscribes to changes for a user.
      operationId: googleDriveChangesWatch
      security:
      - Oauth2:
        - https://www.googleapis.com/auth/drive
        Oauth2c:
        - https://www.googleapis.com/auth/drive
      - Oauth2:
        - https://www.googleapis.com/auth/drive.appdata
        Oauth2c:
        - https://www.googleapis.com/auth/drive.appdata
      - Oauth2:
        - https://www.googleapis.com/auth/drive.file
        Oauth2c:
        - https://www.googleapis.com/auth/drive.file
      - Oauth2:
        - https://www.googleapis.com/auth/drive.metadata
        Oauth2c:
        - https://www.googleapis.com/auth/drive.metadata
      - Oauth2:
        - https://www.googleapis.com/auth/drive.metadata.readonly
        Oauth2c:
        - https://www.googleapis.com/auth/drive.metadata.readonly
      - Oauth2:
        - https://www.googleapis.com/auth/drive.photos.readonly
        Oauth2c:
        - https://www.googleapis.com/auth/drive.photos.readonly
      - Oauth2:
        - https://www.googleapis.com/auth/drive.readonly
        Oauth2c:
        - https://www.googleapis.com/auth/drive.readonly
      parameters:
      - description: 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.
        in: query
        name: pageToken
        required: true
        schema:
          type: string
      - description: 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.
        in: query
        name: driveId
        schema:
          type: string
      - description: 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.
        in: query
        name: includeCorpusRemovals
        schema:
          type: boolean
      - description: Whether both My Drive and shared drive items should be included in results.
        in: query
        name: includeItemsFromAllDrives
        schema:
          type: boolean
      - description: A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
        in: query
        name: includeLabels
        schema:
          type: string
      - description: Specifies which additional view's permissions to include in the response. Only 'published' is supported.
        in: query
        name: includePermissionsForView
        schema:
          type: string
      - description: Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
        in: query
        name: includeRemoved
        schema:
          type: boolean
      - description: 'Deprecated: Use `includeItemsFromAllDrives` instead.'
        in: query
        name: includeTeamDriveItems
        schema:
          type: boolean
      - description: The maximum number of changes to return per page.
        in: query
        name: pageSize
        schema:
          maximum: 1000
          minimum: 1
          type: integer
      - description: 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.
        in: query
        name: restrictToMyDrive
        schema:
          type: boolean
      - description: A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.
        in: query
        name: spaces
        schema:
          type: string
      - description: Whether the requesting application supports both My Drives and shared drives.
        in: query
        name: supportsAllDrives
        schema:
          type: boolean
      - description: 'Deprecated: Use `supportsAllDrives` instead.'
        in: query
        name: supportsTeamDrives
        schema:
          type: boolean
      - description: 'Deprecated: Use `driveId` instead.'
        in: query
        name: teamDriveId
        schema:
          type: string
      - in: header
        name: Authorization
        schema:
          type: string
      - description: V1 error format.
        in: query
        name: $.xgafv
        schema:
          enum:
          - '1'
          - '2'
          type: string
      - description: OAuth access token.
        in: query
        name: access_token
        schema:
          type: string
      - description: Data format for response.
        in: query
        name: alt
        schema:
          enum:
          - json
          - media
          - proto
          type: string
      - description: JSONP
        in: query
        name: callback
        schema:
          type: string
      - description: Selector specifying which fields to include in a partial response.
        in: query
        name: fields
        schema:
          type: string
      - description: 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.
        in: query
        name: key
        schema:
          type: string
      - description: OAuth 2.0 token for the current user.
        in: query
        name: oauth_token
        schema:
          type: string
      - description: Returns response with indentations and line breaks.
        in: query
        name: prettyPrint
        schema:
          type: boolean
      - description: 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.
        in: query
        name: quotaUser
        schema:
          type: string
      - description: Upload protocol for media (e.g. "raw", "multipart").
        in: query
        name: upload_protocol
        schema:
          type: string
      - description: Legacy upload protocol for media (e.g. "media", "multipart").
        in: query
        name: uploadType
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Channel'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SuccessExample
components:
  schemas:
    LabelField:
      description: Representation of field, which is a typed key-value pair.
      properties:
        dateString:
          description: 'Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.'
          items:
            format: date
            type: string
          type: array
        id:
          description: The identifier of this label field.
          type: string
        integer:
          description: Only present if `valueType` is `integer`.
          items:
            format: int64
            type: string
          type: array
        kind:
          description: This is always drive#labelField.
          type: string
        selection:
          description: Only present if `valueType` is `selection`
          items:
            type: string
          type: array
        text:
          description: Only present if `valueType` is `text`.
          items:
            type: string
          type: array
        user:
          description: Only present if `valueType` is `user`.
          items:
            $ref: '#/components/schemas/User'
          type: array
        valueType:
          description: 'The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`'
          type: string
      type: object
    User:
      description: Information about a Drive user.
      properties:
        displayName:
          description: Output only. A plain text displayable name for this user.
          type: string
        emailAddress:
          description: Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
          type: string
        kind:
          default: drive#user
          description: 'Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.'
          type: string
        me:
          description: Output only. Whether this user is the requesting user.
          type: boolean
        permissionId:
          description: Output only. The user's ID as visible in Permission resources.
          type: string
        photoLink:
          description: Output only. A link to the user's profile photo, if available.
          type: string
      type: object
    ContentRestriction:
      description: A restriction for accessing the content of the file.
      properties:
        ownerRestricted:
          description: Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
          type: boolean
        readOnly:
          description: Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
          type: boolean
        reason:
          description: Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
          type: string
        restrictingUser:
          $ref: '#/components/schemas/User'
          description: Output only. The user who set the content restriction. Only populated if `readOnly` is true.
        restrictionTime:
          description: The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
          format: date-time
          type: string
        systemRestricted:
          description: Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
          type: boolean
        type:
          description: Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
          type: string
      type: object
    Channel:
      description: A notification channel used to watch for resource changes.
      properties:
        address:
          description: The address where notifications are delivered for this channel.
          type: string
        expiration:
          description: Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
          format: int64
          type: string
        id:
          description: A UUID or similar unique string that identifies this channel.
          type: string
        kind:
          default: api#channel
          description: Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
          type: string
        params:
          additionalProperties:
            type: string
          description: Additional parameters controlling delivery channel behavior. Optional.
          type: object
        payload:
          description: A Boolean value to indicate whether payload is wanted. Optional.
          type: boolean
        resourceId:
          description: An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
          type: string
        resourceUri:
          description: A version-specific identifier for the watched resource.
          type: string
        token:
          description: An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
          type: string
        type:
          description: The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".
          type: string
      type: object
    StartPageToken:
      properties:
        kind:
          default: drive#startPageToken
          description: 'Identifies what kind of resource this is. Value: the fixed string `"drive#startPageToken"`.'
          type: string
        startPageToken:
          description: The starting page token for listing future changes. The page token doesn't expire.
          type: string
      type: object
    File:
      description: The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.
      properties:
        appProperties:
          additionalProperties:
            type: string
          description: 'A collection of arbitrary key-value pairs which are private to the requesting app.

            Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.'
          type: object
        capabilities:
          description: Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
          properties:
            canAcceptOwnership:
              description: Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
              type: boolean
            canAddChildren:
              description: Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.
              type: boolean
            canAddFolderFromAnotherDrive:
              description: Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
              type: boolean
            canAddMyDriveParent:
              description: Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
              type: boolean
            canChangeCopyRequiresWriterPermission:
              description: Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
              type: boolean
            canChangeSecurityUpdateEnabled:
              description: Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
              type: boolean
            canChangeViewersCanCopyContent:
              deprecated: true
              description: 'Deprecated: Output only.'
              type: boolean
            canComment:
              description: Output only. Whether the current user can comment on this file.
              type: boolean
            canCopy:
              description: Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
              type: boolean
            canDelete:
              description: Output only. Whether the current user can delete this file.
              type: boolean
            canDeleteChildren:
              description: Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
              type: boolean
            canDownload:
              description: Output only. Whether the current user can download this file.
              type: boolean
            canEdit:
              description: Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
              type: boolean
            canListChildren:
              description: Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.
              type: boolean
            canModifyContent:
              description: Output only. Whether the current user can modify the content of this file.
              type: boolean
            canModifyContentRestriction:
              deprecated: true
              description: 'Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.'
              type: boolean
            canModifyEditorContentRestriction:
              description: Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
              type: boolean
            canModifyLabels:
              description: Output only. Whether the current user can modify the labels on the file.
              type: boolean
            canModifyOwnerContentRestriction:
              description: Output only. Whether the current user can add or modify content restrictions which are owner restricted.
              type: boolean
            canMoveChildrenOutOfDrive:
              description: Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
              type: boolean
            canMoveChildrenOutOfTeamDrive:
              deprecated: true
              description: 'Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.'
              type: boolean
            canMoveChildrenWithinDrive:
              description: Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
              type: boolean
            canMoveChildrenWithinTeamDrive:
              deprecated: true
              description: 'Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.'
              type: boolean
            canMoveItemIntoTeamDrive:
              deprecated: true
              description: 'Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.'
              type: boolean
            canMoveItemOutOfDrive:
              description: Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
              type: boolean
            canMoveItemOutOfTeamDrive:
              deprecated: true
              description: 'Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.'
              type: boolean
            canMoveItemWithinDrive:
              description: Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
              type: boolean
            canMoveItemWithinTeamDrive:
              deprecated: true
              description: 'Deprecated: Output only. Use `canMoveItemWithinDrive` instead.'
              type: boolean
            canMoveTeamDriveItem:
              deprecated: true
              description: 'Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.'
              type: boolean
            canReadDrive:
              description: Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
              type: boolean
            canReadLabels:
              description: Output only. Whether the current user can read the labels on the file.
              type: boolean
            canReadRevisions:
              description: Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
              type: boolean
            canReadTeamDrive:
         

# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/google/refs/heads/main/openapi/google-changes-api-openapi.yml