Google Changes API

openapi: 3.1.0
info:
  title: Google Books About Changes API
  description: API for retrieving Bookshelf and Volume resources from Google Books
  version: 1.0.0
  contact:
    name: Google Books API
    url: https://developers.google.com/books
servers:
- url: https://www.googleapis.com/books/v1
  description: Google Books API v1
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:
    ChangeList:
      description: A list of changes for a user.
      properties:
        changes:
          description: The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
          items:
            $ref: '#/components/schemas/Change'
          type: array
        kind:
          default: drive#changeList
          description: 'Identifies what kind of resource this is. Value: the fixed string `"drive#changeList"`.'
          type: string
        newStartPageToken:
          description: The starting page token for future changes. This will be present only if the end of the current changes list has been reached. The page token doesn't expire.
          type: string
        nextPageToken:
          description: The page token for the next page of changes. This will be absent if the end of the changes list has been reached. The page token doesn't expire.
          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
    TeamDrive:
      description: 'Deprecated: use the drive collection instead.'
      properties:
        backgroundImageFile:
          description: An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
          properties:
            id:
              description: The ID of an image file in Drive to use for the background image.
              type: string
            width:
              description: The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
              format: float
              type: number
            xCoordinate:
              description: The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
              format: float
              type: number
            yCoordinate:
              description: The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
              format: float
              type: number
          type: object
        backgroundImageLink:
          description: A short-lived link to this Team Drive's background image.
          type: string
        capabilities:
          description: Capabilities the current user has on this Team Drive.
          properties:
            canAddChildren:
              description: Whether the current user can add children to folders in this Team Drive.
              type: boolean
            canChangeCopyRequiresWriterPermissionRestriction:
              description: Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
              type: boolean
            canChangeDomainUsersOnlyRestriction:
              description: Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
              type: boolean
            canChangeSharingFoldersRequiresOrganizerPermissionRestriction:
              description: Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
              type: boolean
            canChangeTeamDriveBackground:
              description: Whether the current user can change the background of this Team Drive.
              type: boolean
            canChangeTeamMembersOnlyRestriction:
              description: Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
              type: boolean
            canComment:
              description: Whether the current user can comment on files in this Team Drive.
              type: boolean
            canCopy:
              description: Whether the current user can copy files in this Team Drive.
              type: boolean
            canDeleteChildren:
              description: Whether the current user can delete children from folders in this Team Drive.
              type: boolean
            canDeleteTeamDrive:
              description: Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.
              type: boolean
            canDownload:
              description: Whether the current user can download files in this Team Drive.
              type: boolean
            canEdit:
              description: Whether the current user can edit files in this Team Drive
              type: boolean
            canListChildren:
              description: Whether the current user can list the children of folders in this Team Drive.
              type: boolean
            canManageMembers:
              description: Whether the current user can add members to this Team Drive or remove them or change their role.
              type: boolean
            canReadRevisions:
              description: Whether the current user can read the revisions resource of files in this Team Drive.
              type: boolean
            canRemoveChildren:
              deprecated: true
              description: 'Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.'
              type: boolean
            canRename:
              description: Whether the current user can rename files or folders in this Team Drive.
              type: boolean
            canRenameTeamDrive:
              description: Whether the current user can rename this Team Drive.
              type: boolean
            canResetTeamDriveRestrictions:
              description: Whether the current user can reset the Team Drive restrictions to defaults.
              type: boolean
            canShare:
              description: Whether the current user can share files or folders in this Team Drive.
              type: boolean
            canTrashChildren:
              description: Whether the current user can trash children from folders in this Team Drive.
              type: boolean
          type: object
        colorRgb:
          description: The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.
          type: string
        createdTime:
          description: The time at which the Team Drive was created (RFC 3339 date-time).
          format: date-time
          type: string
        id:
          description: The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
          type: string
        kind:
          default: drive#teamDrive
          description: 'Identifies what kind of resource this is. Value: the fixed string `"drive#teamDrive"`.'
          type: string
        name:
          description: The name of this Team Drive.
          type: string
        orgUnitId:
          description: The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
          type: string
        restrictions:
          description: A set of restrictions that apply to this Team Drive or items inside this Team Drive.
          properties:
            adminManagedRestrictions:
              description: Whether administrative privileges on this Team Drive are required to modify restrictions.
              type: boolean
            copyRequiresWriterPermission:
              description: Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this Team Drive.
              type: boolean
            domainUsersOnly:
              description: Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.
              type: boolean
            sharingFoldersRequiresOrganizerPermission:
              description: If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
              type: boolean
            teamMembersOnly:
              description: Whether access to items inside this Team Drive is restricted to members of this Team Drive.
              type: boolean
          type: object
        themeId:
          description: The ID of the theme from which the background image and color will be set. The set of possible `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
          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
    Drive:
      description: Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.
      properties:
        backgroundImageFile:
          description: An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
          properties:
            id:
              description: The ID of an image file in Google Drive to use for the background image.
              type: string
            width:
              description: The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
              format: float
              type: number
            xCoordinate:
              description: The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
              format: float
              type: number
            yCoordinate:
              description: The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
              format: float
              type: number
          type: object
        backgroundImageLink:
          description: Output only. A short-live

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